diff --git a/README.md b/README.md index f2ed978e..cab2c9b7 100644 --- a/README.md +++ b/README.md @@ -10,11 +10,6 @@ Modular and user-friendly platform for AI-assisted rescoring of peptide identifications -> ⚠️ Note: This is the documentation for the fully redeveloped version 3.0 of MS²Rescore. While -> MS²Rescore 3.0 has been drastically improved over the previous version, you might run into some -> unforeseen issues. Please report any issues you encounter on the [issue tracker][issues] or post -> your questions on the [GitHub Discussions][discussions] forum. - ## About MS²Rescore MS²Rescore performs ultra-sensitive peptide identification rescoring with LC-MS predictors such as diff --git a/docs/source/_static/img/ms2rescore-overview.png b/docs/source/_static/img/ms2rescore-overview.png index d4a4001d..2e7eb061 100644 Binary files a/docs/source/_static/img/ms2rescore-overview.png and b/docs/source/_static/img/ms2rescore-overview.png differ diff --git a/docs/source/tutorials/in-depth-python-api.ipynb b/docs/source/tutorials/in-depth-python-api.ipynb index 502c7d06..05565d27 100644 --- a/docs/source/tutorials/in-depth-python-api.ipynb +++ b/docs/source/tutorials/in-depth-python-api.ipynb @@ -7,6 +7,18 @@ "# Using the Python API " ] }, + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "This tutorial shows how to use the MS²Rescore Python API for each step of the rescoring process\n", + "individually. This is useful if you want to customize rescoring for your own Python\n", + "workflow or if you want to understand how MS²Rescore works.\n", + "\n", + "Note that the full MS²Rescore workflow is also available from Python with the single function call\n", + "`ms2rescore.rescore()`." + ] + }, { "cell_type": "code", "execution_count": 1,