Move CONTRIBUTING.md + Add Test for Adding New Models #154
Conversation
This file contains 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
KShivendu
reviewed
Mar 18, 2024
| 1. Open Requests for New Models are [here](https://github.com/qdrant/fastembed/labels/model%20request). | ||
| 2. There are quite a few pull requests that were merged for this purpose and you can use them as a reference. Here is an example: https://github.com/qdrant/fastembed/pull/129 | ||
| 3. Make sure to add tests for the new model | ||
| - The CANONICAL_VECTOR values must come from a reference implementation usually from Huggingface Transformers or Sentence Transformers |
There was a problem hiding this comment.
Please describe what's canonical vector.
Do you mean one has to convert these two
input_texts = [
"hello world", "flag embedding"
]
Using HF Inference API for the model?
There was a problem hiding this comment.
Reference PRs are linked before that sentence
|
Ohh wait we already have a test for this. Is there any blocker from running it in CI? |
Co-authored-by: Kumar Shivendu <[email protected]>
|
@KShivendu that test also depends on the CANONICAL_VECTOR_VALUES — that's the ground truth, and contributors mistake test for the implementation Hence, that needs to be outside of this repository ideally — and I don't want to clutter this repository and make the tests slower than they already are |
KShivendu
approved these changes
Mar 18, 2024
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.