Skip to content
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

[ENH]: FastEmbed embedding function support #1986

Open
wants to merge 13 commits into
base: main
Choose a base branch
from

Conversation

Anush008
Copy link

@Anush008 Anush008 commented Apr 9, 2024

Description of changes

  • New functionality
    • Adds support for FastEmbed - A lightweight, CPU-first embeddings library, to be used as an embedding function within Chroma. You can find the list of all the supported models here.

Test plan

  • Unit test has been set up.

  • Tests pass locally with pytest for python.

Documentation Changes

  • Docstrings have been added.
  • D̶o̶c̶s̶ P̶R̶ i̶s̶ a̶t̶ h̶t̶t̶p̶s̶:̶//g̶i̶t̶h̶u̶b̶.c̶o̶m̶/c̶h̶r̶o̶m̶a̶-̶c̶o̶r̶e̶/d̶o̶c̶s̶/p̶u̶l̶l̶/2̶3̶3̶. Moved the docs to this repo, since the former is archived now.

Copy link

github-actions bot commented Apr 9, 2024

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)

@tazarov
Copy link
Contributor

tazarov commented Apr 10, 2024

@Anush008, thanks for this. It looks good. Can I ask you to add a Docs PR—https://github.com/chroma-core/docs/pulls? I can add that, too.

@Anush008
Copy link
Author

@Anush008, thanks for this. It looks good. Can I ask you to add a Docs PR—https://github.com/chroma-core/docs/pulls? I can add that, too.

Will do.

@Anush008
Copy link
Author

Associated docs PR: chroma-core/docs#233.

Copy link
Contributor

@tazarov tazarov left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One tiny nit about batch size and threads

chromadb/utils/embedding_functions.py Outdated Show resolved Hide resolved
@Anush008
Copy link
Author

Anush008 commented May 6, 2024

Hi @tazarov. Just bumping this PR, since there are a lot of them.

Copy link

vercel bot commented May 13, 2024

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 14, 2024 3:38pm

Copy link
Contributor

@tazarov tazarov left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@Anush008
Copy link
Author

Hello @tazarov. FYI, I've refactored the implementation into a separate file, as per the recent changes.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants