Add notebooks (#22)

Co-authored-by: lmartinfuertes <[email protected]>
paradigmadigital · Mar 25, 2024 · cf415c9 · cf415c9
1 parent fdb936f
commit cf415c9
Show file tree

Hide file tree

Showing 9 changed files with 20 additions and 6 deletions.
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -24,6 +24,7 @@
     'sphinx.ext.autodoc',
     'sphinx.ext.autosummary',
     'sphinx.ext.napoleon',
+    'nbsphinx',
 ]
 
 templates_path = ['_templates']

diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -22,3 +22,14 @@ Promptmeteo is a Python library for prompt engineering built over LangChain. It
    :caption: Classes
 
    classes
+
+
+.. toctree::
+   :maxdepth: 1
+   :caption: Example notebooks
+
+   notebooks/01_promptmeteo_usage
+   notebooks/03_sentiment_analysis.ipynb
+   notebooks/04_test_flant5_classification_prompts.ipynb
+   notebooks/05_test_openai_classification_prompts.ipynb
+   notebooks/06_test_openai_api-generation.ipynb
diff --git a/examples/01_promptmeteo_usage.ipynb → ...urce/notebooks/01_promptmeteo_usage.ipynb b/examples/01_promptmeteo_usage.ipynb → ...urce/notebooks/01_promptmeteo_usage.ipynb
@@ -5,7 +5,7 @@
    "id": "b559000b-5af7-49ed-8e0a-c9c4765167f0",
    "metadata": {},
    "source": [
-    "# Promptmteo Usage - Save and Load Model"
+    "# Promptmeteo Usage - Save and Load Model"
    ]
   },
   {

diff --git a/examples/02_model_tuning.ipynb → docs/source/notebooks/02_model_tuning.ipynb b/examples/02_model_tuning.ipynb → docs/source/notebooks/02_model_tuning.ipynb
@@ -5,7 +5,7 @@
    "id": "9c5befb6-f95f-45f7-872d-6d5d62370880",
    "metadata": {},
    "source": [
-    "# Model tuning - Promptmeteo configuration"
+    "# Model Tuning - Promptmeteo Configuration"
    ]
   }
  ],

diff --git a/examples/03_sentiment_analysis.ipynb → ...rce/notebooks/03_sentiment_analysis.ipynb b/examples/03_sentiment_analysis.ipynb → ...rce/notebooks/03_sentiment_analysis.ipynb
@@ -5,7 +5,7 @@
    "id": "73d808a5-a4dd-4ec5-b4bc-438f1dd5596f",
    "metadata": {},
    "source": [
-    "# Sentiment analysis."
+    "# Sentiment Analysis"
    ]
   },
   {

diff --git a/..._test_flant5_classification_prompts.ipynb → ..._test_flant5_classification_prompts.ipynb b/..._test_flant5_classification_prompts.ipynb → ..._test_flant5_classification_prompts.ipynb
@@ -5,7 +5,7 @@
    "id": "73d808a5-a4dd-4ec5-b4bc-438f1dd5596f",
    "metadata": {},
    "source": [
-    "# Flan-t5-Small Test classification prompts."
+    "# Flan-t5-Small - Test Classification Prompts"
    ]
   },
   {

diff --git a/..._test_openai_classification_prompts.ipynb → ..._test_openai_classification_prompts.ipynb b/..._test_openai_classification_prompts.ipynb → ..._test_openai_classification_prompts.ipynb
@@ -5,7 +5,7 @@
    "id": "73d808a5-a4dd-4ec5-b4bc-438f1dd5596f",
    "metadata": {},
    "source": [
-    "# OpenAI test classification prompts."
+    "# OpenAI - Test Classification Prompts"
    ]
   },
   {

diff --git a/examples/06_test_openai_api-generation.ipynb → ...books/06_test_openai_api-generation.ipynb b/examples/06_test_openai_api-generation.ipynb → ...books/06_test_openai_api-generation.ipynb
@@ -5,7 +5,7 @@
    "id": "73d808a5-a4dd-4ec5-b4bc-438f1dd5596f",
    "metadata": {},
    "source": [
-    "# OpenAI test API generation."
+    "# OpenAI - Test API Generation"
    ]
   },
   {

diff --git a/pyproject.toml b/pyproject.toml
@@ -57,6 +57,8 @@ docs = [
     "furo==2024.1.29",
     "numpydoc==1.6.0",
     "sphinxcontrib-napoleon==0.7",
+    "pandoc==2.3",
+    "nbsphinx==0.9.3",
 ]
 openai = [
     "openai==0.27.8",