From 52fa7f557743a2d28faf6036b84d16679e11b2a3 Mon Sep 17 00:00:00 2001 From: Ayush Chaurasia Date: Sat, 2 Sep 2023 22:17:19 +0530 Subject: [PATCH] [Docs] Small typo fixes (#460) --- docs/mkdocs.yml | 21 ++++++++++----------- docs/src/index.md | 2 +- docs/test/md_testing.py | 3 ++- python/lancedb/db.py | 6 +++--- python/lancedb/table.py | 4 ++-- 5 files changed, 18 insertions(+), 18 deletions(-) diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index 39ff39ee..e6fb8b78 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -67,6 +67,11 @@ nav: - Home: - 🏢 Home: index.md - 💡 Basics: basic.md + - 📚 Guides: + - Tables: guides/tables.md + - Vector Search: search.md + - SQL filters: sql.md + - Indexing: ann_indexes.md - 🧬 Embeddings: embedding.md - 🔍 Python full-text search: fts.md - 🔌 Integrations: @@ -91,12 +96,12 @@ nav: - 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 - - 📚 Guides: - - Tables: guides/tables.md - - Vector Search: search.md - - SQL filters: sql.md - - Indexing: ann_indexes.md - Basics: basic.md +- Guides: + - Tables: guides/tables.md + - Vector Search: search.md + - SQL filters: sql.md + - Indexing: ann_indexes.md - Embeddings: embedding.md - Python full-text search: fts.md - Integrations: @@ -121,12 +126,6 @@ nav: - 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 - -- Guides: - - Tables: guides/tables.md - - Vector Search: search.md - - SQL filters: sql.md - - Indexing: ann_indexes.md - API references: - Python API: python/python.md - Javascript API: javascript/modules.md diff --git a/docs/src/index.md b/docs/src/index.md index beeb7a1b..8aa43a28 100644 --- a/docs/src/index.md +++ b/docs/src/index.md @@ -1,6 +1,6 @@ # LanceDB -LanceDB is an open-source database for vector-search built with persistent storage, which greatly simplifies retrevial, filtering and management of embeddings. +LanceDB is an open-source database for vector-search built with persistent storage, which greatly simplifies retrieval, filtering and management of embeddings. ![Illustration](/lancedb/assets/ecosystem-illustration.png) diff --git a/docs/test/md_testing.py b/docs/test/md_testing.py index 081ab9fd..eaa25b62 100644 --- a/docs/test/md_testing.py +++ b/docs/test/md_testing.py @@ -8,7 +8,8 @@ excluded_globs = [ "../src/embedding.md", "../src/examples/*.md", "../src/integrations/voxel51.md", - "../src/guides/tables.md" + "../src/guides/tables.md", + "../src/python/duckdb.md", ] python_prefix = "py" diff --git a/python/lancedb/db.py b/python/lancedb/db.py index a898a8bf..bb6b24db 100644 --- a/python/lancedb/db.py +++ b/python/lancedb/db.py @@ -16,7 +16,7 @@ from __future__ import annotations import os from abc import ABC, abstractmethod from pathlib import Path -from typing import Optional +from typing import Optional, Union import pyarrow as pa from pyarrow import fs @@ -40,7 +40,7 @@ class DBConnection(ABC): self, name: str, data: Optional[DATA] = None, - schema: Optional[pa.Schema, LanceModel] = None, + schema: Optional[Union[pa.Schema, LanceModel]] = None, mode: str = "create", on_bad_vectors: str = "error", fill_value: float = 0.0, @@ -285,7 +285,7 @@ class LanceDBConnection(DBConnection): self, name: str, data: Optional[DATA] = None, - schema: Optional[pa.Schema, LanceModel] = None, + schema: Optional[Union[pa.Schema, LanceModel]] = None, mode: str = "create", on_bad_vectors: str = "error", fill_value: float = 0.0, diff --git a/python/lancedb/table.py b/python/lancedb/table.py index 6d361496..cd0b0187 100644 --- a/python/lancedb/table.py +++ b/python/lancedb/table.py @@ -75,7 +75,7 @@ def _to_record_batch_generator(data: Iterable, schema, on_bad_vectors, fill_valu class Table(ABC): """ - A [Table](Table) is a collection of Records in a LanceDB [Database](Database). + A Table is a collection of Records in a LanceDB Database. Examples -------- @@ -511,7 +511,7 @@ class LanceTable(Table): other_table: Union[LanceTable, ReaderLike], left_on: str, right_on: Optional[str] = None, - schema: Optional[pa.Schema, LanceModel] = None, + schema: Optional[Union[pa.Schema, LanceModel]] = None, ): """Merge another table into this table.