Docs (#33)

* Some progress on docs * Write more docs * Quickstart minor edits * Add doc on changing LLM defaults. * Fix bug with wrong unit-task connections * Update tests cache * Installation and KG interaction docs * add knowledge graph notebook link * Fix image generation * Some more docs * Renam blog with images to nicer caps * Add explorer command to Kuzu demo notebook * Remove duplicate link to knowledge graph docs --------- Co-authored-by: Egor Kraev <[email protected]>
ShoggothAI · May 27, 2024 · e0a7622 · e0a7622
1 parent c796987
commit e0a7622
Show file tree

Hide file tree

Showing 83 changed files with 2,146 additions and 843 deletions.
diff --git a/.github/workflows/integration_test_minimal.yml b/.github/workflows/integration_test_minimal.yml
@@ -51,4 +51,4 @@ jobs:
       env:
         OPENAI_API_KEY: fake_key_1337
         TIKTOKEN_CACHE_DIR: tests/itest_cache/tiktoken_cache
-      run: poetry run python tests/run_integration_tests.py --minimal_only
+      run: poetry run python tests/run_integration_tests.py --minimal-only
diff --git a/.gitignore b/.gitignore
@@ -86,3 +86,6 @@ dmypy.json
 *.pyc
 
 scripts/
+
+# docs-related stuff
+docs/source/_autosummary
diff --git a/docs/source/advanced_api.rst b/docs/source/advanced_api.rst
diff --git a/docs/source/another_llm.nblink b/docs/source/another_llm.nblink
@@ -0,0 +1,3 @@
+{
+    "path": "../../examples/Using another LLM.ipynb"
+}
diff --git a/docs/source/autogen.rst b/docs/source/autogen.rst
@@ -1,10 +1,10 @@
-Autogen-related Examples
+AutoGen-related Examples
 ========================
 
-Here are some examples that firstly, show how some Autogen patterns translate into motleycrew (in particular,
+Here are some examples that firstly, show how some AutoGen patterns translate into motleycrew (in particular,
 how cases where UserProxy is only used as an AgentExecutor don't need multiple agents in other frameworks),
 and secondly, how to use motleycrew together with autogen, both by wrapping a collection of autogen agents as
-a motleycrew tool, and by giving motleycrew tools and agents as tool to autogen.
+a motleycrew tool, and by giving motleycrew tools and agents as tools to autogen.
 
 .. toctree::
    :maxdepth: 2

diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -49,3 +49,4 @@
 html_static_path = ["_static"]
 
 nbsphinx_allow_errors = True
+nbsphinx_execute = "never"
diff --git a/docs/source/examples.rst b/docs/source/examples.rst
@@ -5,9 +5,6 @@ Examples
 .. toctree::
    :maxdepth: 2
 
-   examples/image_generation_crewai
-   examples/math_crewai
-   examples/single_crewai
-   examples/single_llama_index
-   examples/single_openai_tools_react
+   examples/blog_with_images
+   examples/research_agent
    autogen
diff --git a/docs/source/examples/blog_with_images.nblink b/docs/source/examples/blog_with_images.nblink
@@ -0,0 +1,3 @@
+{
+    "path": "../../../examples/Blog with Images.ipynb"
+}
diff --git a/docs/source/examples/image_generation_crewai.nblink b/docs/source/examples/image_generation_crewai.nblink
diff --git a/docs/source/examples/integrating_autogen.nblink b/docs/source/examples/integrating_autogen.nblink
@@ -1,3 +1,3 @@
 {
-    "path": "../../../examples/Using AutoGen conversations with motleycrew.ipynb"
+    "path": "../../../examples/Using AutoGen with motleycrew.ipynb"
 }
diff --git a/docs/source/examples/math_single_agent.nblink b/docs/source/examples/math_single_agent.nblink
@@ -1,3 +1,3 @@
 {
-    "path": "../../../examples/math_single_agent.ipynb"
+    "path": "../../../examples/Math via python code with a single agent.ipynb"
 }
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -8,6 +8,7 @@ Welcome to motleycrew's documentation!
 
 .. toctree::
    Home <self>
+   installation
    usage
    examples
    api

diff --git a/docs/source/installation.rst b/docs/source/installation.rst
@@ -1,9 +1,38 @@
 Installation
 ============
 
-To use motleycrew, first install it using pip:
+Installation using pip
+---------------------
 
 .. code-block:: console
 
-   (.venv) $ pip install motleycrew
+    pip install motleycrew
 
+Installation from source
+------------------------
+| Motleycrew uses Poetry to manage its dependencies. We suggest you use it if you want to install motleycrew from source.
+| For installation instructions, see https://python-poetry.org/docs/#installation.
+
+Clone the repository_ and install the dependencies:
+
+.. code-block:: console
+
+    git clone https://github.com/ShoggothAI/motleycrew.git
+    cd motleycrew
+    poetry install
+
+This will create a virtual environment and install the required dependencies.
+
+You might also want to install optional dependencies (extra libraries like LlamaIndex or CrewAI) for additional functionality:
+
+.. code-block:: console
+
+    poetry install --all-extras
+
+If you want to install extra dependencies for development, you can use the following command:
+
+.. code-block:: console
+
+    poetry install --all-extras --with dev
+
+.. _repository: https://github.com/ShoggothAI/motleycrew
diff --git a/docs/source/kg_api.nblink b/docs/source/kg_api.nblink
diff --git a/docs/source/usage.rst b/docs/source/usage.rst
@@ -5,9 +5,8 @@ Usage
 .. toctree::
    :maxdepth: 2
 
-   installation
    quickstart
-   basic_api
-   advanced_api
+   key_concepts
    knowledge_graph
-   caching_observability
+   another_llm
+   caching_observability