From 3f983361cca1774cba50766cca28ebec889ab247 Mon Sep 17 00:00:00 2001 From: "Jeffrey (Dongkyu) Kim" Date: Thu, 24 Oct 2024 11:01:44 +0900 Subject: [PATCH] Release/v0.3.7 (#883) * edit migration guide * add api docs * dump version 0.3.7 --------- Co-authored-by: jeffrey --- autorag/VERSION | 2 +- docs/source/api_spec/autorag.rst | 1 + docs/source/api_spec/autorag.vectordb.rst | 37 +++++++++++++++++++++++ docs/source/migration.md | 6 ++-- 4 files changed, 42 insertions(+), 4 deletions(-) create mode 100644 docs/source/api_spec/autorag.vectordb.rst diff --git a/autorag/VERSION b/autorag/VERSION index 449d7e73a..0f8268533 100644 --- a/autorag/VERSION +++ b/autorag/VERSION @@ -1 +1 @@ -0.3.6 +0.3.7 diff --git a/docs/source/api_spec/autorag.rst b/docs/source/api_spec/autorag.rst index c4a0a8418..b8c249652 100644 --- a/docs/source/api_spec/autorag.rst +++ b/docs/source/api_spec/autorag.rst @@ -13,6 +13,7 @@ Subpackages autorag.nodes autorag.schema autorag.utils + autorag.vectordb Submodules ---------- diff --git a/docs/source/api_spec/autorag.vectordb.rst b/docs/source/api_spec/autorag.vectordb.rst new file mode 100644 index 000000000..952167616 --- /dev/null +++ b/docs/source/api_spec/autorag.vectordb.rst @@ -0,0 +1,37 @@ +autorag.vectordb package +======================== + +Submodules +---------- + +autorag.vectordb.base module +---------------------------- + +.. automodule:: autorag.vectordb.base + :members: + :undoc-members: + :show-inheritance: + +autorag.vectordb.chroma module +------------------------------ + +.. automodule:: autorag.vectordb.chroma + :members: + :undoc-members: + :show-inheritance: + +autorag.vectordb.milvus module +------------------------------ + +.. automodule:: autorag.vectordb.milvus + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: autorag.vectordb + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/migration.md b/docs/source/migration.md index e5d7aba02..7ae2175f3 100644 --- a/docs/source/migration.md +++ b/docs/source/migration.md @@ -38,12 +38,12 @@ from autorag.data.qa.sample import random_single_hop from autorag.data.qa.schema import Raw ``` -# v0.3.6 migration guide +# v0.3.7 migration guide At v0.3.6, there are changes of the vectordb. You have to specify what vectordb you want to use at the config YAML file. -- v0.3.5 version (previous v0.3.6) +- v0.3.6 version (previous v0.3.7) ```yaml node_lines: @@ -62,7 +62,7 @@ node_lines: weight_range: (4, 30) ``` -- v0.3.6 version +- v0.3.7 version ```yaml vectordb: