mirror of
https://github.com/hwchase17/langchain.git
synced 2025-09-05 13:06:03 +00:00
Docs refactor (#480)
Big docs refactor! Motivation is to make it easier for people to find resources they are looking for. To accomplish this, there are now three main sections: - Getting Started: steps for getting started, walking through most core functionality - Modules: these are different modules of functionality that langchain provides. Each part here has a "getting started", "how to", "key concepts" and "reference" section (except in a few select cases where it didnt easily fit). - Use Cases: this is to separate use cases (like summarization, question answering, evaluation, etc) from the modules, and provide a different entry point to the code base. There is also a full reference section, as well as extra resources (glossary, gallery, etc) Co-authored-by: Shreya Rajpal <ShreyaR@users.noreply.github.com>
This commit is contained in:
@@ -1,21 +0,0 @@
|
||||
Chains
|
||||
==============
|
||||
|
||||
One big part of chains is all the utilities that can be used as part of them.
|
||||
Here is some reference documentation for the utilities natively supported by LangChain.
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
:glob:
|
||||
|
||||
modules/python
|
||||
modules/serpapi
|
||||
|
||||
|
||||
With those utilities in mind, here are the reference docs for all the chains in LangChain.
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
:glob:
|
||||
|
||||
modules/chains
|
@@ -1,13 +0,0 @@
|
||||
Data Augmented Generation
|
||||
=========================
|
||||
|
||||
The reference guides here all relate to components necessary for data augmented generation.
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
:glob:
|
||||
|
||||
modules/text_splitter
|
||||
modules/docstore
|
||||
modules/embeddings
|
||||
modules/vectorstore
|
@@ -1,4 +1,6 @@
|
||||
# Installation Options
|
||||
# Installation
|
||||
|
||||
## Official Releases
|
||||
|
||||
LangChain is available on PyPi, so to it is easily installable with:
|
||||
|
||||
@@ -27,4 +29,12 @@ Note that if you are using `zsh`, you'll need to quote square brackets when pass
|
||||
|
||||
```
|
||||
pip install 'langchain[all]'
|
||||
```
|
||||
```
|
||||
|
||||
## Installing from source
|
||||
|
||||
If you want to install from source, you can do so by cloning the repo and running:
|
||||
|
||||
```
|
||||
pip install -e .
|
||||
```
|
||||
|
@@ -1,4 +1,4 @@
|
||||
# Integration Reference
|
||||
# Integrations
|
||||
|
||||
Besides the installation of this python package, you will also need to install packages and set environment variables depending on which chains you want to use.
|
||||
|
||||
|
@@ -1,4 +1,4 @@
|
||||
:mod:`langchain.agents`
|
||||
Agents
|
||||
===============================
|
||||
|
||||
.. automodule:: langchain.agents
|
||||
|
@@ -1,4 +1,4 @@
|
||||
:mod:`langchain.chains`
|
||||
Chains
|
||||
=======================
|
||||
|
||||
.. automodule:: langchain.chains
|
||||
|
@@ -1,4 +1,4 @@
|
||||
:mod:`langchain.docstore`
|
||||
Docstore
|
||||
=============================
|
||||
|
||||
.. automodule:: langchain.docstore
|
||||
|
@@ -1,4 +1,4 @@
|
||||
:mod:`langchain.embeddings`
|
||||
Embeddings
|
||||
===========================
|
||||
|
||||
.. automodule:: langchain.embeddings
|
||||
|
@@ -1,4 +1,4 @@
|
||||
:mod:`langchain.prompts.example_selector`
|
||||
Example Selector
|
||||
=========================================
|
||||
|
||||
.. automodule:: langchain.prompts.example_selector
|
||||
|
@@ -1,6 +1,7 @@
|
||||
:mod:`langchain.llms`
|
||||
LLMs
|
||||
=======================
|
||||
|
||||
.. automodule:: langchain.llms
|
||||
:members:
|
||||
:inherited-members:
|
||||
:special-members: __call__
|
||||
|
@@ -1,4 +1,4 @@
|
||||
:mod:`langchain.prompts`
|
||||
PromptTemplates
|
||||
========================
|
||||
|
||||
.. automodule:: langchain.prompts
|
||||
|
@@ -1,4 +1,4 @@
|
||||
:mod:`langchain.python`
|
||||
Python REPL
|
||||
=============================
|
||||
|
||||
.. automodule:: langchain.python
|
||||
|
@@ -1,4 +1,4 @@
|
||||
:mod:`langchain.serpapi`
|
||||
SerpAPI
|
||||
=============================
|
||||
|
||||
.. automodule:: langchain.serpapi
|
||||
|
@@ -1,4 +1,4 @@
|
||||
:mod:`langchain.text_splitter`
|
||||
Text Splitter
|
||||
==============================
|
||||
|
||||
.. automodule:: langchain.text_splitter
|
||||
|
@@ -1,4 +1,4 @@
|
||||
:mod:`langchain.vectorstores`
|
||||
VectorStores
|
||||
=============================
|
||||
|
||||
.. automodule:: langchain.vectorstores
|
||||
|
@@ -1,7 +1,7 @@
|
||||
LLMs & Prompts
|
||||
Prompts
|
||||
==============
|
||||
|
||||
The reference guides here all relate to objects for working with LLMs and Prompts.
|
||||
The reference guides here all relate to objects for working with Prompts.
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
@@ -9,4 +9,3 @@ The reference guides here all relate to objects for working with LLMs and Prompt
|
||||
|
||||
modules/prompt
|
||||
modules/example_selector
|
||||
modules/llms
|
||||
|
26
docs/reference/utils.rst
Normal file
26
docs/reference/utils.rst
Normal file
@@ -0,0 +1,26 @@
|
||||
Utilities
|
||||
==============
|
||||
|
||||
There are a lot of different utilities that LangChain provides integrations for
|
||||
These guides go over how to use them.
|
||||
These can largely be grouped into two categories: generic utilities, and then utilities for working with larger text documents.
|
||||
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
:glob:
|
||||
:caption: Generic Utilities
|
||||
|
||||
modules/python
|
||||
modules/serpapi
|
||||
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
:glob:
|
||||
:caption: Utilities for working with Documents
|
||||
|
||||
modules/docstore
|
||||
modules/text_splitter
|
||||
modules/embeddings
|
||||
modules/vectorstore
|
Reference in New Issue
Block a user