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

Please provide better documentation for from lancedb.embeddings #128

Closed
leozc opened this issue Jun 2, 2023 · 2 comments
Closed

Please provide better documentation for from lancedb.embeddings #128

leozc opened this issue Jun 2, 2023 · 2 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@leozc
Copy link

leozc commented Jun 2, 2023

The helper function with_embeddings is a very important function. However, the usage is under-documented, could you please help to add documentation of its usage, particularly the function signature of func?

Another recommendation, we may want sensible default parameters.

  1. wrap_api=False - by default, it is true, where making the local embedding encoder throttled.
  2. Can we make it clear if the function modifies the data in place or provides a copy?
@eddyxu eddyxu added documentation Improvements or additions to documentation enhancement New feature or request labels Jun 4, 2023
@prrao87
Copy link
Contributor

prrao87 commented Dec 31, 2023

Revisiting this important function: it needs to have a better docstring (with examples) to show up in the API documentation.
@changhiskhan @AyushExel

@AyushExel
Copy link
Contributor

@changhiskhan 's last embedding function PR should have addressed most of this? Closing. Please re-open if something needs more clarity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

4 participants