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:
Harrison Chase
2023-01-02 08:24:09 -08:00
committed by GitHub
parent c5f0af9398
commit 985496f4be
164 changed files with 4326 additions and 2586 deletions

View File

@@ -1,4 +1,4 @@
:mod:`langchain.agents`
Agents
===============================
.. automodule:: langchain.agents

View File

@@ -1,4 +1,4 @@
:mod:`langchain.chains`
Chains
=======================
.. automodule:: langchain.chains

View File

@@ -1,4 +1,4 @@
:mod:`langchain.docstore`
Docstore
=============================
.. automodule:: langchain.docstore

View File

@@ -1,4 +1,4 @@
:mod:`langchain.embeddings`
Embeddings
===========================
.. automodule:: langchain.embeddings

View File

@@ -1,4 +1,4 @@
:mod:`langchain.prompts.example_selector`
Example Selector
=========================================
.. automodule:: langchain.prompts.example_selector

View File

@@ -1,6 +1,7 @@
:mod:`langchain.llms`
LLMs
=======================
.. automodule:: langchain.llms
:members:
:inherited-members:
:special-members: __call__

View File

@@ -1,4 +1,4 @@
:mod:`langchain.prompts`
PromptTemplates
========================
.. automodule:: langchain.prompts

View File

@@ -1,4 +1,4 @@
:mod:`langchain.python`
Python REPL
=============================
.. automodule:: langchain.python

View File

@@ -1,4 +1,4 @@
:mod:`langchain.serpapi`
SerpAPI
=============================
.. automodule:: langchain.serpapi

View File

@@ -1,4 +1,4 @@
:mod:`langchain.text_splitter`
Text Splitter
==============================
.. automodule:: langchain.text_splitter

View File

@@ -1,4 +1,4 @@
:mod:`langchain.vectorstores`
VectorStores
=============================
.. automodule:: langchain.vectorstores