mirror of
https://github.com/lancedb/lancedb.git
synced 2025-12-27 07:09:57 +00:00
119b928a52
This PR makes incremental changes to the documentation. * Closes #697 * Closes #698 ## Chores - [x] Add dark mode - [x] Fix headers in navbar - [x] Add `extra.css` to customize navbar styles - [x] Customize fonts for prose/code blocks, navbar and admonitions - [x] Inspect all admonition boxes (remove redundant dropdowns) and improve clarity and readability - [x] Ensure that all images in the docs have white background (not transparent) to be viewable in dark mode - [x] Improve code formatting in code blocks to make them consistent with autoformatters (eslint/ruff) - [x] Add bolder weight to h1 headers - [x] Add diagram showing the difference between embedded (OSS) and serverless (Cloud) - [x] Fix [Creating an empty table](https://lancedb.github.io/lancedb/guides/tables/#creating-empty-table) section: right now, the subheaders are not clickable. - [x] In critical data ingestion methods like `table.add` (among others), the type signature often does not match the actual code - [x] Proof-read each documentation section and rewrite as necessary to provide more context, use cases, and explanations so it reads less like reference documentation. This is especially important for CRUD and search sections since those are so central to the user experience. ## Restructure/new content - [x] The section for [Adding data](https://lancedb.github.io/lancedb/guides/tables/#adding-to-a-table) only shows examples for pandas and iterables. We should include pydantic models, arrow tables, etc. - [x] Add conceptual tutorial for IVF-PQ index - [x] Clearly separate vector search, FTS and filtering sections so that these are easier to find - [x] Add docs on refine factor to explain its importance for recall. Closes #716 - [x] Add an FAQ page showing answers to commonly asked questions about LanceDB. Closes #746 - [x] Add simple polars example to the integrations section. Closes #756 and closes #153 - [ ] Add basic docs for the Rust API (more detailed API docs can come later). Closes #781 - [x] Add a section on the various storage options on local vs. cloud (S3, EBS, EFS, local disk, etc.) and the tradeoffs involved. Closes #782 - [x] Revamp filtering docs: add pre-filtering examples and redo headers and update content for SQL filters. Closes #783 and closes #784. - [x] Add docs for data management: compaction, cleaning up old versions and incremental indexing. Closes #785 - [ ] Add a benchmark section that also discusses some best practices. Closes #787 --------- Co-authored-by: Ayush Chaurasia <ayush.chaurarsia@gmail.com> Co-authored-by: Will Jones <willjones127@gmail.com>
200 lines
7.2 KiB
YAML
200 lines
7.2 KiB
YAML
site_name: LanceDB
|
|
site_url: https://lancedb.github.io/lancedb/
|
|
repo_url: https://github.com/lancedb/lancedb
|
|
edit_uri: https://github.com/lancedb/lancedb/tree/main/docs/src
|
|
repo_name: lancedb/lancedb
|
|
docs_dir: src
|
|
|
|
theme:
|
|
name: "material"
|
|
logo: assets/logo.png
|
|
favicon: assets/logo.png
|
|
palette:
|
|
# Palette toggle for light mode
|
|
- scheme: lancedb
|
|
primary: custom
|
|
toggle:
|
|
icon: material/weather-night
|
|
name: Switch to dark mode
|
|
# Palette toggle for dark mode
|
|
- scheme: slate
|
|
primary: custom
|
|
toggle:
|
|
icon: material/weather-sunny
|
|
name: Switch to light mode
|
|
features:
|
|
- content.code.copy
|
|
- content.tabs.link
|
|
- content.action.edit
|
|
- toc.follow
|
|
# - toc.integrate
|
|
- navigation.top
|
|
- navigation.tabs
|
|
- navigation.tabs.sticky
|
|
- navigation.footer
|
|
- navigation.tracking
|
|
- navigation.instant
|
|
icon:
|
|
repo: fontawesome/brands/github
|
|
custom_dir: overrides
|
|
|
|
plugins:
|
|
- search
|
|
- autorefs
|
|
- mkdocstrings:
|
|
handlers:
|
|
python:
|
|
paths: [../python]
|
|
options:
|
|
docstring_style: numpy
|
|
heading_level: 4
|
|
show_source: true
|
|
show_symbol_type_in_heading: true
|
|
show_signature_annotations: true
|
|
members_order: source
|
|
import:
|
|
# for cross references
|
|
- https://arrow.apache.org/docs/objects.inv
|
|
- https://pandas.pydata.org/docs/objects.inv
|
|
- mkdocs-jupyter
|
|
|
|
markdown_extensions:
|
|
- admonition
|
|
- footnotes
|
|
- pymdownx.details
|
|
- pymdownx.highlight:
|
|
anchor_linenums: true
|
|
line_spans: __span
|
|
pygments_lang_class: true
|
|
- pymdownx.inlinehilite
|
|
- pymdownx.snippets
|
|
- pymdownx.superfences
|
|
- pymdownx.tabbed:
|
|
alternate_style: true
|
|
- md_in_html
|
|
- attr_list
|
|
|
|
nav:
|
|
- Home:
|
|
- LanceDB: index.md
|
|
- 🏃🏼♂️ Quick start: basic.md
|
|
- 📚 Concepts:
|
|
- Vector search: concepts/vector_search.md
|
|
- Indexing: concepts/index_ivfpq.md
|
|
- Storage: concepts/storage.md
|
|
- Data management: concepts/data_management.md
|
|
- 🔨 Guides:
|
|
- Working with tables: guides/tables.md
|
|
- Building an ANN index: ann_indexes.md
|
|
- Vector Search: search.md
|
|
- Full-text search: fts.md
|
|
- Filtering: sql.md
|
|
- Versioning & Reproducibility: notebooks/reproducibility.ipynb
|
|
- 🧬 Managing embeddings:
|
|
- Overview: embeddings/index.md
|
|
- Explicit management: embeddings/embedding_explicit.md
|
|
- Implicit management: embeddings/embedding_functions.md
|
|
- Available Functions: embeddings/default_embedding_functions.md
|
|
- Custom Embedding Functions: embeddings/api.md
|
|
- "Example: Multi-lingual semantic search": notebooks/multi_lingual_example.ipynb
|
|
- "Example: MultiModal CLIP Embeddings": notebooks/DisappearingEmbeddingFunction.ipynb
|
|
- 🔌 Integrations:
|
|
- Tools and data formats: integrations/index.md
|
|
- Pandas and PyArrow: python/pandas_and_pyarrow.md
|
|
- Polars: python/polars_arrow.md
|
|
- DuckDB: python/duckdb.md
|
|
- LangChain 🔗: https://python.langchain.com/en/latest/modules/indexes/vectorstores/examples/lancedb.html
|
|
- LangChain JS/TS 🔗: https://js.langchain.com/docs/modules/data_connection/vectorstores/integrations/lancedb
|
|
- LlamaIndex 🦙: https://gpt-index.readthedocs.io/en/latest/examples/vector_stores/LanceDBIndexDemo.html
|
|
- Pydantic: python/pydantic.md
|
|
- Voxel51: integrations/voxel51.md
|
|
- PromptTools: integrations/prompttools.md
|
|
- 🎯 Examples:
|
|
- Overview: examples/index.md
|
|
- 🐍 Python:
|
|
- Overview: examples/examples_python.md
|
|
- YouTube Transcript Search: notebooks/youtube_transcript_search.ipynb
|
|
- Documentation QA Bot using LangChain: notebooks/code_qa_bot.ipynb
|
|
- Multimodal search using CLIP: notebooks/multimodal_search.ipynb
|
|
- Example - Calculate CLIP Embeddings with Roboflow Inference: examples/image_embeddings_roboflow.md
|
|
- Serverless QA Bot with S3 and Lambda: examples/serverless_lancedb_with_s3_and_lambda.md
|
|
- Serverless QA Bot with Modal: examples/serverless_qa_bot_with_modal_and_langchain.md
|
|
- 👾 JavaScript:
|
|
- Overview: examples/examples_js.md
|
|
- Serverless Website Chatbot: examples/serverless_website_chatbot.md
|
|
- YouTube Transcript Search: examples/youtube_transcript_bot_with_nodejs.md
|
|
- TransformersJS Embedding Search: examples/transformerjs_embedding_search_nodejs.md
|
|
- 🔧 CLI & Config: cli_config.md
|
|
- 💭 FAQs: faq.md
|
|
- ⚙️ API reference:
|
|
- 🐍 Python: python/python.md
|
|
- 👾 JavaScript: javascript/modules.md
|
|
- ☁️ LanceDB Cloud:
|
|
- Overview: cloud/index.md
|
|
- API reference:
|
|
- 🐍 Python: python/saas-python.md
|
|
- 👾 JavaScript: javascript/saas-modules.md
|
|
|
|
|
|
- Quick start: basic.md
|
|
- Concepts:
|
|
- Vector search: concepts/vector_search.md
|
|
- Indexing: concepts/index_ivfpq.md
|
|
- Storage: concepts/storage.md
|
|
- Data management: concepts/data_management.md
|
|
- Guides:
|
|
- Working with tables: guides/tables.md
|
|
- Building an ANN index: ann_indexes.md
|
|
- Vector Search: search.md
|
|
- Full-text search: fts.md
|
|
- Filtering: sql.md
|
|
- Versioning & Reproducibility: notebooks/reproducibility.ipynb
|
|
- Managing Embeddings:
|
|
- Overview: embeddings/index.md
|
|
- Explicit management: embeddings/embedding_explicit.md
|
|
- Implicit management: embeddings/embedding_functions.md
|
|
- Available Functions: embeddings/default_embedding_functions.md
|
|
- Custom Embedding Functions: embeddings/api.md
|
|
- "Example: Multi-lingual semantic search": notebooks/multi_lingual_example.ipynb
|
|
- "Example: MultiModal CLIP Embeddings": notebooks/DisappearingEmbeddingFunction.ipynb
|
|
- Integrations:
|
|
- Overview: integrations/index.md
|
|
- Pandas and PyArrow: python/pandas_and_pyarrow.md
|
|
- Polars: python/polars_arrow.md
|
|
- DuckDB : python/duckdb.md
|
|
- LangChain 🦜️🔗↗: https://python.langchain.com/en/latest/modules/indexes/vectorstores/examples/lancedb.html
|
|
- LangChain.js 🦜️🔗↗: https://js.langchain.com/docs/modules/data_connection/vectorstores/integrations/lancedb
|
|
- LlamaIndex 🦙↗: https://gpt-index.readthedocs.io/en/latest/examples/vector_stores/LanceDBIndexDemo.html
|
|
- Pydantic: python/pydantic.md
|
|
- Voxel51: integrations/voxel51.md
|
|
- PromptTools: integrations/prompttools.md
|
|
- Python examples:
|
|
- examples/index.md
|
|
- YouTube Transcript Search: notebooks/youtube_transcript_search.ipynb
|
|
- Documentation QA Bot using LangChain: notebooks/code_qa_bot.ipynb
|
|
- Multimodal search using CLIP: notebooks/multimodal_search.ipynb
|
|
- Serverless QA Bot with S3 and Lambda: examples/serverless_lancedb_with_s3_and_lambda.md
|
|
- Serverless QA Bot with Modal: examples/serverless_qa_bot_with_modal_and_langchain.md
|
|
- Javascript examples:
|
|
- Overview: examples/examples_js.md
|
|
- YouTube Transcript Search: examples/youtube_transcript_bot_with_nodejs.md
|
|
- Serverless Chatbot from any website: examples/serverless_website_chatbot.md
|
|
- TransformersJS Embedding Search: examples/transformerjs_embedding_search_nodejs.md
|
|
- API reference:
|
|
- Python: python/python.md
|
|
- Javascript: javascript/modules.md
|
|
- LanceDB Cloud:
|
|
- Overview: cloud/index.md
|
|
- API reference:
|
|
- 🐍 Python: python/saas-python.md
|
|
- 👾 JavaScript: javascript/saas-modules.md
|
|
|
|
extra_css:
|
|
- styles/global.css
|
|
- styles/extra.css
|
|
|
|
extra:
|
|
analytics:
|
|
provider: google
|
|
property: G-B7NFM40W74
|