doc(use-cases): add Use Cases guide + UC1 γ-secretase reproduction#277
Merged
Conversation
Introduce "Use Cases" as a third subchapter under the GUIDES nav (alongside Tutorials and Protocols): a use case reproduces a published study end to end from bundled data only. First use case (use_case1_gamma_secretase) reproduces the key results of Breimann et al., "Charting gamma-secretase substrates by explainable AI", Nat. Commun. 16, 5428 (2025) on the bundled DOM_GSEC set (63 substrates + 63 non-substrates): the CPP signature (feature map + profile, cf. Fig. 2b/2c) and the CPP-vs-scale-based benchmark (~85% vs ~75% balanced accuracy, cf. Fig. 3a), with the cleavage-region / conformational feature breakdown the paper reports. Wire the new use_cases/ notebook folder into the docs: export_use_case_ notebooks_to_rst() (conf.py + create_notebooks_docs.py), a use_cases.rst toctree, the GUIDES caption, the landing-page routing line (was "coming soon"), and a release note. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
breimanntools
commented
Jun 26, 2026
breimanntools
left a comment
Owner
Author
There was a problem hiding this comment.
Not sure how good the notebook will be. I check it after it is pusehd
Review follow-up: three docs pages enumerated the guide pillars (Tutorials/Protocols) but omitted the new Use Cases subchapter — the Introduction guides overview, the Getting Started dev note, and the prediction-tasks "Where to go next". Add Use Cases to each for nav consistency. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #277 +/- ##
==========================================
+ Coverage 96.13% 96.16% +0.03%
==========================================
Files 176 176
Lines 16827 16856 +29
Branches 2877 2882 +5
==========================================
+ Hits 16176 16210 +34
+ Misses 366 359 -7
- Partials 285 287 +2 see 3 files with indirect coverage changes
🚀 New features to boost your workflow:
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Introduces Use Cases as a third subchapter under the GUIDES nav (alongside Tutorials and Protocols) and ships the first one. A use case reproduces a published study end to end from bundled data only — distinct from Tutorials (one tool) and Protocols (one minimal-code workflow).
Note on nav placement: issue #109's original text says "Examples umbrella caption", but the live nav uses the GUIDES caption (Tutorials · Protocols), so per direction this lands as GUIDES → Use Cases. Same
use_cases/folder +create_notebooks_docs.pywiring the issue specifies.First use case —
use_case1_gamma_secretase.ipynbReproduces the key results of Breimann et al., Charting γ-secretase substrates by explainable AI, Nat. Commun. 16, 5428 (2025) — the paper AAanalysis was built to support — on the bundled, balanced
DOM_GSECset (63 substrates + 63 non-substrates), no downloads:TMD_C_JMD_Ccleavage region, Conformation dominant (matches the paper's biology).Wiring
export_use_case_notebooks_to_rst()increate_notebooks_docs.py+ call inconf.pydocs/source/use_cases.rsttoctree; added to the GUIDES caption inindex.rstLocal gates
pytest --nbmakeon the notebook: 1 passedcd docs && make html:use_cases.html+ RST + 3 figures render, zero net-new Sphinx warningsScope
Docs-only; no public API change. Advances #109 (does not close it — the first milestone also wants one case per prediction level; this delivers the infrastructure + the γ-secretase flagship). Part of epic #106.