Adding logging

.gitignore

@@ -9,16 +9,20 @@ __pycache__/
 
 # Distribution / packaging
 .Python
+bin/
 build/
 develop-eggs/
 dist/
 downloads/
 eggs/
 .eggs/
+etc/
+include/
 lib/
 lib64/
 parts/
 sdist/
+share/
 var/
 wheels/
 pip-wheel-metadata/
@@ -111,6 +115,7 @@ venv/
 ENV/
 env.bak/
 venv.bak/
+pyvenv.cfg
 
 # Spyder project settings
 .spyderproject

docs/getting_started/starter_example.md

@@ -2,10 +2,10 @@
 
 Here is a starter example for using GPT Index. Make sure you've followed the [installation](installation.md) steps first.
 
-
 ### Download
-GPT Index examples can be found in the `examples` folder of the GPT Index repository. 
-We first want to download this `examples` folder. An easy way to do this is to just clone the repo: 
+
+GPT Index examples can be found in the `examples` folder of the GPT Index repository.
+We first want to download this `examples` folder. An easy way to do this is to just clone the repo:
 
 ```bash
 $ git clone https://github.com/jerryjliu/gpt_index.git
@@ -22,16 +22,16 @@ Makefile               experimental/          requirements.txt
 README.md              gpt_index/             setup.py
 ```
 
-
 We now want to navigate to the following folder:
+
 ```bash
 $ cd examples/paul_graham_essay
 ```
 
 This contains GPT Index examples around Paul Graham's essay, ["What I Worked On"](http://paulgraham.com/worked.html). A comprehensive set of examples are already provided in `TestEssay.ipynb`. For the purposes of this tutorial, we can focus on a simple example of getting GPT Index up and running.
 
-
 ### Build and Query Index
+
 Create a new `.py` file with the following:
 
 ```python
@@ -43,13 +43,28 @@ index = GPTSimpleVectorIndex(documents)
 ```
 
 This builds an index over the documents in the `data` folder (which in this case just consists of the essay text). We then run the following
+
 ```python
 response = index.query("What did the author do growing up?")
 print(response)
 ```
 
 You should get back a response similar to the following: `The author wrote short stories and tried to program on an IBM 1401.`
 
+### Viewing Queries and Events Using Logging
+
+In a Jupyter notebook, you can view info and/or debugging logging using the following snippet:
+
+```python
+import logging
+import sys
+
+logging.basicConfig(stream=sys.stdout, level=logging.DEBUG)
+logging.getLogger().addHandler(logging.StreamHandler(stream=sys.stdout))
+```
+
+You can set the level to `DEBUG` for verbose output, or use `level=logging.INFO` for less.
+
 ### Saving and Loading
 
 To save to disk and load from disk, do
