Use existing model instance in SentenceTransformerEmbeddingFunction

[matiboux]

Description of changes

Summarize the changes made by this PR.

• Improvements & Bug fixes
• New functionality
  • Add model argument to SentenceTransformerEmbeddingFunction: Initialize instance with existing loaded model.
  • Useful for modifying a model parameter or its structure before usage.

Test plan

How are these changes tested?

• Tests pass locally with pytest for python, yarn test for js, cargo test for rust
• Updated class has been tested in a private project as a drop-in replacement.
  • Swapped the Chroma import for a local import.
  • Standard usage of the class in a Chroma collection.

Documentation Changes

Are all docstrings for user-facing APIs updated if required? Do we need to make documentation changes in the docs repository?

• Yes, docstrings for user-facing APIs has been updated.
  • One argument has been added, a docstring has been added for it.
• Yes, the documentation could be changed to describe this new usage.
  • Relevant documentation page: docs.trychroma.com/guides/embeddings#sentence-transformers

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
chroma	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	May 22, 2024 3:42pm

[github-actions]

Reviewer Checklist

Please leverage this checklist to ensure your code review is thorough before approving

Testing, Bugs, Errors, Logs, Documentation

• Can you think of any use case in which the code does not behave as intended? Have they been tested?
• Can you think of any inputs or external events that could break the code? Is user input validated and safe? Have they been tested?
• If appropriate, are there adequate property based tests?
• If appropriate, are there adequate unit tests?
• Should any logging, debugging, tracing information be added or removed?
• Are error messages user-friendly?
• Have all documentation changes needed been made?
• Have all non-obvious changes been commented?

System Compatibility

• Are there any potential impacts on other parts of the system or backward compatibility?
• Does this change intersect with any items on our roadmap, and if so, is there a plan for fitting them together?

Quality

• Is this code of a unexpectedly high quality (Readability, Modularity, Intuitiveness)

[jeffchuber]

Our underlying impl has changed and so this PR is not landable as is.

That being said - we'd still like to add this functionality and that is now tracked in this issue.