Skip to content

DOC: Add diagram(s) showing components relationships (specialization, usage, dependency...)? #437

@fterrani

Description

@fterrani

URL

https://python.langchain.com/docs/integrations/components/

Checklist

  • I added a very descriptive title to this issue.
  • I included a link to the documentation page I am referring to (if applicable).

Issue with current documentation:

I'm reading the LangChain docs and trying to understand how components work together. So far, I couldn't find any diagram showing how components are related. Information does exist but seems scattered in several pages that I very quickly get lost among.

I know it's possible to get the information I need with the current documentation, but I don't think it is efficient at all. I'm certain there are several people in the project who do have the necessary knowledge, could spend a handful of hours on diagrams that could collectively save LangChain users god knows how many hours.

Idea or request for content:

I'm not asking for a pristine code-accurate UML, but at least something informal yet useful, showing for example:

  • that a chat model simply wraps an LLM (I guess?)
  • that an LLM can call tools and tools can be grouped in toolkits
  • that a vector store can be seen as a retriever (I guess?)
  • that an embedding model takes text as input and produces a vector as an output, which can then be added to a vector store (I guess?)
  • ...

Ideally, everything listed under the Components section could be represented. Most specific parts can be represented very simply while the main component types (those not under the Other category) should be given more space & attention. One could also separate that in simpler cases, e.g.:

  • A diagram for text, embedding model, vector and vector store
  • A diagram for query, retriever and documents
  • ...

Metadata

Metadata

Assignees

No one assigned

    Labels

    langchainFor docs changes to LangChain

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions