Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(README): Add blog posts and update doc link #194

Merged
merged 3 commits into from
Jul 22, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 18 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,24 @@
<details>
<summary>Table of Contents</summary>

<!--toc:start-->

- [About The Project](#about-the-project)
- [Latest updates on our blog :fire:](#latest-updates-on-our-blog-fire)
- [Example](#example)
- [Features](#features)
- [Vision](#vision)
- [Features](#features)
- [In detail](#in-detail)
- [Getting Started](#getting-started)
- [Prerequisites](#prerequisites)
- [Installation](#installation)
- [Usage and concepts](#usage-and-concepts)
- [Roadmap](#roadmap)
- [Contributing](#contributing)
- [License](#license)
<!--toc:end-->
</details>
<!--toc:end-->

</details>

<a name="readme-top"></a>

Expand Down Expand Up @@ -48,7 +52,7 @@
<p align="center">
Blazing fast data pipelines for Retrieval Augmented Generation written in Rust
<br />
<a href="https://swiftide.rs"><strong>Explore the docs »</strong></a>
<a href="https://swiftide.rs"><strong>Read more on swiftide.rs »</strong></a>
<br />
<br />
<!-- <a href="https://github.com/bosun-ai/swiftide">View Demo</a> -->
Expand Down Expand Up @@ -83,6 +87,14 @@ We <3 feedback: project ideas, suggestions, and complaints are very welcome. Fee

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

## Latest updates on our blog :fire:

- [Building a code question answering pipeline](https://bosun.ai/posts/indexing-and-querying-code-with-swiftide/) (2024-07-13)
- [Release - Swiftide 0.6](https://bosun.ai/posts/swiftide-0-6/) (2024-07-12)
- [Release - Swiftide 0.5](https://bosun.ai/posts/swiftide-0-5/) (2024-07-1)

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

## Example

```rust
Expand All @@ -91,17 +103,16 @@ indexing::Pipeline::from_loader(FileLoader::new(".").with_extensions(&["rs"]))
redis_url,
"swiftide-examples",
)?)
.then(MetadataQACode::new(openai_client.clone()))
.then_chunk(ChunkCode::try_for_language_and_chunk_size(
"rust",
10..2048,
)?)
.then(MetadataQACode::new(openai_client.clone()))
.then_in_batch(10, Embed::new(openai_client.clone()))
.then_store_with(
Qdrant::try_from_url(qdrant_url)?
Qdrant::builder()
.batch_size(50)
.vector_size(1536)
.collection_name("swiftide-examples".to_string())
.build()?,
)
.run()
Expand Down