mirror of
https://github.com/lancedb/lancedb.git
synced 2026-01-09 05:12:58 +00:00
cc507ca766
### Fix markdown table rendering issue This PR adds a missing whitespace before a markdown table in the documentation. This issue causes the table to not render properly in mkdocs, while it does render properly in GitHub's markdown viewer. #### Change Details: - Added a single line of whitespace before the markdown table to ensure proper rendering in mkdocs. #### Note: - I wasn't able to test this fix in the mkdocs environment, but it should be safe as it only involves adding whitespace which won't break anything. --- Cohere supports following input types: | Input Type | Description | |-------------------------|---------------------------------------| | "`search_document`" | Used for embeddings stored in a vector| | | database for search use-cases. | | "`search_query`" | Used for embeddings of search queries | | | run against a vector DB | | "`semantic_similarity`" | Specifies the given text will be used | | | for Semantic Textual Similarity (STS) | | "`classification`" | Used for embeddings passed through a | | | text classifier. | | "`clustering`" | Used for the embeddings run through a | | | clustering algorithm | Usage Example:
LanceDB Documentation
LanceDB docs are deployed to https://lancedb.github.io/lancedb/.
Docs is built and deployed automatically by Github Actions
whenever a commit is pushed to the main branch. So it is possible for the docs to show
unreleased features.
Building the docs
Setup
- Install LanceDB. From LanceDB repo root:
pip install -e python - Install dependencies. From LanceDB repo root:
pip install -r docs/requirements.txt - Make sure you have node and npm setup
- Make sure protobuf and libssl are installed
Building node module and create markdown files
Build docs
From LanceDB repo root:
Run: PYTHONPATH=. mkdocs build -f docs/mkdocs.yml
If successful, you should see a docs/site directory that you can verify locally.
Run local server
You can run a local server to test the docs prior to deployment by navigating to the docs directory and running the following command:
cd docs
mkdocs serve
Run doctest for typescript example
cd lancedb/docs
npm i
npm run build
npm run all