Skip to content

Commit

Permalink
sync the index
Browse files Browse the repository at this point in the history
  • Loading branch information
Alleria1809 committed Jul 4, 2024
1 parent 101b2b9 commit 79e563d
Showing 1 changed file with 51 additions and 43 deletions.
94 changes: 51 additions & 43 deletions docs/source/apis/components/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,81 +3,89 @@
Components
==============

The components section of the LightRAG API documentation outlines the detailed specifications and functionalities of various API components. Each component plays a crucial role in the LightRAG framework, providing specialized capabilities and interactions.
.. The components section of the LightRAG API documentation outlines the detailed specifications and functionalities of various API components. Each component plays a crucial role in the LightRAG framework, providing specialized capabilities and interactions.
ModelClient
~~~~~~~~~~~~~~~~~~~~

Overview
----------
.. autosummary::
:toctree: None

components.agent.react

components.model_client.groq_client
components.model_client.anthropic_client
components.model_client.openai_client
components.model_client.cohere_client
components.model_client.google_client
components.model_client.groq_client
components.model_client.openai_client
components.model_client.transformers_client
components.model_client.utils

components.data_process.data_components
components.data_process.text_splitter
Retriever
~~~~~~~~~~~~~~~~~~~~

components.reasoning.chain_of_thought
.. autosummary::
:toctree: None

components.retriever.bm25_retriever
components.retriever.faiss_retriever
components.retriever.llm_retriever

components.retriever.postgres_retriever
components.retriever.reranker_retriever

components.output_parsers.outputs
components.retriever.reranker_retriever


Output Parsers
--------------
.. toctree::
:maxdepth: 1
~~~~~~~~~~~~~~~~~~~~

components.output_parsers
.. autosummary::
:toctree: None

Agents
------
.. toctree::
:maxdepth: 1
components.output_parsers.outputs

components.agent
Agent
~~~~~~~~~~~~~~~~~~~~

Model Clients
-----------------
.. toctree::
:maxdepth: 1
.. autosummary::
:toctree: None

components.model_client
components.agent.react

Data Process
----------------
.. toctree::
:maxdepth: 1
~~~~~~~~~~~~~~~~~~~~

components.data_process
.. autosummary::
:toctree: None

.. Embedders
.. ---------
.. .. toctree::
.. :maxdepth: 1

.. components.embedder
components.data_process.text_splitter

components.data_process.data_components

.. Reasoners
.. ---------
.. .. toctree::
.. :maxdepth: 1
Memory
~~~~~~~~~~~~~~~~~~~~

.. autosummary::
:toctree: None

components.memory.memory

Reasoning

.. autosummary::
:toctree: None

components.reasoning.chain_of_thought

.. components.reasoning

Retrievers
----------
.. toctree::
:maxdepth: 1
:maxdepth: 2
:hidden:

components.model_client
components.retriever
components.output_parsers
components.agent
components.data_process
components.reasoning
components.memory

0 comments on commit 79e563d

Please sign in to comment.