start to track documents

.pre-commit-config.yaml

@@ -12,11 +12,16 @@ repos:
     rev: 24.4.2
     hooks:
       - id: black
-        args: ["--line-length=88"]
+        args: ['--line-length=88']
 
   - repo: https://github.com/astral-sh/ruff-pre-commit
     rev: v0.4.2
     hooks:
       # Run the linter.
       - id: ruff
-        args: ["--fix", "--extend-ignore=E402"]
+        args: ['--fix', '--extend-ignore=E402']
+  # - repo: https://github.com/pycqa/flake8
+  #   rev: 4.0.1
+  #   hooks:
+  #     - id: flake8
+  #       args: ['--max-line-length=88']

developer_notes/generator.ipynb

@@ -88,7 +88,7 @@
    "source": [
     "from lightrag.core import Component, Generator, Prompt\n",
     "from lightrag.components.model_client import GroqAPIClient\n",
-    "from lightrag.utils import setup_env\n",
+    "from lightrag.utils import setup_env # noqa\n",
     "\n",
     "\n",
     "class SimpleQA(Component):\n",

developer_notes/generator_note.py

@@ -1,6 +1,5 @@
 from lightrag.core import Component, Generator
 from lightrag.components.model_client import GroqAPIClient
-from lightrag.utils import setup_env  # noqa
 
 
 class SimpleQA(Component):

docs/.gitignore

@@ -1,15 +1,15 @@
-source/apis/components/components*
-source/apis/components/_autosummary*
-source/apis/components/modules*
-source/apis/core/core*
-source/apis/core/modules*
-source/apis/eval/eval*
-source/apis/eval/modules*
-source/apis/prompts/prompts*
-source/apis/prompts/modules*
-source/apis/utils/utils*
-source/apis/utils/modules*
-source/apis/tracing/tracing*
-source/apis/tracing/modules*
-source/apis/optim/optim*
-source/apis/optim/modules*
+# source/apis/components/components*
+# source/apis/components/_autosummary*
+# source/apis/components/modules*
+# source/apis/core/core*
+# source/apis/core/modules*
+# source/apis/eval/eval*
+# source/apis/eval/modules*
+# source/apis/prompts/prompts*
+# source/apis/prompts/modules*
+# source/apis/utils/utils*
+# source/apis/utils/modules*
+# source/apis/tracing/tracing*
+# source/apis/tracing/modules*
+# source/apis/optim/optim*
+# source/apis/optim/modules*

docs/Makefile

@@ -22,12 +22,12 @@ help:
 	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
 
 apidoc:
-	@sphinx-apidoc -o $(APIDOCOUTDIR)/core ../lightrag/core --separate --force
-	@sphinx-apidoc -o $(APIDOCOUTDIR)/components ../lightrag/components --separate --force --templatedir=$(SOURCEDIR)/_templates	
-	@sphinx-apidoc -o $(APIDOCOUTDIR)/eval ../lightrag/eval --separate --force
-	@sphinx-apidoc -o $(APIDOCOUTDIR)/optim ../lightrag/optim --separate --force
-	@sphinx-apidoc -o $(APIDOCOUTDIR)/utils ../lightrag/utils --separate --force
-	@sphinx-apidoc -o $(APIDOCOUTDIR)/tracing ../lightrag/tracing --separate --force
+	@sphinx-apidoc -o $(APIDOCOUTDIR)/core ../lightrag/lightrag/core --separate --force
+	@sphinx-apidoc -o $(APIDOCOUTDIR)/components ../lightrag/lightrag/components --separate --force --templatedir=$(SOURCEDIR)/_templates
+	@sphinx-apidoc -o $(APIDOCOUTDIR)/eval ../lightrag/lightrag/eval --separate --force
+	@sphinx-apidoc -o $(APIDOCOUTDIR)/optim ../lightrag/lightrag/optim --separate --force
+	@sphinx-apidoc -o $(APIDOCOUTDIR)/utils ../lightrag/lightrag/utils --separate --force
+	@sphinx-apidoc -o $(APIDOCOUTDIR)/tracing ../lightrag/lightrag/tracing --separate --force
 	@echo "Inserting reference labels into RST files."
 	@python $(SOURCEDIR)/insert_labels.py
 	@echo "Removing unnecessary strings for better formatting"
@@ -38,4 +38,4 @@ apidoc:
 
 
 html: apidoc
-	@$(SPHINXBUILD) -b html "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+	@$(SPHINXBUILD) -b html "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/source/_static/css/custom.css

@@ -20,6 +20,9 @@
       width: 270px; /* Adjust the width for larger screens */
   }
 }
+.pre {
+  color: #0a7d91; /* Change the color of ```` blocks */
+}
 
 /* .copyright {
   text-align: center;

docs/source/apis/components/_autosummary/components.agent.react.rst

@@ -0,0 +1,20 @@
+components.agent.react
+======================
+
+.. automodule:: components.agent.react
+
+
+
+
+
+
+
+
+
+
+
+   .. rubric:: Classes
+
+   .. autosummary::
+
+      ReActAgent

docs/source/apis/components/_autosummary/components.api_client.anthropic_client.rst

@@ -0,0 +1,22 @@
+.. _components-api_client-anthropic_client:
+
+components.api\_client.anthropic\_client
+========================================
+
+.. automodule:: components.api_client.anthropic_client
+
+
+
+
+
+
+
+
+
+
+
+   .. rubric:: Classes
+
+   .. autosummary::
+
+      AnthropicAPIClient

docs/source/apis/components/_autosummary/components.api_client.google_client.rst

@@ -0,0 +1,22 @@
+.. _components-api_client-google_client:
+
+components.api\_client.google\_client
+=====================================
+
+.. automodule:: components.api_client.google_client
+
+
+
+
+
+
+
+
+
+
+
+   .. rubric:: Classes
+
+   .. autosummary::
+
+      GoogleGenAIClient

docs/source/apis/components/_autosummary/components.api_client.groq_client.rst

@@ -0,0 +1,22 @@
+.. _components-api_client-groq_client:
+
+components.api\_client.groq\_client
+===================================
+
+.. automodule:: components.api_client.groq_client
+
+
+
+
+
+
+
+
+
+
+
+   .. rubric:: Classes
+
+   .. autosummary::
+
+      GroqAPIClient

docs/source/apis/components/_autosummary/components.api_client.openai_client.rst

@@ -0,0 +1,22 @@
+.. _components-api_client-openai_client:
+
+components.api\_client.openai\_client
+=====================================
+
+.. automodule:: components.api_client.openai_client
+
+
+
+
+
+
+
+
+
+
+
+   .. rubric:: Classes
+
+   .. autosummary::
+
+      OpenAIClient

docs/source/apis/components/_autosummary/components.api_client.transformers_client.rst

@@ -0,0 +1,29 @@
+.. _components-api_client-transformers_client:
+
+components.api\_client.transformers\_client
+===========================================
+
+.. automodule:: components.api_client.transformers_client
+
+
+
+
+
+
+
+   .. rubric:: Functions
+
+   .. autosummary::
+
+      average_pool
+
+
+
+
+
+   .. rubric:: Classes
+
+   .. autosummary::
+
+      TransformerEmbedder
+      TransformersClient

docs/source/apis/components/_autosummary/components.data_process.data_components.rst

@@ -0,0 +1,27 @@
+components.data\_process.data\_components
+=========================================
+
+.. automodule:: components.data_process.data_components
+
+
+
+
+
+
+
+   .. rubric:: Functions
+
+   .. autosummary::
+
+      retriever_output_to_context_str
+
+
+
+
+
+   .. rubric:: Classes
+
+   .. autosummary::
+
+      RetrieverOutputToContextStr
+      ToEmbeddings

docs/source/apis/components/_autosummary/components.data_process.document_splitter.rst

@@ -0,0 +1,28 @@
+.. _components-data_process-document_splitter:
+
+components.data\_process.document\_splitter
+===========================================
+
+.. automodule:: components.data_process.document_splitter
+
+
+
+
+
+
+
+   .. rubric:: Functions
+
+   .. autosummary::
+
+      split_text_by_token_fn
+
+
+
+
+
+   .. rubric:: Classes
+
+   .. autosummary::
+
+      DocumentSplitter

docs/source/apis/components/_autosummary/components.data_process.text_splitter.rst

@@ -0,0 +1,20 @@
+components.data\_process.text\_splitter
+=======================================
+
+.. automodule:: components.data_process.text_splitter
+
+
+
+
+
+
+
+
+
+
+
+   .. rubric:: Classes
+
+   .. autosummary::
+
+      TextSplitter

docs/source/apis/components/_autosummary/components.memory.memory.rst

@@ -0,0 +1,20 @@
+components.memory.memory
+========================
+
+.. automodule:: components.memory.memory
+
+
+
+
+
+
+
+
+
+
+
+   .. rubric:: Classes
+
+   .. autosummary::
+
+      Memory

docs/source/apis/components/_autosummary/components.model_client.anthropic_client.rst

@@ -0,0 +1,20 @@
+components.model\_client.anthropic\_client
+==========================================
+
+.. automodule:: components.model_client.anthropic_client
+
+
+
+
+
+
+
+
+
+
+
+   .. rubric:: Classes
+
+   .. autosummary::
+
+      AnthropicAPIClient

docs/source/apis/components/_autosummary/components.model_client.cohere_client.rst

@@ -0,0 +1,20 @@
+components.model\_client.cohere\_client
+=======================================
+
+.. automodule:: components.model_client.cohere_client
+
+
+
+
+
+
+
+
+
+
+
+   .. rubric:: Classes
+
+   .. autosummary::
+
+      CohereAPIClient