docs(datasets): Add langchain datasets to API docs (#711)

* Add lanchain datasets to API docs Signed-off-by: Merel Theisen <[email protected]>
kedro-org · Jun 3, 2024 · 34cdffc · 34cdffc
1 parent 7f3f3ec
commit 34cdffc
Show file tree

Hide file tree

Showing 5 changed files with 25 additions and 7 deletions.
diff --git a/kedro-datasets/docs/source/api/kedro_datasets_experimental.rst b/kedro-datasets/docs/source/api/kedro_datasets_experimental.rst
@@ -10,3 +10,8 @@ kedro_datasets_experimental
 .. autosummary::
    :toctree:
    :template: autosummary/class.rst
+
+    kedro_datasets_experimental.langchain.ChatAnthropicDataset
+    kedro_datasets_experimental.langchain.ChatCohereDataset
+    kedro_datasets_experimental.langchain.ChatOpenAIDataset
+    kedro_datasets_experimental.langchain.OpenAIEmbeddingsDataset
diff --git a/kedro-datasets/docs/source/conf.py b/kedro-datasets/docs/source/conf.py
@@ -106,6 +106,8 @@
         "deltalake.table.Metadata",
         "DataCatalog",
         "ibis.backends.BaseBackend",
+        "langchain_openai.chat_models.base.ChatOpenAI",
+        "langchain_openai.embeddings.base.OpenAIEmbeddings",
     ),
     "py:data": (
         "typing.Any",
@@ -221,7 +223,6 @@
 
 # -- Kedro specific configuration -----------------------------------------
 KEDRO_MODULES = [
-    "kedro_datasets",
     "kedro_datasets_experimental"
 ]
 

diff --git a/kedro-datasets/kedro_datasets_experimental/langchain/_anthropic.py b/kedro-datasets/kedro_datasets_experimental/langchain/_anthropic.py
@@ -14,6 +14,7 @@ class ChatAnthropicDataset(AbstractDataset[None, ChatAnthropic]):
     catalog.yml:
 
     .. code-block:: yaml
+
        claude_instant_1:
          type: langchain.ChatAnthropicDataset
          kwargs:
@@ -25,6 +26,7 @@ class ChatAnthropicDataset(AbstractDataset[None, ChatAnthropic]):
     credentials.yml:
 
     .. code-block:: yaml
+
        anthropic:
          anthropic_api_url: <anthropic-api-base>
          anthropic_api_key: <anthropic-api-key>
@@ -33,7 +35,8 @@ class ChatAnthropicDataset(AbstractDataset[None, ChatAnthropic]):
     `Python API <https://kedro.readthedocs.io/en/stable/data/\
     advanced_data_catalog_usage.html>`_:
 
-    .. code-block:: python
+    .. code-block:: pycon
+
         >>> from kedro_datasets_experimental.langchain import ChatAnthropicDataset
         >>> llm = ChatAnthropicDataset(
         ...     credentials={

diff --git a/kedro-datasets/kedro_datasets_experimental/langchain/_cohere.py b/kedro-datasets/kedro_datasets_experimental/langchain/_cohere.py
@@ -16,6 +16,7 @@ class ChatCohereDataset(AbstractDataset[None, ChatCohere]):
     catalog.yml:
 
     .. code-block:: yaml
+
        command:
          type: langchain.ChatCohereDataset
          kwargs:
@@ -27,6 +28,7 @@ class ChatCohereDataset(AbstractDataset[None, ChatCohere]):
     credentials.yml:
 
     .. code-block:: yaml
+
        cohere:
          cohere_api_url: <cohere-api-base>
          cohere_api_key: <cohere-api-key>
@@ -35,7 +37,8 @@ class ChatCohereDataset(AbstractDataset[None, ChatCohere]):
     `Python API <https://kedro.readthedocs.io/en/stable/data/\
     advanced_data_catalog_usage.html>`_:
 
-    .. code-block:: python
+    .. code-block:: pycon
+
         >>> from kedro_datasets_experimental.langchain import ChatCohereDataset
         >>> llm = ChatCohereDataset(
         ...     credentials={
@@ -44,7 +47,7 @@ class ChatCohereDataset(AbstractDataset[None, ChatCohere]):
         ...     },
         ...     kwargs={
         ...         "model": "command",
-        ...         "temperature": 0,
+        ...         "temperature": 0.0,
         ...     }
         ... ).load()
         >>>

diff --git a/kedro-datasets/kedro_datasets_experimental/langchain/_openai.py b/kedro-datasets/kedro_datasets_experimental/langchain/_openai.py
@@ -50,6 +50,7 @@ class OpenAIEmbeddingsDataset(OpenAIDataset[OpenAIEmbeddings]):
     catalog.yml:
 
     .. code-block:: yaml
+
        text_embedding_ada_002:
          type: langchain.OpenAIEmbeddingsDataset
          kwargs:
@@ -59,6 +60,7 @@ class OpenAIEmbeddingsDataset(OpenAIDataset[OpenAIEmbeddings]):
     credentials.yml:
 
     .. code-block:: yaml
+
        openai:
          openai_api_base: <openai-api-base>
          openai_api_key: <openai-api-key>
@@ -67,7 +69,8 @@ class OpenAIEmbeddingsDataset(OpenAIDataset[OpenAIEmbeddings]):
     `Python API <https://kedro.readthedocs.io/en/stable/data/\
     advanced_data_catalog_usage.html>`_:
 
-    .. code-block:: python
+    .. code-block:: pycon
+
         >>> from kedro_datasets_experimental.langchain import OpenAIEmbeddingsDataset
         >>>
         >>> embeddings = OpenAIEmbeddingsDataset(
@@ -98,6 +101,7 @@ class ChatOpenAIDataset(OpenAIDataset[ChatOpenAI]):
     catalog.yml:
 
     .. code-block:: yaml
+
        gpt_3_5_turbo:
          type: langchain.ChatOpenAIDataset
          kwargs:
@@ -108,6 +112,7 @@ class ChatOpenAIDataset(OpenAIDataset[ChatOpenAI]):
     credentials.yml:
 
     .. code-block:: yaml
+
        openai:
          openai_api_base: <openai-api-base>
          openai_api_key: <openai-api-key>
@@ -116,7 +121,8 @@ class ChatOpenAIDataset(OpenAIDataset[ChatOpenAI]):
     `Python API <https://kedro.readthedocs.io/en/stable/data/\
     advanced_data_catalog_usage.html>`_:
 
-    .. code-block:: python
+    .. code-block:: pycon
+
         >>> from kedro_datasets_experimental.langchain import ChatOpenAIDataset
         >>>
         >>> llm = ChatOpenAIDataset(
@@ -126,7 +132,7 @@ class ChatOpenAIDataset(OpenAIDataset[ChatOpenAI]):
         ...     },
         ...     kwargs={
         ...         "model": "gpt-3.5-turbo",
-        ...         "temperature": 0,
+        ...         "temperature": 0.0,
         ...     },
         ... ).load()
         >>>