From f13b1c876e8501a25a795a82e4c0b2609f9ebe7e Mon Sep 17 00:00:00 2001 From: Francisco Javier Arceo Date: Fri, 21 Feb 2025 12:17:43 -0500 Subject: [PATCH] updated structure for better navigation in the toctree Signed-off-by: Francisco Javier Arceo --- docs/source/providers/index.md | 12 +++++++++--- docs/source/providers/vector_io/chromadb.md | 3 +++ docs/source/providers/vector_io/faiss.md | 3 +++ docs/source/providers/vector_io/index.md | 10 ---------- docs/source/providers/vector_io/pgvector.md | 3 +++ docs/source/providers/vector_io/qdrant.md | 3 +++ docs/source/providers/vector_io/sqlite-vec.md | 3 +++ docs/source/providers/vector_io/weaviate.md | 3 +++ 8 files changed, 27 insertions(+), 13 deletions(-) delete mode 100644 docs/source/providers/vector_io/index.md diff --git a/docs/source/providers/index.md b/docs/source/providers/index.md index b051ebb4a..3d2420c9f 100644 --- a/docs/source/providers/index.md +++ b/docs/source/providers/index.md @@ -33,14 +33,20 @@ Importantly, Llama Stack always strives to provide at least one fully "local" pr ## Vector IO -Vector IO refers to operations on vector databases, such as adding documents, searching, and deleting documents. -Vector IO plays a crucial role in [Retreival Augmented Generation (RAG)](../building_applications/rag), where the vector +Vector IO refers to operations on vector databases, such as adding documents, searching, and deleting documents. +Vector IO plays a crucial role in [Retreival Augmented Generation (RAG)](../..//building_applications/rag), where the vector io and database are used to store and retrieve documents for retrieval. +#### Vector IO Providers The following providers (i.e., databases) are available for Vector IO: ```{toctree} :maxdepth: 1 -vector_io/index +vector_io/faiss +vector_io/sqlite-vec +vector_io/chromadb +vector_io/pgvector +vector_io/qdrant +vector_io/weaviate ``` diff --git a/docs/source/providers/vector_io/chromadb.md b/docs/source/providers/vector_io/chromadb.md index d0826aca4..4a7caf2e1 100644 --- a/docs/source/providers/vector_io/chromadb.md +++ b/docs/source/providers/vector_io/chromadb.md @@ -1,3 +1,6 @@ +--- +orphan: true +--- # Chroma [Chroma](https://www.trychroma.com/) is an inline and remote vector diff --git a/docs/source/providers/vector_io/faiss.md b/docs/source/providers/vector_io/faiss.md index ba7e26c34..68ae36d70 100644 --- a/docs/source/providers/vector_io/faiss.md +++ b/docs/source/providers/vector_io/faiss.md @@ -1,3 +1,6 @@ +--- +orphan: true +--- # Faiss [Faiss](https://github.com/facebookresearch/faiss) is an inline vector database provider for Llama Stack. It diff --git a/docs/source/providers/vector_io/index.md b/docs/source/providers/vector_io/index.md deleted file mode 100644 index ea38e0951..000000000 --- a/docs/source/providers/vector_io/index.md +++ /dev/null @@ -1,10 +0,0 @@ -```{toctree} -:maxdepth: 2 - -chromadb -sqlite-vec -faiss -pgvector -qdrant -weaviate -``` diff --git a/docs/source/providers/vector_io/pgvector.md b/docs/source/providers/vector_io/pgvector.md index ef3bd628d..919eb88d8 100644 --- a/docs/source/providers/vector_io/pgvector.md +++ b/docs/source/providers/vector_io/pgvector.md @@ -1,3 +1,6 @@ +--- +orphan: true +--- # Postgres PGVector [PGVector](https://github.com/pgvector/pgvector) is a remote vector database provider for Llama Stack. It diff --git a/docs/source/providers/vector_io/qdrant.md b/docs/source/providers/vector_io/qdrant.md index 7097ecec4..c374ade98 100644 --- a/docs/source/providers/vector_io/qdrant.md +++ b/docs/source/providers/vector_io/qdrant.md @@ -1,3 +1,6 @@ +--- +orphan: true +--- # Qdrant [Qdrant](https://qdrant.tech/documentation/) is a remote vector database provider for Llama Stack. It diff --git a/docs/source/providers/vector_io/sqlite-vec.md b/docs/source/providers/vector_io/sqlite-vec.md index 2fd2782f3..f5ce4c003 100644 --- a/docs/source/providers/vector_io/sqlite-vec.md +++ b/docs/source/providers/vector_io/sqlite-vec.md @@ -1,3 +1,6 @@ +--- +orphan: true +--- # SQLite-Vec [SQLite-Vec](https://github.com/asg017/sqlite-vec) is an inline vector database provider for Llama Stack. It diff --git a/docs/source/providers/vector_io/weaviate.md b/docs/source/providers/vector_io/weaviate.md index 5c593ef42..47321781c 100644 --- a/docs/source/providers/vector_io/weaviate.md +++ b/docs/source/providers/vector_io/weaviate.md @@ -1,3 +1,6 @@ +--- +orphan: true +--- # Weaviate [Weaviate](https://weaviate.io/) is a vector database provider for Llama Stack.