Compare commits

...

3 Commits

Author SHA1 Message Date
Dev 2049
adb31b6585 cr 2023-05-25 21:54:38 -07:00
Dev 2049
293a3e22af concise 2023-05-25 21:23:52 -07:00
Dev 2049
e00e60ed2a concise 2023-05-25 21:20:16 -07:00

View File

@@ -1,28 +1,19 @@
Welcome to LangChain Welcome to LangChain
========================== ==========================
| **LangChain** is a framework for developing applications powered by language models. We believe that the most powerful and differentiated applications will not only call out to a language model, but will also be: Overview
1. *Data-aware*: connect a language model to other sources of data ----------------
2. *Agentic*: allow a language model to interact with its environment
| The LangChain framework is designed around these principles. | **LangChain** is a framework for developing applications powered by language models. It enables applications that are
1. **Data-aware**: connect a language model to other sources of data
2. **Agentic**: allow a language model to interact with its environment
| This is the Python specific portion of the documentation. For a purely conceptual guide to LangChain, see `here <https://docs.langchain.com/docs/>`_. For the JavaScript documentation, see `here <https://js.langchain.com/docs/>`_. | Note: this documentation is Python-specific. There is a separate `Conceptual Guide <https://docs.langchain.com/docs/>`_ and `JavaScript documentation <https://js.langchain.com/docs/>`_.
Getting Started Getting Started
---------------- ----------------
| How to get started using LangChain to create an Language Model application. We recommend heading to our `Quickstart Guide <./getting_started/getting_started.html>`_ to get set up and to familiarize yourself with key concepts.
- `Quickstart Guide <./getting_started/getting_started.html>`_
| Concepts and terminology.
- `Concepts and terminology <./getting_started/concepts.html>`_
| Tutorials created by community experts and presented on YouTube.
- `Tutorials <./getting_started/tutorials.html>`_
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 2
@@ -34,30 +25,24 @@ Getting Started
getting_started/concepts.md getting_started/concepts.md
getting_started/tutorials.md getting_started/tutorials.md
Modules Modules
----------- -----------
| These modules are the core abstractions which we view as the building blocks of any LLM-powered application. | LangChain provides standard, extendable interfaces and external integrations for the following modules (from least to most complex)
For each module LangChain provides standard, extendable interfaces. LangChain also provides external integrations and even end-to-end implementations for off-the-shelf use.
| The docs for each module contain quickstart examples, how-to guides, reference docs, and conceptual guides. - `Models <./modules/models.html>`_: LLMs, chat models, text embedding models
| The modules are (from least to most complex): - `Prompts <./modules/prompts.html>`_: Prompt management, optimization, and serialization
- `Models <./modules/models.html>`_: Supported model types and integrations. - `Memory <./modules/memory.html>`_: State that is persisted between calls of a chain/agent
- `Prompts <./modules/prompts.html>`_: Prompt management, optimization, and serialization. - `Indexes <./modules/indexes.html>`_: Connect language models to application-specific data
- `Memory <./modules/memory.html>`_: Memory refers to state that is persisted between calls of a chain/agent. - `Chains <./modules/chains.html>`_: Structured sequences of calls
- `Indexes <./modules/indexes.html>`_: Language models become much more powerful when combined with application-specific data - this module contains interfaces and integrations for loading, querying and updating external data. - `Agents <./modules/agents.html>`_: LLMs that execute high-level directives given a set of tools
- `Chains <./modules/chains.html>`_: Chains are structured sequences of calls (to an LLM or to a different utility). - `Callbacks <./modules/callbacks/getting_started.html>`_: Log and stream intermediate steps of any chain
- `Agents <./modules/agents.html>`_: An agent is a Chain in which an LLM, given a high-level directive and a set of tools, repeatedly decides an action, executes the action and observes the outcome until the high-level directive is complete.
- `Callbacks <./modules/callbacks/getting_started.html>`_: Callbacks let you log and stream the intermediate steps of any chain, making it easy to observe, debug, and evaluate the internals of an application.
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 1
@@ -67,38 +52,38 @@ For each module LangChain provides standard, extendable interfaces. LangChain al
./modules/models.rst ./modules/models.rst
./modules/prompts.rst ./modules/prompts.rst
./modules/memory.md ./modules/memory.rst
./modules/indexes.md ./modules/indexes.rst
./modules/chains.md ./modules/chains.rst
./modules/agents.md ./modules/agents.rst
./modules/callbacks/getting_started.ipynb ./modules/callbacks/getting_started.ipynb
Use Cases Use Cases
---------- ----------
| Best practices and built-in implementations for common LangChain use cases: | Best practices and built-in implementations for common use cases
- `Autonomous Agents <./use_cases/autonomous_agents.html>`_: Autonomous agents are long-running agents that take many steps in an attempt to accomplish an objective. Examples include AutoGPT and BabyAGI. - `Autonomous Agents <./use_cases/autonomous_agents.html>`_: Long-running agents that take many steps, like AutoGPT and BabyAGI
- `Agent Simulations <./use_cases/agent_simulations.html>`_: Putting agents in a sandbox and observing how they interact with each other and react to events can be an effective way to evaluate their long-range reasoning and planning abilities. - `Personal Assistants <./use_cases/personal_assistants.html>`_: Taking actions, storing interactions, and connecting to data
- `Personal Assistants <./use_cases/personal_assistants.html>`_: One of the primary LangChain use cases. Personal assistants need to take actions, remember interactions, and have knowledge about your data. - `Question Answering <./use_cases/question_answering.html>`_: Answering questions over specific documents
- `Question Answering <./use_cases/question_answering.html>`_: Another common LangChain use case. Answering questions over specific documents, only utilizing the information in those documents to construct an answer. - `Chatbots <./use_cases/chatbots.html>`_: Long-running conversations
- `Chatbots <./use_cases/chatbots.html>`_: Language models love to chat, making this a very natural use of them. - `Data Analysis <./use_cases/tabular.html>`_: Using language models to query structured data
- `Querying Tabular Data <./use_cases/tabular.html>`_: Recommended reading if you want to use language models to query structured data (CSVs, SQL, dataframes, etc). - `Code Understanding <./use_cases/code.html>`_: Using language models to analyze code
- `Code Understanding <./use_cases/code.html>`_: Recommended reading if you want to use language models to analyze code. - `Interacting with APIs <./use_cases/apis.html>`_: Enabling language models to interact with APIs
- `Interacting with APIs <./use_cases/apis.html>`_: Enabling language models to interact with APIs is extremely powerful. It gives them access to up-to-date information and allows them to take actions. - `Information Extraction <./use_cases/extraction.html>`_: Extract structured information from text
- `Extraction <./use_cases/extraction.html>`_: Extract structured information from text. - `Summarization <./use_cases/summarization.html>`_: Compressing long text
- `Summarization <./use_cases/summarization.html>`_: Compressing longer documents. A type of Data-Augmented Generation. - `Evaluation <./use_cases/evaluation.html>`_: Using language models to evaluate language models
- `Evaluation <./use_cases/evaluation.html>`_: Generative models are hard to evaluate with traditional metrics. One promising approach is to use language models themselves to do the evaluation. - `Agent Simulations <./use_cases/agent_simulations.html>`_: Putting agents in a sandbox and observing them
.. toctree:: .. toctree::
@@ -120,15 +105,14 @@ Use Cases
./use_cases/evaluation.rst ./use_cases/evaluation.rst
Reference Docs Reference
--------------- ---------------
| Full documentation on all methods, classes, installation methods, and integration setups for LangChain. | All methods, classes, installation methods, and integration setups
- `Installation <./reference/installation.html>`_
- `LangChain Installation <./reference/installation.html>`_ - `API Reference <./reference.html>`_
- `Reference Documentation <./reference.html>`_
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 1
@@ -143,16 +127,13 @@ Reference Docs
Ecosystem Ecosystem
------------ ------------
| LangChain integrates a lot of different LLMs, systems, and products. | LangChain has integrations for many models, tools and applications, and many applications are built using LangChain
| From the other side, many systems and products depend on LangChain.
| It creates a vibrant and thriving ecosystem.
- `Integrations <./integrations.html>`_: Use your favorite models, tools and applications within LangChain
- `Integrations <./integrations.html>`_: Guides for how other products can be used with LangChain. - `Dependents <./dependents.html>`_: Repositories that use LangChain
- `Dependents <./dependents.html>`_: List of repositories that use LangChain. - `Deployments <./ecosystem/deployments.html>`_: Instructions, code snippets, and template repositories for deploying LangChain apps
- `Deployments <./ecosystem/deployments.html>`_: A collection of instructions, code snippets, and template repositories for deploying LangChain apps.
.. toctree:: .. toctree::
@@ -170,21 +151,19 @@ Ecosystem
Additional Resources Additional Resources
--------------------- ---------------------
| Additional resources we think may be useful as you develop your application! - `LangChainHub <https://github.com/hwchase17/langchain-hub>`_: Share and explore other prompts, chains, and agents
- `LangChainHub <https://github.com/hwchase17/langchain-hub>`_: The LangChainHub is a place to share and explore other prompts, chains, and agents. - `Gallery <https://github.com/kyrolabs/awesome-langchain>`_: Great projects that use Langchain, compiled by the folks at `Kyrolabs <https://kyrolabs.com>`_
- `Gallery <https://github.com/kyrolabs/awesome-langchain>`_: A collection of great projects that use Langchain, compiled by the folks at `Kyrolabs <https://kyrolabs.com>`_. Useful for finding inspiration and example implementations. - `Tracing <./additional_resources/tracing.html>`_: Log and visualize the execution of chains and agents
- `Tracing <./additional_resources/tracing.html>`_: A guide on using tracing in LangChain to visualize the execution of chains and agents. - `Model Laboratory <./additional_resources/model_laboratory.html>`_: Experimenting with different prompts, models, and chains
- `Model Laboratory <./additional_resources/model_laboratory.html>`_: Experimenting with different prompts, models, and chains is a big part of developing the best possible application. The ModelLaboratory makes it easy to do so. - `YouTube <./additional_resources/youtube.html>`_: Video tutorials
- `Discord <https://discord.gg/6adMQxSpJS>`_: Join us on our Discord to discuss all things LangChain! - `Discord <https://discord.gg/6adMQxSpJS>`_: Discuss and share all things LangChain!
- `YouTube <./additional_resources/youtube.html>`_: A collection of the LangChain tutorials and videos. - `Production Support <https://forms.gle/57d8AmXBYp8PP8tZA>`_: Get a dedicated Slack channel with the LangChain team as you move your applications into production
- `Production Support <https://forms.gle/57d8AmXBYp8PP8tZA>`_: As you move your LangChains into production, we'd love to offer more comprehensive support. Please fill out this form and we'll set up a dedicated support Slack channel.
.. toctree:: .. toctree::
@@ -197,6 +176,6 @@ Additional Resources
Gallery <https://github.com/kyrolabs/awesome-langchain> Gallery <https://github.com/kyrolabs/awesome-langchain>
./additional_resources/tracing.md ./additional_resources/tracing.md
./additional_resources/model_laboratory.ipynb ./additional_resources/model_laboratory.ipynb
Discord <https://discord.gg/6adMQxSpJS>
./additional_resources/youtube.md ./additional_resources/youtube.md
Discord <https://discord.gg/6adMQxSpJS>
Production Support <https://forms.gle/57d8AmXBYp8PP8tZA> Production Support <https://forms.gle/57d8AmXBYp8PP8tZA>