docs: update examples and docs to use the async interface #37
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Keming <[email protected]>
Signed-off-by: Keming <[email protected]>
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR updates the examples and documentation to use the async interface throughout the codebase while also updating the DenseVector dimensionality from 768 to 3072. It further adjusts dependency definitions (e.g. removing Pillow and adding uvicorn/uvloop) and converts several functions to async, ensuring consistency across service, registry, tests, examples, and documentation.
- Converted various functions to async, including service, reranker, registry, augment, and multiple examples.
- Updated DenseVector dimension from 768 to 3072 in examples, docs, and README.
- Adjusted dependency definitions in pyproject.toml and streamlined installation instructions.
Reviewed Changes
Copilot reviewed 18 out of 19 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| vechord/service.py | Adds default value for the pipeline parameter and sets URL path options. |
| vechord/rerank.py | Converts rerank and context methods to async and updates client instantiation. |
| vechord/registry.py | Changes type hints and refactors import/iterable checks to support async flows. |
| vechord/augment.py | Updates docstrings to include argument descriptions and async usage. |
| tests/test_service.py | Converts synchronous functions to async and uses AsyncIterator in tests. |
| pyproject.toml | Removes Pillow and adds new dependencies for web serving (uvicorn, uvloop). |
| examples/web.py | Updates DenseVector, registry creation, and server startup to use uvicorn. |
| examples/simple.py | Refactors to async context management and awaits async operations. |
| examples/hybrid.py | Converts all functions to async and updates DenseVector dimensions. |
| examples/graph.py | Converts data loading, search, and graph display functions to async. |
| examples/essay.py | Refactors functions to async and updates DenseVector accordingly. |
| examples/contextual.py | Converts functions to async including those for splitting and context augments. |
| examples/beir.py | Updates async operations for loading dataset and querying. |
| examples/anthropic.py | Converts data loading and search functions to async. |
| docs/source/utils.md | Updates installation command by removing the pillow dependency. |
| docs/source/index.md | Removes redundant Installation section. |
| docs/source/guide.md | Updates DenseVector dimension and converts code snippets to async style. |
| README.md | Updates DenseVector dimension and refactors code snippets to async style. |
Comments suppressed due to low confidence (2)
tests/test_service.py:24
- The function 'create_chunk' now returns an AsyncIterator rather than a list; ensure that downstream consumers correctly handle async iteration (for example, by iterating with 'async for') instead of expecting a list.
async def create_chunk(uid: UUID, text: str) -> AsyncIterator[DefaultChunk]:
README.md:153
- [nitpick] The README code snippet uses 'await' outside an async function context; consider wrapping it in an async function or adding a clarifying note so readers understand that it must be executed within an async context.
await vr.client.get_cursor().execute("SET vchordrq.probes = 100;")
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.