chroma icon indicating copy to clipboard operation
chroma copied to clipboard

[ENH] CloudflareWorkersAIEmbeddingFunction

Open mileszim opened this issue 8 months ago • 5 comments

Description of changes

Summarize the changes made by this PR.

  • Improvements & Bug fixes
    • Adds CloudflareWorkersAIEmbeddingFunction to embedding_functions.py, which lets you use Cloudflare Workers AI embedding models in Chroma

Test plan

How are these changes tested?

  • [ ] Tests pass locally with pytest for python, yarn test for js

Documentation Changes

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

mileszim avatar Oct 23 '23 04:10 mileszim

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 (Readbility, Modularity, Intuitiveness)

github-actions[bot] avatar Oct 23 '23 04:10 github-actions[bot]

Hey @mileszim this is marked as draft but is it ready to be reviewed + merged?

HammadB avatar Dec 04 '23 19:12 HammadB

Hey @mileszim this is marked as draft but is it ready to be reviewed + merged?

Probably? I haven't had time to run through the checklist. Lemme know if there is anything specific to address / scaffolding for tests or something I can bring that in. Otherwise its up to your discretion.

mileszim avatar Dec 05 '23 01:12 mileszim

@mileszim, I hope you don't mind if I do a little cleanup, testing + docs and JS EF in this PR

tazarov avatar Apr 05 '24 16:04 tazarov

There is a Cloudflare SDK for node, but given the simplicity of the API, it is overkill to include it in our depths. We can update the EF should the API change - we have the tests for it.

tazarov avatar Apr 07 '24 18:04 tazarov