docs: tweak readme

shizhediao · Mar 30, 2020 · 36e94b4 · 36e94b4
1 parent d8d8cca
commit 36e94b4
Show file tree

Hide file tree

Showing 2 changed files with 30 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -42,11 +42,11 @@ If you want to run the examples in the repository a few additional libraries are
 
 ### Jupyter notebooks
 
-If you run the Jupyter notebooks you might need to run the following:
+If you run Jupyter notebooks you might need to run the following:
 
 `jupyter nbextension enable --py --sys-prefix widgetsnbextension`
 
-For Jupyterlab run this in addition:
+For Jupyterlab additionally this command:
 
 `jupyter labextension install @jupyter-widgets/jupyterlab-manager`
 
@@ -96,6 +96,17 @@ For a detailed example check out the notebook *Tune GPT2 to generate positive re
 </div>
 
 
+## Notebooks
+This library is built with `nbdev` and as such all the library code as well as examples are in Jupyter notebooks. The following list gives an overview:
+
+- `index.ipynb`: Generates the README and the overview page.
+- `00-core.ipynb`: Contains the utility functions used throughout the library and examples.
+- `01-gpt2-with-value-head.ipynb`: Implementation of a `transformer` compatible GPT2 model with an additional value head as well as a function to generate sequences.
+- `02-ppo.ipynb`: Implementation of the PPOTrainer used to train language models.
+- `03-bert-imdb-training.ipynb`: Training of BERT with `simpletransformers` to classify sentiment on the IMDB dataset.
+- `04-gpt2-sentiment-ppo-training.ipynb`: Fine-tune GPT2 with the BERT sentiment classifier to produce positive movie reviews.
+
+
 ## Reference
 
 ### Proximal Policy Optimisation

diff --git a/nbs/index.ipynb b/nbs/index.ipynb
@@ -68,11 +68,11 @@
     "\n",
     "### Jupyter notebooks\n",
     "\n",
-    "If you run the Jupyter notebooks you might need to run the following:\n",
+    "If you run Jupyter notebooks you might need to run the following:\n",
     "\n",
     "`jupyter nbextension enable --py --sys-prefix widgetsnbextension`\n",
     "\n",
-    "For Jupyterlab run this in addition:\n",
+    "For Jupyterlab additionally this command:\n",
     "\n",
     "`jupyter labextension install @jupyter-widgets/jupyterlab-manager`"
    ]
@@ -142,6 +142,21 @@
     "</div>\n"
    ]
   },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Notebooks\n",
+    "This library is built with `nbdev` and as such all the library code as well as examples are in Jupyter notebooks. The following list gives an overview:\n",
+    "\n",
+    "- `index.ipynb`: Generates the README and the overview page.\n",
+    "- `00-core.ipynb`: Contains the utility functions used throughout the library and examples.\n",
+    "- `01-gpt2-with-value-head.ipynb`: Implementation of a `transformer` compatible GPT2 model with an additional value head as well as a function to generate sequences.\n",
+    "- `02-ppo.ipynb`: Implementation of the PPOTrainer used to train language models.\n",
+    "- `03-bert-imdb-training.ipynb`: Training of BERT with `simpletransformers` to classify sentiment on the IMDB dataset.\n",
+    "- `04-gpt2-sentiment-ppo-training.ipynb`: Fine-tune GPT2 with the BERT sentiment classifier to produce positive movie reviews.\n"
+   ]
+  },
   {
    "cell_type": "markdown",
    "metadata": {},