Conversation
Signed-off-by: Keming <kemingyang@tensorchord.ai>
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR introduces documentation updates and a comprehensive test suite to enhance the developer experience and ensure project correctness. Key changes include:
- Adding Sphinx-based documentation and markdown examples.
- Introducing several new tests for table operations and pipeline functionality.
- Updating workflows and dependency definitions to support new features.
Reviewed Changes
Copilot reviewed 29 out of 29 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| .github/workflows/pages.yml | New GitHub Pages workflow for documentation and examples triggers. |
| docs/source/conf.py | Sphinx configuration added for building project documentation. |
| tests/test_table.py | New tests added to validate document/chunk operations and pipeline. |
| design.md | Project design diagram added using Mermaid syntax. |
| docs/source/example.md | Examples documentation updated to include various code integrations. |
| docs/source/index.md | Updated project homepage documentation. |
| pyproject.toml | Documentation dependencies added along with general package updates. |
| .github/workflows/check.yml | CI workflow updated to include a Docker-start step for database tests. |
| docs/source/api.md | API documentation auto-generated with Sphinx directives. |
| vechord/init.py | all updated to export create_web_app functionality. |
| vechord/chunk.py | Added and refined docstrings for multiple chunkers. |
| README.md | README updated to reflect installation changes and new examples. |
| vechord/augment.py | Docstring improvements and consistency fixes in augmentation logic. |
| examples/contextual.py | Updated embedding usage from Spacy to Gemini and adjusted vector types. |
| examples/beir.py | Embedding type and usage changes to align with new GeminiDenseEmbedding. |
| examples/web.py | Shifted embedding implementation to GeminiDenseEmbedding. |
| examples/essay.py | Updated test example for document segmentation and evaluation. |
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Signed-off-by: Keming <kemingyang@tensorchord.ai>
Signed-off-by: Keming <kemingyang@tensorchord.ai>
Signed-off-by: Keming <kemingyang@tensorchord.ai>
Signed-off-by: Keming <kemingyang@tensorchord.ai>
Signed-off-by: Keming <kemingyang@tensorchord.ai>
Member
Author
|
GitHub pages requires to make this repo public. Will ignore in this PR. |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.