Fix errors and manage citation

JesperDramsch · Dec 14, 2023 · 2954440 · 2954440
1 parent 1c9c30f
commit 2954440
Show file tree

Hide file tree

Showing 8 changed files with 35 additions and 3 deletions.
diff --git a/CITATION.cff b/CITATION.cff
@@ -0,0 +1,16 @@
+cff-version: 1.2.0
+message: 'If you use this ML.recipes, please cite it as below.'
+authors:
+    - family-names: Dramsch
+      given-names: Jesper Sören
+      orcid: https://orcid.org/0000-0001-8273-905X
+    - family-names: Maggio
+      given-names: Valerio
+      orcid: https://orcid.org/0000-0003-4824-893X
+title: 'ML Recipes – Increase citations, ease review & foster collaboration '
+version: PyData-Global-2022
+identifiers:
+    - type: doi
+      value: ###
+date-released: 2022-12-03
+url: 'https://github.com/JesperDramsch/ml-for-science-reproducibility-tutorial'
diff --git a/book/backmatter/cite.md b/book/backmatter/cite.md
@@ -1,4 +1,13 @@
 # Cite this Work
 
+This book is licensed under the MIT license, but we appreciate a mention!
+
 You can see the contributions to this book in the [Github contributor graph](https://github.com/JesperDramsch/ml-for-science-reproducibility-tutorial/graphs/contributors) and see contributions to events, workshops and talks in the section event section.
 
+You can cite _ML.recipes_ through the Zenodo project archive: ###
+
+The Github page can create citations for you which look something like this for APA:
+
+> Y
+
+Please visit the Github repo and the Zenodo archive for the most up-to-date reference!
diff --git a/book/img/logo.png b/book/img/logo.png
diff --git a/book/img/logo_old.png b/book/img/logo_old.png
diff --git a/book/img/mlrecipes.ico b/book/img/mlrecipes.ico
diff --git a/book/img/mlrecipes_old.ico b/book/img/mlrecipes_old.ico
diff --git a/book/notebooks/4-testing.ipynb b/book/notebooks/4-testing.ipynb
@@ -261,7 +261,7 @@
     "    # Define data you definitely know the answer to\n",
     "    test_data = pd.DataFrame([[34.6, 21.1, 198.0, \"MALE\"],\n",
     "                              [46.1, 18.2, 178.0, \"FEMALE\"],\n",
-    "                              [52.5, 15.6, 221.0, \"MALE\"]], \n",
+    "                              [52.5, 15.6, 221.0, \"MALE\"]],\n",
     "             columns=[\"Culmen Length (mm)\", \"Culmen Depth (mm)\", \"Flipper Length (mm)\", \"Sex\"])\n",
     "    # Define target to the data\n",
     "    test_target = ['Adelie Penguin (Pygoscelis adeliae)',\n",
@@ -351,7 +351,7 @@
     "    -------\n",
     "    pd.DataFrame\n",
     "        Normalised dataframe with shortened names\n",
-    "    \n",
+    "\n",
     "    Examples\n",
     "    --------\n",
     "    >>> shorten_class_name(pd.DataFrame([[1,2,3,\"Adelie Penguin (Pygoscelis adeliae)\"]], columns=[\"1\",\"2\",\"3\",\"Species\"]))\n",
@@ -547,6 +547,13 @@
     "X_train.describe()"
    ]
   },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "The following code is supposed to fail to see what happens if the schema doesn't match!"
+   ]
+  },
   {
    "cell_type": "code",
    "execution_count": 11,

diff --git a/book/notebooks/5-interpretability.ipynb b/book/notebooks/5-interpretability.ipynb
@@ -250,7 +250,7 @@
     }
    ],
    "source": [
-    "from sklearn.inspection import PartialDependenceDisplay, partial_dependence, plot_partial_dependence\n",
+    "from sklearn.inspection import PartialDependenceDisplay, partial_dependence\n",
     "\n",
     "pd_results = partial_dependence(model, X_train.sample(20), num_features)\n",
     "pd_results"