Add notebooks to docs (run-llama#1164)

richard-epsilla · Apr 16, 2023 · 8d279d4 · 8d279d4
1 parent 468e844
commit 8d279d4
Show file tree

Hide file tree

Showing 126 changed files with 9,103 additions and 8,630 deletions.
diff --git a/.github/workflows/dev_docs.yml b/.github/workflows/dev_docs.yml
@@ -10,9 +10,11 @@ jobs:
     steps:
       - uses: actions/checkout@v2
       - uses: cpina/github-action-push-to-another-repository@main
+      - uses: awalsh128/cache-apt-pkgs-action@latest
         env:
           API_TOKEN_GITHUB: ${{ secrets.PAT}}
         with:
+          packages: pandoc
           source-directory: './docs'
           destination-github-username: 'avb-is-me'
           destination-repository-name: 'gpt_index'

diff --git a/.gitignore b/.gitignore
@@ -82,7 +82,6 @@ target/
 
 # Jupyter Notebook
 .ipynb_checkpoints
-notebooks/
 
 # IPython
 profile_default/

diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -1,12 +1,19 @@
 version: 2
-sphinx:
-  configuration: docs/conf.py
-build:
-  image: testing
-formats: all
-python:
-  version: 3.9
-  install:
-    - requirements: docs/requirements.txt
-    - method: pip
-      path: .
+
+formats:
+  - htmlzip
+  - epub
+
+search:
+  ranking:
+    '*': 1
+    getting_started/*: 2
+    guides/*: 2
+    how_to/*: 2
+    use_cases/*: 2
+    gallery/*: 2
+    reference/*: 1
+    index.html*: 2
+
+conda:
+  environment: docs/readthedocs-environment.yml
diff --git a/docs/build_notebooks.py b/docs/build_notebooks.py
@@ -0,0 +1,27 @@
+import json
+import os
+
+source_dir = "../examples/"
+dest_dir = "./guides/notebooks/"
+relative_path = "../../../../examples"
+
+
+for example_dir in os.listdir(source_dir):
+    example_dir_path = os.path.join(source_dir, example_dir)
+
+    for nb_name in os.listdir(example_dir_path):
+        if not nb_name.endswith(".ipynb"):
+            continue
+
+        # make dest folder in docs
+        os.makedirs(os.path.join(dest_dir, example_dir), exist_ok=True)
+
+        # build link text
+        relative_nb_path = os.path.join(relative_path, example_dir, nb_name)
+        nb_link_text = json.dumps({"path": relative_nb_path})
+
+        # write nbsphinx-link document
+        nbsphinx_name = nb_name.replace(".ipynb", ".nblink")
+        nbsphinx_path = os.path.join(dest_dir, example_dir, nbsphinx_name)
+        with open(nbsphinx_path, "w") as f:
+            f.write(nb_link_text)
diff --git a/docs/conf.py b/docs/conf.py
@@ -37,6 +37,8 @@
     "sphinx_rtd_theme",
     "sphinx.ext.mathjax",
     "myst_parser",
+    "nbsphinx",
+    "nbsphinx_link",
 ]
 
 myst_heading_anchors = 4
@@ -55,6 +57,8 @@
 html_title = "LlamaIndex"
 html_static_path = ["_static"]
 
+# nbsphinx options
+nbsphinx_execute = "never"
 html_css_files = [
     "css/custom.css",
 ]

diff --git a/docs/guides/notebooks.rst b/docs/guides/notebooks.rst
@@ -3,4 +3,173 @@ Notebooks
 
 We offer a wide variety of example notebooks. They are referenced throughout the documentation.
 
-Example notebooks are found `here <https://github.com/jerryjliu/gpt_index/tree/main/examples>`_.
+All examples can be accessed using the menu links or can be found `directly in the repository`_.
+
+.. _directly in the repository: https://github.com/jerryjliu/llama_index/tree/main/examples
+
+.. toctree::
+  :glob:
+  :maxdepth: 1
+  :caption: Async
+
+  ./notebooks/async/*
+
+
+.. toctree::
+  :glob:
+  :maxdepth: 1
+  :caption: Azure
+
+  notebooks/azure_demo/*
+
+
+.. toctree::
+  :glob:
+  :maxdepth: 1
+  :caption: Chatbot
+
+  notebooks/chatbot/*
+
+
+.. toctree::
+  :glob:
+  :maxdepth: 1
+  :caption: ChatGPT Plugin
+
+  notebooks/chatgpt_plugin/*
+
+
+.. toctree::
+  :glob:
+  :maxdepth: 1
+  :caption: Composable Indices
+
+  notebooks/composable_indices/*
+
+
+.. toctree::
+  :glob:
+  :maxdepth: 1
+  :caption: Cost Analysis
+
+  notebooks/cost_analysis/*
+
+
+.. toctree::
+  :glob:
+  :maxdepth: 1
+  :caption: Data Connectors
+
+  notebooks/data_connectors/*
+
+
+.. toctree::
+  :glob:
+  :maxdepth: 1
+  :caption: Docstore
+
+  notebooks/docstore/*
+
+
+.. toctree::
+  :glob:
+  :maxdepth: 1
+  :caption: Evaluation
+
+  notebooks/evaluation/*
+
+
+.. toctree::
+  :glob:
+  :maxdepth: 1
+  :caption: Gastby
+
+  notebooks/gatsby/*
+
+
+.. toctree::
+  :glob:
+  :maxdepth: 1
+  :caption: Knowledge Graph
+
+  notebooks/knowledge_graph/*
+
+
+.. toctree::
+  :glob:
+  :maxdepth: 1
+  :caption: Langchain Integration
+
+  notebooks/langchain_demo/*
+
+
+.. toctree::
+  :glob:
+  :maxdepth: 1
+  :caption: Multimodal
+
+  notebooks/multimodal/*
+
+
+.. toctree::
+  :glob:
+  :maxdepth: 1
+  :caption: Node Post-Processor
+
+  notebooks/node_postprocessor/*
+
+
+.. toctree::
+  :glob:
+  :maxdepth: 1
+  :caption: Optimizer
+
+  notebooks/optimizer/*
+
+
+.. toctree::
+  :glob:
+  :maxdepth: 1
+  :caption: Paul Graham Essay
+
+  notebooks/paul_graham_essay/*
+
+
+.. toctree::
+  :glob:
+  :maxdepth: 1
+  :caption: Playground
+
+  notebooks/playground/*
+
+
+.. toctree::
+  :glob:
+  :maxdepth: 1
+  :caption: Query Transformations
+
+  notebooks/query_transformations/*
+
+
+.. toctree::
+  :glob:
+  :maxdepth: 1
+  :caption: Structured Indices
+
+  notebooks/struct_indices/*
+
+
+.. toctree::
+  :glob:
+  :maxdepth: 1
+  :caption: Wikipedia
+
+  notebooks/test_wiki/*
+
+
+.. toctree::
+  :glob:
+  :maxdepth: 1
+  :caption: Vector Indices
+
+  notebooks/vector_indices/*
diff --git a/docs/guides/notebooks/async/AsyncComposableIndicesSEC.nblink b/docs/guides/notebooks/async/AsyncComposableIndicesSEC.nblink
@@ -0,0 +1 @@
+{"path": "../../../../examples/async/AsyncComposableIndicesSEC.ipynb"}
diff --git a/docs/guides/notebooks/async/AsyncGPTTreeIndexDemo.nblink b/docs/guides/notebooks/async/AsyncGPTTreeIndexDemo.nblink
@@ -0,0 +1 @@
+{"path": "../../../../examples/async/AsyncGPTTreeIndexDemo.ipynb"}
diff --git a/docs/guides/notebooks/async/AsyncLLMPredictorDemo.nblink b/docs/guides/notebooks/async/AsyncLLMPredictorDemo.nblink
@@ -0,0 +1 @@
+{"path": "../../../../examples/async/AsyncLLMPredictorDemo.ipynb"}
diff --git a/docs/guides/notebooks/async/AsyncQueryDemo.nblink b/docs/guides/notebooks/async/AsyncQueryDemo.nblink
@@ -0,0 +1 @@
+{"path": "../../../../examples/async/AsyncQueryDemo.ipynb"}
diff --git a/docs/guides/notebooks/azure_demo/AzureOpenAI.nblink b/docs/guides/notebooks/azure_demo/AzureOpenAI.nblink
@@ -0,0 +1 @@
+{"path": "../../../../examples/azure_demo/AzureOpenAI.ipynb"}
diff --git a/docs/guides/notebooks/chatbot/Chatbot_SEC.nblink b/docs/guides/notebooks/chatbot/Chatbot_SEC.nblink
@@ -0,0 +1 @@
+{"path": "../../../../examples/chatbot/Chatbot_SEC.ipynb"}
diff --git a/docs/guides/notebooks/chatgpt_plugin/ChatGPTRetrievalPluginIndexDemo.nblink b/docs/guides/notebooks/chatgpt_plugin/ChatGPTRetrievalPluginIndexDemo.nblink
@@ -0,0 +1 @@
+{"path": "../../../../examples/chatgpt_plugin/ChatGPTRetrievalPluginIndexDemo.ipynb"}
diff --git a/docs/guides/notebooks/chatgpt_plugin/ChatGPTRetrievalPluginReaderDemo.nblink b/docs/guides/notebooks/chatgpt_plugin/ChatGPTRetrievalPluginReaderDemo.nblink
@@ -0,0 +1 @@
+{"path": "../../../../examples/chatgpt_plugin/ChatGPTRetrievalPluginReaderDemo.ipynb"}
diff --git a/docs/guides/notebooks/chatgpt_plugin/ChatGPT_Retrieval_Plugin_Upload.nblink b/docs/guides/notebooks/chatgpt_plugin/ChatGPT_Retrieval_Plugin_Upload.nblink
@@ -0,0 +1 @@
+{"path": "../../../../examples/chatgpt_plugin/ChatGPT_Retrieval_Plugin_Upload.ipynb"}
diff --git a/docs/guides/notebooks/composable_indices/City_Analysis-Decompose-KeywordTable.nblink b/docs/guides/notebooks/composable_indices/City_Analysis-Decompose-KeywordTable.nblink
@@ -0,0 +1 @@
+{"path": "../../../../examples/composable_indices/City_Analysis-Decompose-KeywordTable.ipynb"}
diff --git a/docs/guides/notebooks/composable_indices/ComposableIndices-Prior.nblink b/docs/guides/notebooks/composable_indices/ComposableIndices-Prior.nblink
@@ -0,0 +1 @@
+{"path": "../../../../examples/composable_indices/ComposableIndices-Prior.ipynb"}
diff --git a/docs/guides/notebooks/composable_indices/ComposableIndices-Weaviate.nblink b/docs/guides/notebooks/composable_indices/ComposableIndices-Weaviate.nblink
@@ -0,0 +1 @@
+{"path": "../../../../examples/composable_indices/ComposableIndices-Weaviate.ipynb"}
diff --git a/docs/guides/notebooks/composable_indices/ComposableIndices.nblink b/docs/guides/notebooks/composable_indices/ComposableIndices.nblink
@@ -0,0 +1 @@
+{"path": "../../../../examples/composable_indices/ComposableIndices.ipynb"}
diff --git a/docs/guides/notebooks/composable_indices/QASummaryGraph.nblink b/docs/guides/notebooks/composable_indices/QASummaryGraph.nblink
@@ -0,0 +1 @@
+{"path": "../../../../examples/composable_indices/QASummaryGraph.ipynb"}
diff --git a/docs/guides/notebooks/cost_analysis/TokenPredictor.nblink b/docs/guides/notebooks/cost_analysis/TokenPredictor.nblink
@@ -0,0 +1 @@
+{"path": "../../../../examples/cost_analysis/TokenPredictor.ipynb"}
diff --git a/docs/guides/notebooks/data_connectors/ChromaDemo.nblink b/docs/guides/notebooks/data_connectors/ChromaDemo.nblink
@@ -0,0 +1 @@
+{"path": "../../../../examples/data_connectors/ChromaDemo.ipynb"}
diff --git a/docs/guides/notebooks/data_connectors/DatabaseReaderDemo.nblink b/docs/guides/notebooks/data_connectors/DatabaseReaderDemo.nblink
@@ -0,0 +1 @@
+{"path": "../../../../examples/data_connectors/DatabaseReaderDemo.ipynb"}
diff --git a/docs/guides/notebooks/data_connectors/DiscordDemo.nblink b/docs/guides/notebooks/data_connectors/DiscordDemo.nblink
@@ -0,0 +1 @@
+{"path": "../../../../examples/data_connectors/DiscordDemo.ipynb"}
diff --git a/docs/guides/notebooks/data_connectors/FaissDemo.nblink b/docs/guides/notebooks/data_connectors/FaissDemo.nblink
@@ -0,0 +1 @@
+{"path": "../../../../examples/data_connectors/FaissDemo.ipynb"}
diff --git a/docs/guides/notebooks/data_connectors/GithubRepositoryReaderDemo.nblink b/docs/guides/notebooks/data_connectors/GithubRepositoryReaderDemo.nblink
@@ -0,0 +1 @@
+{"path": "../../../../examples/data_connectors/GithubRepositoryReaderDemo.ipynb"}
diff --git a/docs/guides/notebooks/data_connectors/GoogleDocsDemo.nblink b/docs/guides/notebooks/data_connectors/GoogleDocsDemo.nblink
@@ -0,0 +1 @@
+{"path": "../../../../examples/data_connectors/GoogleDocsDemo.ipynb"}
diff --git a/docs/guides/notebooks/data_connectors/MakeDemo.nblink b/docs/guides/notebooks/data_connectors/MakeDemo.nblink
@@ -0,0 +1 @@
+{"path": "../../../../examples/data_connectors/MakeDemo.ipynb"}
diff --git a/docs/guides/notebooks/data_connectors/MboxReaderDemo.nblink b/docs/guides/notebooks/data_connectors/MboxReaderDemo.nblink
@@ -0,0 +1 @@
+{"path": "../../../../examples/data_connectors/MboxReaderDemo.ipynb"}
diff --git a/docs/guides/notebooks/data_connectors/MilvusReaderDemo.nblink b/docs/guides/notebooks/data_connectors/MilvusReaderDemo.nblink
@@ -0,0 +1 @@
+{"path": "../../../../examples/data_connectors/MilvusReaderDemo.ipynb"}
diff --git a/docs/guides/notebooks/data_connectors/MongoDemo.nblink b/docs/guides/notebooks/data_connectors/MongoDemo.nblink
@@ -0,0 +1 @@
+{"path": "../../../../examples/data_connectors/MongoDemo.ipynb"}
diff --git a/docs/guides/notebooks/data_connectors/NotionDemo.nblink b/docs/guides/notebooks/data_connectors/NotionDemo.nblink
@@ -0,0 +1 @@
+{"path": "../../../../examples/data_connectors/NotionDemo.ipynb"}
diff --git a/docs/guides/notebooks/data_connectors/ObsidianReaderDemo.nblink b/docs/guides/notebooks/data_connectors/ObsidianReaderDemo.nblink
@@ -0,0 +1 @@
+{"path": "../../../../examples/data_connectors/ObsidianReaderDemo.ipynb"}
diff --git a/docs/guides/notebooks/data_connectors/PineconeDemo.nblink b/docs/guides/notebooks/data_connectors/PineconeDemo.nblink
@@ -0,0 +1 @@
+{"path": "../../../../examples/data_connectors/PineconeDemo.ipynb"}
diff --git a/docs/guides/notebooks/data_connectors/QdrantDemo.nblink b/docs/guides/notebooks/data_connectors/QdrantDemo.nblink
@@ -0,0 +1 @@
+{"path": "../../../../examples/data_connectors/QdrantDemo.ipynb"}
diff --git a/docs/guides/notebooks/data_connectors/SlackDemo.nblink b/docs/guides/notebooks/data_connectors/SlackDemo.nblink
@@ -0,0 +1 @@
+{"path": "../../../../examples/data_connectors/SlackDemo.ipynb"}
diff --git a/docs/guides/notebooks/data_connectors/TwitterDemo.nblink b/docs/guides/notebooks/data_connectors/TwitterDemo.nblink
@@ -0,0 +1 @@
+{"path": "../../../../examples/data_connectors/TwitterDemo.ipynb"}
diff --git a/docs/guides/notebooks/data_connectors/WeaviateDemo.nblink b/docs/guides/notebooks/data_connectors/WeaviateDemo.nblink
@@ -0,0 +1 @@
+{"path": "../../../../examples/data_connectors/WeaviateDemo.ipynb"}
diff --git a/docs/guides/notebooks/data_connectors/WebPageDemo.nblink b/docs/guides/notebooks/data_connectors/WebPageDemo.nblink
@@ -0,0 +1 @@
+{"path": "../../../../examples/data_connectors/WebPageDemo.ipynb"}
diff --git a/docs/guides/notebooks/docstore/DocstoreDemo.nblink b/docs/guides/notebooks/docstore/DocstoreDemo.nblink
@@ -0,0 +1 @@
+{"path": "../../../../examples/docstore/DocstoreDemo.ipynb"}
diff --git a/docs/guides/notebooks/evaluation/GuardrailsDemo.nblink b/docs/guides/notebooks/evaluation/GuardrailsDemo.nblink
@@ -0,0 +1 @@
+{"path": "../../../../examples/evaluation/GuardrailsDemo.ipynb"}
diff --git a/docs/guides/notebooks/evaluation/LangchainOutputParserDemo.nblink b/docs/guides/notebooks/evaluation/LangchainOutputParserDemo.nblink
@@ -0,0 +1 @@
+{"path": "../../../../examples/evaluation/LangchainOutputParserDemo.ipynb"}
diff --git a/docs/guides/notebooks/evaluation/TestNYC-Evaluation-Query.nblink b/docs/guides/notebooks/evaluation/TestNYC-Evaluation-Query.nblink
@@ -0,0 +1 @@
+{"path": "../../../../examples/evaluation/TestNYC-Evaluation-Query.ipynb"}
diff --git a/docs/guides/notebooks/evaluation/TestNYC-Evaluation.nblink b/docs/guides/notebooks/evaluation/TestNYC-Evaluation.nblink
@@ -0,0 +1 @@
+{"path": "../../../../examples/evaluation/TestNYC-Evaluation.ipynb"}
diff --git a/docs/guides/notebooks/gatsby/TestGatsby.nblink b/docs/guides/notebooks/gatsby/TestGatsby.nblink
@@ -0,0 +1 @@
+{"path": "../../../../examples/gatsby/TestGatsby.ipynb"}
diff --git a/docs/guides/notebooks/knowledge_graph/KnowledgeGraphDemo.nblink b/docs/guides/notebooks/knowledge_graph/KnowledgeGraphDemo.nblink
@@ -0,0 +1 @@
+{"path": "../../../../examples/knowledge_graph/KnowledgeGraphDemo.ipynb"}
diff --git a/docs/guides/notebooks/langchain_demo/LangchainDemo.nblink b/docs/guides/notebooks/langchain_demo/LangchainDemo.nblink
@@ -0,0 +1 @@
+{"path": "../../../../examples/langchain_demo/LangchainDemo.ipynb"}
diff --git a/docs/guides/notebooks/multimodal/Multimodal.nblink b/docs/guides/notebooks/multimodal/Multimodal.nblink
@@ -0,0 +1 @@
+{"path": "../../../../examples/multimodal/Multimodal.ipynb"}
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		{"path": "../../../../examples/async/AsyncComposableIndicesSEC.ipynb"}
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		{"path": "../../../../examples/azure_demo/AzureOpenAI.ipynb"}
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		{"path": "../../../../examples/chatbot/Chatbot_SEC.ipynb"}
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		{"path": "../../../../examples/chatgpt_plugin/ChatGPTRetrievalPluginIndexDemo.ipynb"}
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		{"path": "../../../../examples/composable_indices/City_Analysis-Decompose-KeywordTable.ipynb"}
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		{"path": "../../../../examples/cost_analysis/TokenPredictor.ipynb"}
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		{"path": "../../../../examples/data_connectors/ChromaDemo.ipynb"}
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		{"path": "../../../../examples/docstore/DocstoreDemo.ipynb"}
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		{"path": "../../../../examples/evaluation/GuardrailsDemo.ipynb"}
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		{"path": "../../../../examples/gatsby/TestGatsby.ipynb"}