warnings notebook added

pni-lab · Jan 20, 2025 · c7bc0c8 · c7bc0c8
1 parent aeba924
commit c7bc0c8
Show file tree

Hide file tree

Showing 4 changed files with 232 additions and 3 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,4 +1,5 @@
 .idea/
+.vscode/
 manuscript/_build/
 manuscript/exports/
 **/.DS_Store

diff --git a/README.md b/README.md
@@ -18,7 +18,9 @@ models.
     stop = res.estimated_stop
 
 This prints out the results and plots the learning and power curves.
-An extended, working example can be found in ["our example notebook"](notebooks/example.ipynb)
+
+- An extended, working example can be found in ["our example notebook"](notebooks/example.ipynb)
+- A description of possible warnings frequently encountered during runtime can be found in ["our warnings notebook"](notebooks/warnings.ipynb)
 
 ## Documentation
 The package documentation is available [here](https://pni-lab.github.io/adaptivesplit/).

diff --git a/notebooks/example.ipynb b/notebooks/example.ipynb
@@ -68,7 +68,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 3,
+   "execution_count": 4,
    "id": "b624c5e52506fe96",
    "metadata": {
     "ExecuteTime": {
@@ -82,7 +82,7 @@
      "name": "stderr",
      "output_type": "stream",
      "text": [
-      "Calculating learning curve: 100%|██████████| 1200/1200 [00:26<00:00, 45.85it/s]\n",
+      "Calculating learning curve: 100%|██████████| 1200/1200 [00:22<00:00, 53.68it/s]\n",
       "  0% (0 of 5) |                          | Elapsed Time: 0:00:00 ETA:  --:--:--\n",
       "100% (5 of 5) |##########################| Elapsed Time: 0:00:00 Time:  0:00:00\n",
       "  0% (0 of 5) |                          | Elapsed Time: 0:00:00 ETA:  --:--:--\n",

diff --git a/notebooks/warnings.ipynb b/notebooks/warnings.ipynb