Ayush Chaurasia
b9afd9c860
docs: add late interaction, multi-vector guide & link example ( #2231 )
...
1/2 docs update for this week. Addesses issues from this docs epic -
https://github.com/lancedb/lancedb/issues/1476
2025-03-20 20:29:32 +05:30
Ayush Chaurasia
ae1548b507
docs: add cloud & enterprise cta ( #2235 )
...
2/2 docs update this week
- Add cloud & enterprise CTA
- remove outdated projects/examples from landing page
2025-03-19 10:55:05 -07:00
ayao227
dfe4ba8dad
chore: add reo integration ( #2149 )
...
This PR adds reo integration to the lancedb documentation website.
2025-02-28 07:51:34 -08:00
Will Jones
7ac5f74c80
feat!: add variable store to embeddings registry ( #2112 )
...
BREAKING CHANGE: embedding function implementations in Node need to now
call `resolveVariables()` in their constructors and should **not**
implement `toJSON()`.
This tries to address the handling of secrets. In Node, they are
currently lost. In Python, they are currently leaked into the table
schema metadata.
This PR introduces an in-memory variable store on the function registry.
It also allows embedding function definitions to label certain config
values as "sensitive", and the preprocessing logic will raise an error
if users try to pass in hard-coded values.
Closes #2110
Closes #521
---------
Co-authored-by: Weston Pace <weston.pace@gmail.com >
2025-02-24 15:52:19 -08:00
Lei Xu
6fa1f37506
docs: improve pydantic integration docs ( #2136 )
...
Address usage mistakes in
https://github.com/lancedb/lancedb/issues/2135 .
* Add example of how to use `LanceModel` and `Vector` decorator
* Add test for pydantic doc
* Fix the example to directly use LanceModel instead of calling
`MyModel.to_arrow_schema()` in the example.
* Add cross-reference link to pydantic doc site
* Configure mkdocs to watch code changes in python directory.
2025-02-21 12:48:37 -08:00
QianZhu
17c9e9afea
docs: add async examples to doc ( #1941 )
...
- added sync and async tabs for python examples
- moved python code to tests/docs
---------
Co-authored-by: Will Jones <willjones127@gmail.com >
2025-01-07 15:10:25 -08:00
Will Jones
61a714a459
docs: improve optimization docs ( #1957 )
...
* Add `See Also` section to `cleanup_old_files` and `compact_files` so
they know it's linked to `optimize`.
* Fixes link to `compact_files` arguments
* Improves formatting of note.
2024-12-19 10:55:11 -08:00
QianZhu
17e4022045
docs: add faq to cloud doc ( #1907 )
...
Co-authored-by: Will Jones <willjones127@gmail.com >
2024-12-12 10:07:03 -08:00
Will Jones
69d9beebc7
docs: improve style and introduction to Python API docs ( #1885 )
...
I found the signatures difficult to read and the parameter section not
very space efficient.
2024-11-26 09:17:35 -08:00
Frank Liu
5387c0e243
docs: add Voyage models to sidebar ( #1858 )
2024-11-20 14:20:14 -08:00
Will Jones
a324f4ad7a
feat(node): enable logging and show full errors ( #1775 )
...
This exposes the `LANCEDB_LOG` environment variable in node, so that
users can now turn on logging.
In addition, fixes a bug where only the top-level error from Rust was
being shown. This PR makes sure the full error chain is included in the
error message. In the future, will improve this so the error chain is
set on the [cause](https://nodejs.org/api/errors.html#errorcause )
property of JS errors https://github.com/lancedb/lancedb/issues/1779
Fixes #1774
2024-10-29 15:13:34 -07:00
BubbleCal
32fdcf97db
feat!: upgrade lance to 0.19.1 ( #1762 )
...
BREAKING CHANGE: default tokenizer no longer does stemming or stop-word
removal. Users should explicitly turn that option on in the future.
- upgrade lance to 0.19.1
- update the FTS docs
- update the FTS API
Upstream change notes:
https://github.com/lancedb/lance/releases/tag/v0.19.1
---------
Signed-off-by: BubbleCal <bubble-cal@outlook.com >
Co-authored-by: Will Jones <willjones127@gmail.com >
2024-10-29 09:03:52 -07:00
Dominik Weckmüller
e7b56b7b2a
docs: add permanent link chain icon to headings without impacting SEO ( #1746 )
...
I noted that there are no permanent links in the docs. Adapted the
current best solution from
https://github.com/squidfunk/mkdocs-material/discussions/3535 . It adds a
GitHub-like chain icon to the left of each heading (right on mobile) and
does not impact SEO unlike the default solution with pilcrow char `¶`
that might show up on google search results.
<img alt="image"
src="https://user-images.githubusercontent.com/182589/153004627-6df3f8e9-c747-4f43-bd62-a8dabaa96c3f.gif ">
2024-10-14 11:58:23 -07:00
Prashant Dixit
e2ca8daee1
docs: saleforce's sfr rag ( #1717 )
...
This PR adds Salesforce's newly released SFR RAG
2024-10-02 21:15:24 +05:30
Rithik Kumar
11072b9edc
docs: phidata integration page ( #1678 )
...
Added new integration page for phidata :
2024-09-21 00:40:47 +05:30
Rithik Kumar
dcd5f51036
docs: add understand embeddings v1 ( #1643 )
...
Before getting started with **managing embeddings**. Let's **understand
embeddings** (LanceDB way)
2024-09-14 02:07:00 +05:30
Prashant Dixit
b3bf6386c3
docs: rag section in guide ( #1619 )
...
This PR adds the RAG section in the Guides. It includes all the RAGs
with code snippet and some advanced techniques which improves RAG.
2024-09-11 21:13:55 +05:30
Rithik Kumar
2bc7dca3ca
docs: add changes to Embeddings-> Available models-> overview page ( #1596 )
...
adding features and improvements to - Manage Embeddings page
Before:
After:
2024-09-05 22:19:08 +05:30
Ayush Chaurasia
51966a84f5
docs: add multi-vector reranking, answerdotai and studies section ( #1579 )
2024-08-31 04:09:14 +05:30
Ayush Chaurasia
bfe8fccfab
docs: add hnsw docs ( #1570 )
2024-08-29 15:16:27 +05:30
Rithik Kumar
6f6eb170a9
docs: revamp Python example: Overview page and remove redundant examples and notebooks ( #1574 )
...
before:
After:
---------
Co-authored-by: Ayush Chaurasia <ayush.chaurarsia@gmail.com >
2024-08-29 13:48:10 +05:30
Rithik Kumar
dd1c16bbaf
docs: fix links, convert backslash to forward slash in mkdocs.yml ( #1571 )
...
Co-authored-by: Ayush Chaurasia <ayush.chaurarsia@gmail.com >
2024-08-28 16:07:57 +05:30
Rithik Kumar
ae85008714
docs: revamp embedding models ( #1568 )
...
before:
After:
---------
Co-authored-by: Ayush Chaurasia <ayush.chaurarsia@gmail.com >
2024-08-27 17:14:35 +05:30
Rithik Kumar
632007d0e2
docs: add recommender system example ( #1561 )
...
before:
After:
---------
Co-authored-by: Ayush Chaurasia <ayush.chaurarsia@gmail.com >
2024-08-25 12:30:30 +05:30
rahuljo
6ad5553eca
docs: add dlt-lancedb integration page ( #1551 )
...
Co-authored-by: Akela Drissner-Schmid <32450038+akelad@users.noreply.github.com >
2024-08-22 15:18:49 +05:30
Rithik Kumar
758c82858f
docs: add AI agent example ( #1553 )
...
before:
After:
---------
Co-authored-by: Ayush Chaurasia <ayush.chaurarsia@gmail.com >
2024-08-22 00:54:05 +05:30
Rithik Kumar
0cbc9cd551
docs: add evaluation example ( #1552 )
...
before:
After:
---------
Co-authored-by: Ayush Chaurasia <ayush.chaurarsia@gmail.com >
2024-08-21 20:37:04 +05:30
Rithik Kumar
21014cab45
docs: add chatbot example and improve quality of other examples ( #1544 )
2024-08-17 12:35:33 +05:30
Lei Xu
5857cb4c6e
docs: add a section to describe scalar index ( #1495 )
2024-08-16 18:48:29 -07:00
Rithik Kumar
09ce6c5bb5
docs: add vector search example ( #1543 )
2024-08-16 21:30:45 +05:30
Rithik Kumar
a62f661d90
docs: revamp example docs ( #1512 )
...
Before:
After:
---------
Co-authored-by: Ayush Chaurasia <ayush.chaurarsia@gmail.com >
2024-08-07 03:56:59 +05:30
Ayush Chaurasia
513926960d
docs: add rrf docs and update reranking notebook with Jina reranker results ( #1474 )
...
- RRF reranker
- Jina Reranker results
---------
Co-authored-by: Weston Pace <weston.pace@gmail.com >
2024-07-25 22:29:46 +05:30
Cory Grinstead
69295548cc
docs: minor updates for js migration guides ( #1451 )
...
Co-authored-by: Will Jones <willjones127@gmail.com >
2024-07-22 10:26:49 -07:00
Cory Grinstead
7ae327242b
docs: update migration.md ( #1445 )
2024-07-15 18:20:23 -05:00
Ayush Chaurasia
bb2e624ff0
docs: add fine tuning section in retriever guide and minor fixes ( #1438 )
2024-07-11 17:34:29 +05:30
Joan Fontanals
cef24801f4
docs: add jina reranker to index ( #1427 )
...
PR to add JinaReranker documentation page to the rerankers index
2024-07-09 14:39:35 +05:30
Raghav Dixit
a5ff623443
docs: update lntegration docs & fixed links ( #1423 )
...
1. Updated langchain docs.
2. Minor update to llamaindex doc.
3. Added notebook examples and linked them correctly
2024-07-03 21:50:33 +05:30
Lei Xu
d6485f1215
docs: add openapi rest api page ( #1413 )
2024-06-27 21:32:34 -07:00
Raghav Dixit
96914a619b
docs: llama-index integration ( #1347 )
...
Updated api refrence and usage for llama index integration.
2024-06-09 23:52:18 +05:30
Ayush Chaurasia
76fc16c7a1
docs: add retriever guide, address minor onboarding feedbacks & enhancement ( #1326 )
...
- Tried to address some onboarding feedbacks listed in
https://github.com/lancedb/lancedb/issues/1224
- Improve visibility of pydantic integration and embedding API. (Based
on onboarding feedback - Many ways of ingesting data, defining schema
but not sure what to use in a specific use-case)
- Add a guide that takes users through testing and improving retriever
performance using built-in utilities like hybrid-search and reranking
- Add some benchmarks for the above
- Add missing cohere docs
---------
Co-authored-by: Weston Pace <weston.pace@gmail.com >
2024-06-08 06:25:31 +05:30
Raghav Dixit
0bd6ac945e
Documentation : Langchain doc bug fix ( #1301 )
...
nav bar update
2024-05-13 20:56:34 +05:30
Weston Pace
deb947ddbd
doc: fix typo, broken links ( #1218 )
2024-04-11 14:58:51 -07:00
Prashanth Rao
d155e82723
[docs] Fix broken links and clarify language in integrations docs ( #1209 )
...
This PR does the following:
- Fixes broken/outdated URLs
- Adds clarity to the way DuckDB/LanceDB integration works via Arrow
2024-04-11 15:32:08 +05:30
Ayush Chaurasia
44c03ebef3
docs : Update Reranking docs ( #1213 )
2024-04-11 15:20:00 +05:30
Lei Xu
7e5a54b76a
chore: add social link footer ( #1177 )
2024-04-05 16:34:50 -07:00
Weston Pace
e21b56293c
docs: add a reference to @lancedb/lance in the docs ( #1166 )
...
We aren't yet ready to switch over the examples since almost all JS
examples rely on embeddings and we haven't yet ported those over.
However, this makes it possible for those that are interested to start
using `@lancedb/lancedb`
2024-04-05 16:34:39 -07:00
Weston Pace
f97c7dad8c
docs: add the async python API to the docs ( #1156 )
2024-04-05 16:34:37 -07:00
Weston Pace
0fe0976a0e
docs: add links to rust SDK docs, remove references to rust SDK being unstable / experimental ( #1131 )
2024-04-05 16:33:05 -07:00
Ayush Chaurasia
538d0320f7
Docs: add meta tags ( #1006 )
2024-04-05 16:30:40 -07:00
Ayush Chaurasia
bc871169f0
docs: Add meta tag for image preview ( #988 )
...
I think this should work. Need to deploy it to be sure as it can be
tested locally. Can be tested here.
2 things about this solution:
* All pages have a same meta tag, i.e, lancedb banner
* If needed, we can automatically use the first image of each page and
generate meta tags using the ultralytics mkdocs plugin that we did for
this purpose - https://github.com/ultralytics/mkdocs
2024-04-05 16:30:40 -07:00
