Documentation

docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/conf.py

@@ -0,0 +1,25 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# For the full list of built-in configuration values, see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Project information -----------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
+
+project = "ldp"
+author = "FutureHouse"
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
+extensions = ["sphinx.ext.todo", "sphinx.ext.viewcode", "sphinx.ext.autodoc"]
+
+templates_path = ["_templates"]
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
+
+
+# -- Options for HTML output -------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
+
+html_theme = "alabaster"
+html_static_path = ["_static"]

docs/index.rst

@@ -0,0 +1,23 @@
+.. ldp documentation master file, created by
+   sphinx-quickstart on Thu Oct 24 14:50:30 2024.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to ldp's documentation!
+===============================
+
+.. toctree::
+   :maxdepth: 4
+   :caption: Contents:
+
+   modules
+
+
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

docs/ldp.agent.rst

@@ -0,0 +1,69 @@
+ldp.agent package
+=================
+
+Submodules
+----------
+
+ldp.agent.agent module
+----------------------
+
+.. automodule:: ldp.agent.agent
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+ldp.agent.agent\_client module
+------------------------------
+
+.. automodule:: ldp.agent.agent_client
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+ldp.agent.interactive\_agent module
+-----------------------------------
+
+.. automodule:: ldp.agent.interactive_agent
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+ldp.agent.memory\_agent module
+------------------------------
+
+.. automodule:: ldp.agent.memory_agent
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+ldp.agent.react\_agent module
+-----------------------------
+
+.. automodule:: ldp.agent.react_agent
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+ldp.agent.simple\_agent module
+------------------------------
+
+.. automodule:: ldp.agent.simple_agent
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+ldp.agent.tree\_of\_thoughts\_agent module
+------------------------------------------
+
+.. automodule:: ldp.agent.tree_of_thoughts_agent
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: ldp.agent
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/ldp.alg.optimizer.rst

@@ -0,0 +1,45 @@
+ldp.alg.optimizer package
+=========================
+
+Submodules
+----------
+
+ldp.alg.optimizer.ape module
+----------------------------
+
+.. automodule:: ldp.alg.optimizer.ape
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+ldp.alg.optimizer.memory module
+-------------------------------
+
+.. automodule:: ldp.alg.optimizer.memory
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+ldp.alg.optimizer.opt module
+----------------------------
+
+.. automodule:: ldp.alg.optimizer.opt
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+ldp.alg.optimizer.replay\_buffers module
+----------------------------------------
+
+.. automodule:: ldp.alg.optimizer.replay_buffers
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: ldp.alg.optimizer
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/ldp.alg.rst

@@ -0,0 +1,77 @@
+ldp.alg package
+===============
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   ldp.alg.optimizer
+
+Submodules
+----------
+
+ldp.alg.algorithms module
+-------------------------
+
+.. automodule:: ldp.alg.algorithms
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+ldp.alg.beam\_search module
+---------------------------
+
+.. automodule:: ldp.alg.beam_search
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+ldp.alg.callbacks module
+------------------------
+
+.. automodule:: ldp.alg.callbacks
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+ldp.alg.datasets module
+-----------------------
+
+.. automodule:: ldp.alg.datasets
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+ldp.alg.rollout module
+----------------------
+
+.. automodule:: ldp.alg.rollout
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+ldp.alg.runners module
+----------------------
+
+.. automodule:: ldp.alg.runners
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+ldp.alg.tree\_search module
+---------------------------
+
+.. automodule:: ldp.alg.tree_search
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: ldp.alg
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/ldp.graph.modules.rst

@@ -0,0 +1,45 @@
+ldp.graph.modules package
+=========================
+
+Submodules
+----------
+
+ldp.graph.modules.llm\_call module
+----------------------------------
+
+.. automodule:: ldp.graph.modules.llm_call
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+ldp.graph.modules.react module
+------------------------------
+
+.. automodule:: ldp.graph.modules.react
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+ldp.graph.modules.reflect module
+--------------------------------
+
+.. automodule:: ldp.graph.modules.reflect
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+ldp.graph.modules.thought module
+--------------------------------
+
+.. automodule:: ldp.graph.modules.thought
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: ldp.graph.modules
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/ldp.graph.rst

@@ -0,0 +1,85 @@
+ldp.graph package
+=================
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   ldp.graph.modules
+
+Submodules
+----------
+
+ldp.graph.async\_torch module
+-----------------------------
+
+.. automodule:: ldp.graph.async_torch
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+ldp.graph.common\_ops module
+----------------------------
+
+.. automodule:: ldp.graph.common_ops
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+ldp.graph.gradient\_estimators module
+-------------------------------------
+
+.. automodule:: ldp.graph.gradient_estimators
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+ldp.graph.loss\_ops module
+--------------------------
+
+.. automodule:: ldp.graph.loss_ops
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+ldp.graph.memory module
+-----------------------
+
+.. automodule:: ldp.graph.memory
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+ldp.graph.op\_utils module
+--------------------------
+
+.. automodule:: ldp.graph.op_utils
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+ldp.graph.ops module
+--------------------
+
+.. automodule:: ldp.graph.ops
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+ldp.graph.torch\_ops module
+---------------------------
+
+.. automodule:: ldp.graph.torch_ops
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: ldp.graph
+   :members:
+   :undoc-members:
+   :show-inheritance: