Update ADS LLM/Guardrail documentation (#479)

Author: qiuosier

docs/source/ads.llm.guardrails.rst

@@ -0,0 +1,38 @@
+ads.llm.guardrails package
+==========================
+
+.. toctree::
+   :maxdepth: 3
+
+   ads.llm.guardrails
+
+
+Submodules
+----------
+
+ads.llm.guardrails.base module
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. automodule:: ads.llm.guardrails.base
+   :members:
+   :undoc-members:
+   :show-inheritance:
+   :inherited-members:
+
+ads.llm.guardrails.huggingface module
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. automodule:: ads.llm.guardrails.huggingface
+   :members:
+   :undoc-members:
+   :show-inheritance:
+   :inherited-members:
+
+Module contents
+---------------
+
+.. automodule:: ads.llm.guardrails
+   :members:
+   :undoc-members:
+   :show-inheritance:
+   :inherited-members:

docs/source/ads.llm.langchain.plugins.rst

@@ -0,0 +1,65 @@
+ads.llm.langchain.plugins package
+=================================
+
+.. toctree::
+   :maxdepth: 3
+
+   ads.llm.langchain.plugins
+
+
+Submodules
+----------
+
+ads.llm.langchain.plugins.base module
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. automodule:: ads.llm.langchain.plugins.base
+   :members:
+   :undoc-members:
+   :show-inheritance:
+   :inherited-members:
+
+ads.llm.langchain.plugins.contant module
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. automodule:: ads.llm.langchain.plugins.contant
+   :members:
+   :undoc-members:
+   :show-inheritance:
+   :inherited-members:
+
+ads.llm.langchain.plugins.embeddings module
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. automodule:: ads.llm.langchain.plugins.embeddings
+   :members:
+   :undoc-members:
+   :show-inheritance:
+   :inherited-members:
+
+ads.llm.langchain.plugins.llm\_gen\_ai module
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. automodule:: ads.llm.langchain.plugins.llm_gen_ai
+   :members:
+   :undoc-members:
+   :show-inheritance:
+   :inherited-members:
+
+ads.llm.langchain.plugins.llm\_md module
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. automodule:: ads.llm.langchain.plugins.llm_md
+   :members:
+   :undoc-members:
+   :show-inheritance:
+   :inherited-members:
+
+Module contents
+---------------
+
+.. automodule:: ads.llm.langchain.plugins
+   :members:
+   :undoc-members:
+   :show-inheritance:
+   :inherited-members:

docs/source/ads.llm.langchain.rst

@@ -0,0 +1,25 @@
+ads.llm.langchain package
+=========================
+
+.. toctree::
+   :maxdepth: 3
+
+   ads.llm.langchain
+
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 3
+
+   ads.llm.langchain.plugins
+
+Module contents
+---------------
+
+.. automodule:: ads.llm.langchain
+   :members:
+   :undoc-members:
+   :show-inheritance:
+   :inherited-members:

docs/source/ads.llm.rst

@@ -0,0 +1,57 @@
+ads.llm package
+===============
+
+.. toctree::
+   :maxdepth: 3
+
+   ads.llm
+
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 3
+
+   ads.llm.guardrails
+   ads.llm.langchain
+   ads.llm.serializers
+
+Submodules
+----------
+
+ads.llm.chain module
+~~~~~~~~~~~~~~~~~~~~
+
+.. automodule:: ads.llm.chain
+   :members:
+   :undoc-members:
+   :show-inheritance:
+   :inherited-members:
+
+ads.llm.deploy module
+~~~~~~~~~~~~~~~~~~~~~
+
+.. automodule:: ads.llm.deploy
+   :members:
+   :undoc-members:
+   :show-inheritance:
+   :inherited-members:
+
+ads.llm.serialize module
+~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. automodule:: ads.llm.serialize
+   :members:
+   :undoc-members:
+   :show-inheritance:
+   :inherited-members:
+
+Module contents
+---------------
+
+.. automodule:: ads.llm
+   :members:
+   :undoc-members:
+   :show-inheritance:
+   :inherited-members:

docs/source/ads.llm.serializers.rst

@@ -0,0 +1,38 @@
+ads.llm.serializers package
+===========================
+
+.. toctree::
+   :maxdepth: 3
+
+   ads.llm.serializers
+
+
+Submodules
+----------
+
+ads.llm.serializers.retrieval\_qa module
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. automodule:: ads.llm.serializers.retrieval_qa
+   :members:
+   :undoc-members:
+   :show-inheritance:
+   :inherited-members:
+
+ads.llm.serializers.runnable\_parallel module
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. automodule:: ads.llm.serializers.runnable_parallel
+   :members:
+   :undoc-members:
+   :show-inheritance:
+   :inherited-members:
+
+Module contents
+---------------
+
+.. automodule:: ads.llm.serializers
+   :members:
+   :undoc-members:
+   :show-inheritance:
+   :inherited-members:

docs/source/user_guide/large_language_model/deploy_langchain_application.rst

@@ -2,49 +2,56 @@
 Deploy LangChain Application
 ############################
 
-Oracle ADS SDK now supports the deployment of LangChain application to OCI data science model deployment and you can easily do so just by writing a couple lines of code.
+Oracle ADS supports the deployment of LangChain application to OCI data science model deployment and you can easily do so just by writing a few lines of code.
 
 .. versionadded:: 2.9.1
 
+.. admonition:: Installation
+  :class: note
+
+  It is important to note that for ADS to serialize and deploy the LangChain application, all components used to build the application must be serializable. For more information regarding LLMs model serialization, see `here <https://python.langchain.com/docs/modules/model_io/llms/llm_serialization>`_.
+
 Configuration
 *************
 
 Ensure that you have created the necessary `policies, authentication, and authorization for model deployments <https://docs.oracle.com/en-us/iaas/data-science/using/model-dep-policies-auth.htm#model_dep_policies_auth>`_. 
-Here we're using the ``resource_principal`` as auth type and you can configure the policy as below.
+For example, the following policy allows the dynamic group to use ``resource_principal`` to create model deployment.
 
 .. code-block:: shell
 
     allow dynamic-group <dynamic-group-name> to manage data-science-model-deployments in compartment <compartment-name>
 
-Create LangChain Application
-****************************
+LangChain Application
+*********************
 
-Create a simple LangChain application that links prompt and cohere model as below. Remember to replace the ``<cohere_api_key>`` with the actual cohere api key.
+Following is a simple LangChain application that build with a prompt template and large language model API. Here the ``Cohere`` model is used as an example. You may replace it with any other LangChain compatible LLM, including OCI Generative AI service.
 
 .. code-block:: python3
 
     import os
     from langchain.llms import Cohere
     from langchain.chains import LLMChain
     from langchain.prompts import PromptTemplate
+    # Remember to replace the ``<cohere_api_key>`` with the actual cohere api key.
     os.environ["COHERE_API_KEY"] = "<cohere_api_key>"
     
     cohere = Cohere()
     prompt = PromptTemplate.from_template("Tell me a joke about {subject}")
     llm_chain = LLMChain(prompt=prompt, llm=cohere, verbose=True)
 
-Now you have a LangChain object ``llm_chain``. Try running it with the prompt ``{"subject": "animals"}`` and it should give you the corresponding result.
+Now you have a LangChain object ``llm_chain``. Try running it with the input ``{"subject": "animals"}`` and it should return a joke about animals.
 
 .. code-block:: python3
 
-    llm_chain.run({"subject": "animals"})
+    llm_chain.invoke({"subject": "animals"})
 
 Initialize the ChainDeployment
 ******************************
 
-Initialize class ``ChainDeployment`` from ADS SDK and pass the LangChain object ``llm_chain`` from previous step as parameter.
-The ``artifact_dir`` is an optional parameter which points to the folder where the model artifacts will be put locally. 
-In this example, we're using a temporary folder generated by ``tempfile``.
+ADS provides the ``ChainDeployment`` to handle the deployment of LangChain applications.
+You can initialize ``ChainDeployment`` with the LangChain object ``llm_chain`` from previous section as parameter.
+The ``artifact_dir`` is an optional parameter which points to the folder where the model artifacts will be put locally.
+In this example, we're using a temporary folder generated by ``tempfile.mkdtemp()``.
 
 .. code-block:: python3
 
@@ -75,7 +82,7 @@ Here, replace ``custom_conda_environment_uri`` with your conda environment uri t
         inference_python_version="<python_version>",
     )
 
-Below is the ``chain.yaml`` file that was saved from ``llm_chain`` object. For more information regarding LLMs model serialization, see `here <https://python.langchain.com/docs/modules/model_io/llms/llm_serialization>`_.
+Below is the ``chain.yaml`` file that was saved from ``llm_chain`` object.
 
 .. code-block:: YAML
     
@@ -110,6 +117,16 @@ Below is the ``chain.yaml`` file that was saved from ``llm_chain`` object. For m
     tags: null
     verbose: true
 
+Verify the Serialized Application
+*********************************
+
+Verify the serialized application by calling ``verify()`` to make sure it is working as expected.
+There will be error if your application is not fully serializable.
+
+.. code-block:: python3
+
+    chain_deployment.verify({"subject": "animals"})
+
 Save Artifacts to OCI Model Catalog
 ***********************************