-
Notifications
You must be signed in to change notification settings - Fork 2k
[DOC] Update custom EF code sample #5940
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
base: main
Are you sure you want to change the base?
Conversation
Reviewer ChecklistPlease leverage this checklist to ensure your code review is thorough before approving Testing, Bugs, Errors, Logs, Documentation
System Compatibility
Quality
|
|
Update custom embedding function documentation examples Refreshes the custom embedding function examples to reflect current registration and persistence requirements. Adds richer Python and TypeScript snippets that demonstrate naming, configuration serialization, and rebuild hooks alongside the Key Changes• Expanded the Python example Affected Areas• docs/docs.trychroma.com/markdoc/content/docs/embeddings/embedding-functions.md This summary was automatically generated by @propel-code-bot |
docs/docs.trychroma.com/markdoc/content/docs/embeddings/embedding-functions.md
Show resolved
Hide resolved
docs/docs.trychroma.com/markdoc/content/docs/embeddings/embedding-functions.md
Show resolved
Hide resolved
docs/docs.trychroma.com/markdoc/content/docs/embeddings/embedding-functions.md
Show resolved
Hide resolved
docs/docs.trychroma.com/markdoc/content/docs/embeddings/embedding-functions.md
Show resolved
Hide resolved
You need to register the EF, and if you don't define the extra functions it's considered a legacy EF.
867e487 to
17bf9c6
Compare
docs/docs.trychroma.com/markdoc/content/docs/embeddings/embedding-functions.md
Show resolved
Hide resolved
docs/docs.trychroma.com/markdoc/content/docs/embeddings/embedding-functions.md
Outdated
Show resolved
Hide resolved
docs/docs.trychroma.com/markdoc/content/docs/embeddings/embedding-functions.md
Outdated
Show resolved
Hide resolved
| | [Together AI](../../integrations/embedding-models/together-ai) | ✓ | ✓ | | ||
|
|
||
|
|
||
| For TypeScript users, Chroma provides packages for a number of embedding model providers. The Chromadb python package ships will all embedding functions included. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
docs/docs.trychroma.com/markdoc/content/docs/embeddings/embedding-functions.md
Show resolved
Hide resolved
…ing-functions.md Co-authored-by: propel-code-bot[bot] <203372662+propel-code-bot[bot]@users.noreply.github.com>

This updates the sample code to show how to use custom EFs correctly. The old snippets would result in legacy EFs.
You need to register the EF, and if you don't define the extra functions it's considered a legacy EF.