From b298f550fef75e1406257138e27af1e2f2791fc1 Mon Sep 17 00:00:00 2001 From: Bagatur <22008038+baskaryan@users.noreply.github.com> Date: Thu, 9 Nov 2023 11:57:09 -0800 Subject: [PATCH] update modules sidebar (#13141) --- docs/docs/get_started/introduction.mdx | 8 +------- docs/docs/modules/index.mdx | 8 +++++--- .../modules/model_io/models/chat/index.ipynb | 1 - docs/docs/modules/model_io/models/index.mdx | 4 ++-- .../modules/model_io/models/llms/index.ipynb | 1 - docs/sidebars.js | 18 ++++++++++++++++-- 6 files changed, 24 insertions(+), 16 deletions(-) diff --git a/docs/docs/get_started/introduction.mdx b/docs/docs/get_started/introduction.mdx index d232340af2..b887a0c3f1 100644 --- a/docs/docs/get_started/introduction.mdx +++ b/docs/docs/get_started/introduction.mdx @@ -45,20 +45,14 @@ These docs focus on the Python LangChain library. [Head here](https://js.langcha ## Modules -LangChain provides standard, extendable interfaces and integrations for the following modules, listed from least to most complex: +LangChain provides standard, extendable interfaces and integrations for the following modules: #### [Model I/O](/docs/modules/model_io/) Interface with language models #### [Retrieval](/docs/modules/data_connection/) Interface with application-specific data -#### [Chains](/docs/modules/chains/) -Construct sequences of calls #### [Agents](/docs/modules/agents/) Let chains choose which tools to use given high-level directives -#### [Memory](/docs/modules/memory/) -Persist application state between runs of a chain -#### [Callbacks](/docs/modules/callbacks/) -Log and stream intermediate steps of any chain ## Examples, ecosystem, and resources ### [Use cases](/docs/use_cases/question_answering/) diff --git a/docs/docs/modules/index.mdx b/docs/docs/modules/index.mdx index 4d897e1e3e..4b77c175d2 100644 --- a/docs/docs/modules/index.mdx +++ b/docs/docs/modules/index.mdx @@ -4,16 +4,18 @@ sidebar_class_name: hidden # Modules -LangChain provides standard, extendable interfaces and external integrations for the following modules, listed from least to most complex: +LangChain provides standard, extendable interfaces and external integrations for the following main modules: #### [Model I/O](/docs/modules/model_io/) Interface with language models #### [Retrieval](/docs/modules/data_connection/) Interface with application-specific data -#### [Chains](/docs/modules/chains/) -Construct sequences of calls #### [Agents](/docs/modules/agents/) Let chains choose which tools to use given high-level directives + +## Additional +#### [Chains](/docs/modules/chains/) +Common, building block compositions #### [Memory](/docs/modules/memory/) Persist application state between runs of a chain #### [Callbacks](/docs/modules/callbacks/) diff --git a/docs/docs/modules/model_io/models/chat/index.ipynb b/docs/docs/modules/model_io/models/chat/index.ipynb index 56ec08a245..5c1c544643 100644 --- a/docs/docs/modules/model_io/models/chat/index.ipynb +++ b/docs/docs/modules/model_io/models/chat/index.ipynb @@ -6,7 +6,6 @@ "metadata": {}, "source": [ "---\n", - "sidebar_position: 1\n", "title: Chat models\n", "---" ] diff --git a/docs/docs/modules/model_io/models/index.mdx b/docs/docs/modules/model_io/models/index.mdx index 287f4f552b..168cd9ae3e 100644 --- a/docs/docs/modules/model_io/models/index.mdx +++ b/docs/docs/modules/model_io/models/index.mdx @@ -5,10 +5,10 @@ sidebar_position: 1 LangChain provides interfaces and integrations for two types of models: -- [LLMs](/docs/modules/model_io/models/llms/): Models that take a text string as input and return a text string - [Chat models](/docs/modules/model_io/models/chat/): Models that are backed by a language model but take a list of Chat Messages as input and return a Chat Message +- [LLMs](/docs/modules/model_io/models/llms/): Models that take a text string as input and return a text string -## LLMs vs chat models +## LLMs vs Chat models LLMs and chat models are subtly but importantly different. LLMs in LangChain refer to pure text completion models. The APIs they wrap take a string prompt as input and output a string completion. OpenAI's GPT-3 is implemented as an LLM. diff --git a/docs/docs/modules/model_io/models/llms/index.ipynb b/docs/docs/modules/model_io/models/llms/index.ipynb index ed0fecc38b..11a06d92dc 100644 --- a/docs/docs/modules/model_io/models/llms/index.ipynb +++ b/docs/docs/modules/model_io/models/llms/index.ipynb @@ -6,7 +6,6 @@ "metadata": {}, "source": [ "---\n", - "sidebar_position: 0\n", "title: LLMs\n", "---" ] diff --git a/docs/sidebars.js b/docs/sidebars.js index 3679d7e4e2..d306c9e58c 100644 --- a/docs/sidebars.js +++ b/docs/sidebars.js @@ -46,8 +46,22 @@ module.exports = { { type: "category", label: "Modules", - collapsed: true, - items: [{ type: "autogenerated", dirName: "modules" } ], + collapsed: false, + items: [ + { type: "category", label: "Model I/O", collapsed: true, items: [{type:"autogenerated", dirName: "modules/model_io" }], link: { type: 'doc', id: "modules/model_io/index"}}, + { type: "category", label: "Retrieval", collapsed: true, items: [{type:"autogenerated", dirName: "modules/data_connection" }], link: { type: 'doc', id: "modules/data_connection/index"}}, + { type: "category", label: "Agents", collapsed: true, items: [{type:"autogenerated", dirName: "modules/agents" }], link: { type: 'doc', id: "modules/agents/index"}}, + { + type: "category", + label: "More", + collapsed: true, + items: [ + { type: "category", label: "Chains", collapsed: true, items: [{type:"autogenerated", dirName: "modules/chains" }], link: { type: 'doc', id: "modules/chains/index"}}, + { type: "category", label: "Memory", collapsed: true, items: [{type:"autogenerated", dirName: "modules/memory" }], link: { type: 'doc', id: "modules/memory/index"}}, + { type: "category", label: "Callbacks", collapsed: true, items: [{type:"autogenerated", dirName: "modules/callbacks" }], link: { type: 'doc', id: "modules/callbacks/index"}}, + ] + } + ], link: { type: 'doc', id: "modules/index"