feat: support generating the groundtruth and evaluate on it #68
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]>
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR adds support for generating groundtruth data and evaluating retrieval methods on it, consolidating embedding models under a unified API and adding utility functions for type checking.
- Adds a
GroundTruthclass to generate evaluation datasets from retrieval results and measure performance metrics - Consolidates embedding models by unifying
BaseTextEmbeddingandBaseMultiModalEmbeddinginto a singleBaseEmbeddingclass - Adds utility functions for type checking iterables and extracting iterator types
Reviewed Changes
Copilot reviewed 10 out of 11 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| vechord/utils.py | Adds utility functions for type checking lists/iterables and extracting nested types |
| vechord/registry.py | Removes duplicate type checking functions, imports them from utils module |
| vechord/pipeline.py | Updates to use unified embedding API and adds transaction context management |
| vechord/model/web.py | Updates documentation to clarify optional steps parameter |
| vechord/groundtruth.py | New module implementing groundtruth generation and evaluation functionality |
| vechord/evaluate.py | Updates to support list-based truth IDs and InputType enum usage |
| vechord/embedding.py | Consolidates embedding classes into unified BaseEmbedding interface |
| tests/test_run.py | Adds tests for running pipelines with spacy embedding |
| tests/test_groundtruth.py | Adds tests for groundtruth generation and evaluation |
| tests/conftest.py | Fixes test fixture parameter handling |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
Signed-off-by: Keming <[email protected]>
Signed-off-by: Keming <[email protected]>
Signed-off-by: Keming <[email protected]>
Signed-off-by: Keming <[email protected]>
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.
It's hard to know the user's retrieval methods. Thus, it has to be passed as an argument.
It's the user's responsibility to guarantee that the source table has no updates. This is also due to the limitation of retrieval methods. It's much easier for users to work directly on their Table than to wrap a snapshot into their retrieval logic.