Merge pull request #371 from aurelio-labs/james/sphinx-autodocs

feat: sphinx autodocs
aurelio-labs · Aug 3, 2024 · 20af26f · 20af26f
2 parents 090413d + ecdd696
commit 20af26f
Show file tree

Hide file tree

Showing 117 changed files with 5,052 additions and 1,131 deletions.
diff --git a/docs/02-dynamic-routes.ipynb b/docs/02-dynamic-routes.ipynb
diff --git a/docs/08-async-dynamic-routes.ipynb b/docs/08-async-dynamic-routes.ipynb
@@ -707,7 +707,6 @@
    "outputs": [],
    "source": [
     "def parse_response(response: str):\n",
-    "\n",
     "    for call in response.function_call:\n",
     "        args = call[\"arguments\"]\n",
     "        if call[\"function_name\"] == \"get_time\":\n",

diff --git a/docs/source/_autosummary/semantic_router.encoders.AutoEncoder.rst b/docs/source/_autosummary/semantic_router.encoders.AutoEncoder.rst
@@ -0,0 +1,33 @@
+semantic\_router.encoders.AutoEncoder
+=====================================
+
+.. currentmodule:: semantic_router.encoders
+
+.. autoclass:: AutoEncoder
+   :members:
+   :show-inheritance:
+   :inherited-members:
+
+
+   .. automethod:: __init__
+
+
+   .. rubric:: Methods
+
+   .. autosummary::
+
+      ~AutoEncoder.__init__
+
+
+
+
+
+   .. rubric:: Attributes
+
+   .. autosummary::
+
+      ~AutoEncoder.type
+      ~AutoEncoder.name
+      ~AutoEncoder.model
+
+
diff --git a/docs/source/_autosummary/semantic_router.encoders.base.BaseEncoder.rst b/docs/source/_autosummary/semantic_router.encoders.base.BaseEncoder.rst
@@ -0,0 +1,47 @@
+semantic\_router.encoders.base.BaseEncoder
+==========================================
+
+.. currentmodule:: semantic_router.encoders.base
+
+.. autoclass:: BaseEncoder
+   :members:
+   :show-inheritance:
+   :inherited-members:
+
+
+   .. automethod:: __init__
+
+
+   .. rubric:: Methods
+
+   .. autosummary::
+
+      ~BaseEncoder.__init__
+      ~BaseEncoder.acall
+      ~BaseEncoder.construct
+      ~BaseEncoder.copy
+      ~BaseEncoder.dict
+      ~BaseEncoder.from_orm
+      ~BaseEncoder.json
+      ~BaseEncoder.parse_file
+      ~BaseEncoder.parse_obj
+      ~BaseEncoder.parse_raw
+      ~BaseEncoder.schema
+      ~BaseEncoder.schema_json
+      ~BaseEncoder.set_score_threshold
+      ~BaseEncoder.update_forward_refs
+      ~BaseEncoder.validate
+
+
+
+
+
+   .. rubric:: Attributes
+
+   .. autosummary::
+
+      ~BaseEncoder.name
+      ~BaseEncoder.score_threshold
+      ~BaseEncoder.type
+
+
diff --git a/docs/source/_autosummary/semantic_router.encoders.base.rst b/docs/source/_autosummary/semantic_router.encoders.base.rst
@@ -0,0 +1,31 @@
+semantic\_router.encoders.base
+==============================
+
+.. automodule:: semantic_router.encoders.base
+
+
+
+
+
+
+
+
+
+
+
+   .. rubric:: Classes
+
+   .. autosummary::
+      :toctree:
+      :template: custom-class-template.rst
+
+      BaseEncoder
+
+
+
+
+
+
+
+
+
diff --git a/docs/source/_autosummary/semantic_router.encoders.bedrock.BedrockEncoder.rst b/docs/source/_autosummary/semantic_router.encoders.bedrock.BedrockEncoder.rst
@@ -0,0 +1,55 @@
+semantic\_router.encoders.bedrock.BedrockEncoder
+================================================
+
+.. currentmodule:: semantic_router.encoders.bedrock
+
+.. autoclass:: BedrockEncoder
+   :members:
+   :show-inheritance:
+   :inherited-members:
+
+
+   .. automethod:: __init__
+
+
+   .. rubric:: Methods
+
+   .. autosummary::
+
+      ~BedrockEncoder.__init__
+      ~BedrockEncoder.acall
+      ~BedrockEncoder.chunk_strings
+      ~BedrockEncoder.construct
+      ~BedrockEncoder.copy
+      ~BedrockEncoder.dict
+      ~BedrockEncoder.from_orm
+      ~BedrockEncoder.get_env_variable
+      ~BedrockEncoder.json
+      ~BedrockEncoder.parse_file
+      ~BedrockEncoder.parse_obj
+      ~BedrockEncoder.parse_raw
+      ~BedrockEncoder.schema
+      ~BedrockEncoder.schema_json
+      ~BedrockEncoder.set_score_threshold
+      ~BedrockEncoder.update_forward_refs
+      ~BedrockEncoder.validate
+
+
+
+
+
+   .. rubric:: Attributes
+
+   .. autosummary::
+
+      ~BedrockEncoder.client
+      ~BedrockEncoder.type
+      ~BedrockEncoder.input_type
+      ~BedrockEncoder.name
+      ~BedrockEncoder.access_key_id
+      ~BedrockEncoder.secret_access_key
+      ~BedrockEncoder.session_token
+      ~BedrockEncoder.region
+      ~BedrockEncoder.score_threshold
+
+
diff --git a/docs/source/_autosummary/semantic_router.encoders.bedrock.rst b/docs/source/_autosummary/semantic_router.encoders.bedrock.rst
@@ -0,0 +1,31 @@
+semantic\_router.encoders.bedrock
+=================================
+
+.. automodule:: semantic_router.encoders.bedrock
+
+
+
+
+
+
+
+
+
+
+
+   .. rubric:: Classes
+
+   .. autosummary::
+      :toctree:
+      :template: custom-class-template.rst
+
+      BedrockEncoder
+
+
+
+
+
+
+
+
+
diff --git a/docs/source/_autosummary/semantic_router.encoders.bm25.BM25Encoder.rst b/docs/source/_autosummary/semantic_router.encoders.bm25.BM25Encoder.rst
@@ -0,0 +1,50 @@
+semantic\_router.encoders.bm25.BM25Encoder
+==========================================
+
+.. currentmodule:: semantic_router.encoders.bm25
+
+.. autoclass:: BM25Encoder
+   :members:
+   :show-inheritance:
+   :inherited-members:
+
+
+   .. automethod:: __init__
+
+
+   .. rubric:: Methods
+
+   .. autosummary::
+
+      ~BM25Encoder.__init__
+      ~BM25Encoder.acall
+      ~BM25Encoder.construct
+      ~BM25Encoder.copy
+      ~BM25Encoder.dict
+      ~BM25Encoder.fit
+      ~BM25Encoder.from_orm
+      ~BM25Encoder.json
+      ~BM25Encoder.parse_file
+      ~BM25Encoder.parse_obj
+      ~BM25Encoder.parse_raw
+      ~BM25Encoder.schema
+      ~BM25Encoder.schema_json
+      ~BM25Encoder.set_score_threshold
+      ~BM25Encoder.update_forward_refs
+      ~BM25Encoder.validate
+
+
+
+
+
+   .. rubric:: Attributes
+
+   .. autosummary::
+
+      ~BM25Encoder.model
+      ~BM25Encoder.idx_mapping
+      ~BM25Encoder.type
+      ~BM25Encoder.name
+      ~BM25Encoder.score_threshold
+
+
diff --git a/docs/source/_autosummary/semantic_router.encoders.bm25.rst b/docs/source/_autosummary/semantic_router.encoders.bm25.rst
@@ -0,0 +1,31 @@
+semantic\_router.encoders.bm25
+==============================
+
+.. automodule:: semantic_router.encoders.bm25
+
+
+
+
+
+
+
+
+
+
+
+   .. rubric:: Classes
+
+   .. autosummary::
+      :toctree:
+      :template: custom-class-template.rst
+
+      BM25Encoder
+
+
+
+
+
+
+
+
+
diff --git a/docs/source/_autosummary/semantic_router.encoders.clip.CLIPEncoder.rst b/docs/source/_autosummary/semantic_router.encoders.clip.CLIPEncoder.rst
@@ -0,0 +1,51 @@
+semantic\_router.encoders.clip.CLIPEncoder
+==========================================
+
+.. currentmodule:: semantic_router.encoders.clip
+
+.. autoclass:: CLIPEncoder
+   :members:
+   :show-inheritance:
+   :inherited-members:
+
+
+   .. automethod:: __init__
+
+
+   .. rubric:: Methods
+
+   .. autosummary::
+
+      ~CLIPEncoder.__init__
+      ~CLIPEncoder.acall
+      ~CLIPEncoder.construct
+      ~CLIPEncoder.copy
+      ~CLIPEncoder.dict
+      ~CLIPEncoder.from_orm
+      ~CLIPEncoder.json
+      ~CLIPEncoder.parse_file
+      ~CLIPEncoder.parse_obj
+      ~CLIPEncoder.parse_raw
+      ~CLIPEncoder.schema
+      ~CLIPEncoder.schema_json
+      ~CLIPEncoder.set_score_threshold
+      ~CLIPEncoder.update_forward_refs
+      ~CLIPEncoder.validate
+
+
+
+
+
+   .. rubric:: Attributes
+
+   .. autosummary::
+
+      ~CLIPEncoder.name
+      ~CLIPEncoder.type
+      ~CLIPEncoder.score_threshold
+      ~CLIPEncoder.tokenizer_kwargs
+      ~CLIPEncoder.processor_kwargs
+      ~CLIPEncoder.model_kwargs
+      ~CLIPEncoder.device
+
+
diff --git a/docs/source/_autosummary/semantic_router.encoders.clip.rst b/docs/source/_autosummary/semantic_router.encoders.clip.rst
@@ -0,0 +1,31 @@
+semantic\_router.encoders.clip
+==============================
+
+.. automodule:: semantic_router.encoders.clip
+
+
+
+
+
+
+
+
+
+
+
+   .. rubric:: Classes
+
+   .. autosummary::
+      :toctree:
+      :template: custom-class-template.rst
+
+      CLIPEncoder
+
+
+
+
+
+
+
+
+