Skip to content

Commit

Permalink
docs(README): Readme improvements
Browse files Browse the repository at this point in the history
  • Loading branch information
timonv committed Jul 29, 2024
1 parent 1539393 commit ba07ab9
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ Fast, streaming indexing and query library for AI applications, written in Rust

<!-- [![Product Name Screen Shot][product-screenshot]](https://example.com) -->

Swiftide is a data indexing, processing and query library, tailored for Retrieval Augmented Generation (RAG). When building applications with large language models (LLM), these LLMs need access to external resources. Data needs to be transformed, enriched, split up, embedded, and persisted. It is build in Rust, using parallel, asynchronous streams and is blazingly fast.
Swiftide is a data indexing, processing and query library, tailored for Retrieval Augmented Generation (RAG). When building applications with large language models (LLM), these LLMs need access to external resources. Data needs to be transformed, enriched, split up, embedded, and persisted. Queries can then be augmented by retrieving the indexed data and generating an answer. It is build in Rust, using parallel, asynchronous streams and is blazingly fast.

With Swiftide, you can build your AI application from idea to production in a few lines of code.

Expand Down Expand Up @@ -136,7 +136,7 @@ Our goal is to create a fast, extendable platform for data indexing and querying
- Fast streaming indexing pipeline with async, parallel processing
- Experimental query pipeline
- Integrations with OpenAI, Groq, Redis, Qdrant, FastEmbed, and Treesitter
- A variety of loaders, transformers, and embedders and other common, generic tools
- A variety of loaders, transformers, semantic chunkers, embedders, and more
- Bring your own transformers by extending straightforward traits
- Splitting and merging pipelines
- Jinja-like templating for prompts
Expand Down Expand Up @@ -176,7 +176,7 @@ Other integrations will need to be installed accordingly.
cargo add swiftide
```

3. Enable the features of integrations you would like to have or use 'all' in your `Cargo.toml`
3. Enable the features of integrations you would like to use in your `Cargo.toml`
4. Write a pipeline (see our examples and documentation)

<p align="right">(<a href="#readme-top">back to top</a>)</p>
Expand Down

0 comments on commit ba07ab9

Please sign in to comment.