website api doc rework #867
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
QianZhu
commented
Jan 26, 2024
•
QianZhu
commented
- combined oss and saas api docs
- marked parameters/apis if they are not supported on saas yet
Fix broken link to embedding functions testing: broken link was verified after local docs build to have been repaired --------- Co-authored-by: Chang She <chang@lancedb.com>
Allows creation of funnels and user journeys
Sets things up for this -> #579 - Just separates out the registry/ingestion code from the function implementation code - adds a `get_registry` util - package name "open-clip" -> "open-clip-torch"
To include latest v0.8.6 Co-authored-by: Chang She <chang@lancedb.com>
closes #564 --------- Co-authored-by: Chang She <chang@lancedb.com>
* Filename typo * Remove rick_morty csv as users won't really be able to use it.. We can create a an executable colab and download it from a bucket or smth.
This reverts commit c30faf6.
…tions (#593) Prior to this PR, to get a new version of a table, we need to re-open the table. This has a few downsides w.r.t. performance: * Object store is recreated, which takes time and throws away existing warm connections * Commit handler is thrown aways as well, which also may contain warm connections
Closes #594 The embedding functions are pydantic models so multiple instances with the same parameters are considered ==, which means that if you have multiple embedding columns it's possible for the embeddings to get overwritten. Instead we use `is` instead of == to avoid this problem. testing: modified unit test to include this case
expose `optimize_index` api.
expose index remap options in `compact_files`
@eddyxu added instructions for linting here: https://github.com/lancedb/lancedb/blob/7af213801a091cd5afb0f0814e184fc0b852de47/python/README.md?plain=1#L45-L50 However, we had a lot of failures and weren't checking this in CI. This PR fixes all lints and adds a check to CI to keep us in compliance with the lints.
* improve the docstring for NodeJS connect functions and `ConnectOptions` parameters. * Simplify `npm run build` steps.
…into tecmie-tecmie/embeddings-openai
Add test to ingest fp16 to a database
Rust API doc for the braves
Support to make Apache Arrow Table from an array of javascript Records, with optionally provided Schema.
Allow passing API key as env var:
```shell
export LANCEDB_API_KEY=sh_123...
```
with this set, apiKey argument can omitted from `connect`
```js
const db = await vectordb.connect({
uri: "db://test-proj-01-ae8343",
region: "us-east-1",
})
```
```py
db = lancedb.connect(
uri="db://test-proj-01-ae8343",
region="us-east-1",
)
```
#846) In NodeJS and Python, LanceDB establishes a connection to a db. In Rust core, it is called Database. We should be consistent with the naming.
Use Napi to write a Node.js SDK that follows Polars for better maintainability, while keeping most of the logic in Rust.
* Extract a minimal Table interface in Rust SDK * Make create_index composable in Rust. * Fix compiling issues from ffi
Created based on upstream PR lancedb/lance#1849 Closes #681 --------- Co-authored-by: Prashanth Rao <35005448+prrao87@users.noreply.github.com>
* Easy to type * Handle `String, &str, [String] and [&str]` well without manual conversion * Fix function name to be verb * Improve docstring of Rust. * Promote `query` and `search()` to public `Table` trait
docs/src/javascript.md
Outdated
| //connect to a local database | ||
| const db = await lancedb.connect('data/sample-lancedb'); | ||
| // connect to LanceDB Cloud | ||
| // const db = await lancedb.connect({ |
There was a problem hiding this comment.
- it looks weird having this in comments
- there's no context about LanceDB Cloud at all, or explaining what
your-project-slugmeans, etc.
| @@ -815,6 +817,7 @@ export class LocalTable<T = number[]> implements Table<T> { | |||
| /** | |||
| * Clean up old versions of the table, freeing disk space. | |||
| * | |||
| * Note: this API is not yet available on LanceDB Cloud | |||
There was a problem hiding this comment.
i think all of these repeated notes will make the docs look really messy. And chances are when we implement some of these in cloud we'll forget to update these.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.