@@ -61,9 +76,7 @@ index.save_to_disk('index.json')
 index = GPTSimpleVectorIndex.load_from_disk('index.json')
 ```
 
-
 ### Next Steps
 
 That's it! For more information on GPT Index features, please check out the numerous "How-To Guides" to the left.
 Additionally, if you would like to play around with Example Notebooks, check out [this link](/reference/example_notebooks.rst).
-

examples/composable_indices/ComposableIndices.ipynb

@@ -10,6 +10,20 @@
     "# Composable Indices Demo"
    ]
   },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "fa0e62b6",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "import logging\n",
+    "import sys\n",
+    "\n",
+    "logging.basicConfig(stream=sys.stdout, level=logging.INFO)\n",
+    "logging.getLogger().addHandler(logging.StreamHandler(stream=sys.stdout))"
+   ]
+  },
   {
    "cell_type": "code",
    "execution_count": 1,
@@ -322,11 +336,11 @@
    "metadata": {},
    "outputs": [],
    "source": [
+    "# set Logging to DEBUG for more detailed outputs\n",
     "# ask it a question about NYC \n",
     "response = graph.query(\n",
     "    \"What is the climate of New York City like? How cold is it during the winter?\", \n",
-    "    query_configs=query_configs,\n",
-    "    verbose=True\n",
+    "    query_configs=query_configs\n",
     ")"
    ]
   },
@@ -436,9 +450,9 @@
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": "gpt_retrieve_venv",
+   "display_name": "Python 3 (ipykernel)",
    "language": "python",
-   "name": "gpt_retrieve_venv"
+   "name": "python3"
   },
   "language_info": {
    "codemirror_mode": {
@@ -450,7 +464,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.9.16"
+   "version": "3.11.1"
   }
  },
  "nbformat": 4,

examples/data_connectors/DatabaseReaderDemo.ipynb

@@ -1,5 +1,18 @@
 {
  "cells": [
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "import logging\n",
+    "import sys\n",
+    "\n",
+    "logging.basicConfig(stream=sys.stdout, level=logging.INFO)\n",
+    "logging.getLogger().addHandler(logging.StreamHandler(stream=sys.stdout))"
+   ]
+  },
   {
    "cell_type": "code",
    "execution_count": null,
@@ -162,7 +175,7 @@
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": "Python 3",
+   "display_name": "Python 3 (ipykernel)",
    "language": "python",
    "name": "python3"
   },
@@ -176,9 +189,8 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.10.7"
+   "version": "3.11.1"
   },
-  "orig_nbformat": 4,
   "vscode": {
    "interpreter": {
     "hash": "bd5508c2ffc7f17f7d31cf4086cc872f89e96996a08987e995649e5fbe85a3a4"

examples/data_connectors/DiscordDemo.ipynb

@@ -9,6 +9,20 @@
     "Demonstrates our Discord data connector"
    ]
   },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "5fb15bc4",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "import logging\n",
+    "import sys\n",
+    "\n",
+    "logging.basicConfig(stream=sys.stdout, level=logging.INFO)\n",
+    "logging.getLogger().addHandler(logging.StreamHandler(stream=sys.stdout))"
+   ]
+  },
   {
    "cell_type": "code",
    "execution_count": null,
@@ -65,7 +79,8 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "response = index.query(\"<query_text>\", verbose=True)"
+    "# set Logging to DEBUG for more detailed outputs\n",
+    "response = index.query(\"<query_text>\")"
    ]
   },
   {
@@ -81,9 +96,9 @@
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": "gpt_retrieve_venv",
+   "display_name": "Python 3 (ipykernel)",
    "language": "python",
-   "name": "gpt_retrieve_venv"
+   "name": "python3"
   },
   "language_info": {
    "codemirror_mode": {
@@ -95,7 +110,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.9.16"
+   "version": "3.11.1"
   }
  },
  "nbformat": 4,

examples/data_connectors/FaissDemo.ipynb

@@ -8,6 +8,20 @@
     "# Faiss Demo"
    ]
   },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "4026b434",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "import logging\n",
+    "import sys\n",
+    "\n",
+    "logging.basicConfig(stream=sys.stdout, level=logging.INFO)\n",
+    "logging.getLogger().addHandler(logging.StreamHandler(stream=sys.stdout))"
+   ]
+  },
   {
    "cell_type": "code",
    "execution_count": null,
@@ -112,7 +126,8 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "response = index.query(\"<query_text>\", verbose=True)"
+    "# set Logging to DEBUG for more detailed outputs\n",
+    "response = index.query(\"<query_text>\")"
    ]
   },
   {
@@ -128,9 +143,9 @@
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": "Python [conda env:conda_gpt_env]",
+   "display_name": "Python 3 (ipykernel)",
    "language": "python",
-   "name": "conda-env-conda_gpt_env-py"
+   "name": "python3"
   },
   "language_info": {
    "codemirror_mode": {
@@ -142,7 +157,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.8.15"
+   "version": "3.11.1"
   }
  },
  "nbformat": 4,

examples/data_connectors/GoogleDocsDemo.ipynb

@@ -9,6 +9,20 @@
     "Demonstrates our Google Docs data connector"
    ]
   },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "f6b62adf",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "import logging\n",
+    "import sys\n",
+    "\n",
+    "logging.basicConfig(stream=sys.stdout, level=logging.INFO)\n",
+    "logging.getLogger().addHandler(logging.StreamHandler(stream=sys.stdout))"
+   ]
+  },
   {
    "cell_type": "code",
    "execution_count": null,
@@ -50,7 +64,8 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "response = index.query(\"<query_text>\", verbose=True)"
+    "# set Logging to DEBUG for more detailed outputs\n",
+    "response = index.query(\"<query_text>\")"
    ]
   },
   {
@@ -80,7 +95,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.8.4"
+   "version": "3.11.1"
   }
  },
  "nbformat": 4,

examples/data_connectors/MakeDemo.ipynb

@@ -10,6 +10,20 @@
     "We show how GPT Index can fit with your Make.com workflow by sending the GPT Index response to a scenario webhook."
    ]
   },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "d2289d27",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "import logging\n",
+    "import sys\n",
+    "\n",
+    "logging.basicConfig(stream=sys.stdout, level=logging.INFO)\n",
+    "logging.getLogger().addHandler(logging.StreamHandler(stream=sys.stdout))"
+   ]
+  },
   {
    "cell_type": "code",
    "execution_count": 2,
@@ -39,9 +53,10 @@
    "metadata": {},
    "outputs": [],
    "source": [
+    "# set Logging to DEBUG for more detailed outputs\n",
     "# query index\n",
     "query_str = \"What did the author do growing up?\"\n",
-    "response = index.query(query_str, verbose=True)"
+    "response = index.query(query_str)"
    ]
   },
   {
@@ -63,9 +78,9 @@
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": "gpt_retrieve_venv",
+   "display_name": "Python 3 (ipykernel)",
    "language": "python",
-   "name": "gpt_retrieve_venv"
+   "name": "python3"
   },
   "language_info": {
    "codemirror_mode": {
@@ -77,7 +92,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.9.16"
+   "version": "3.11.1"
   }
  },
  "nbformat": 4,