chroma icon indicating copy to clipboard operation
chroma copied to clipboard

[ENH]: FastEmbed embedding function support

Open Anush008 opened this issue 4 months ago • 7 comments

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.

  • [x] 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.

Anush008 avatar Apr 09 '24 06:04 Anush008

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)

github-actions[bot] avatar Apr 09 '24 06:04 github-actions[bot]

@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.

tazarov avatar Apr 10 '24 06:04 tazarov

@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 avatar Apr 10 '24 06:04 Anush008

Associated docs PR: https://github.com/chroma-core/docs/pull/233.

Anush008 avatar Apr 10 '24 08:04 Anush008

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

Anush008 avatar May 06 '24 07:05 Anush008

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

vercel[bot] avatar May 13 '24 12:05 vercel[bot]