Add tutorials, benchmark report, and docs#1
Merged
Conversation
- Add quickstart tutorial showing all metrics on toy data - Add lung atlas tutorial mirroring scib-metrics example - Add benchmark_report.py script for speed + accuracy comparison - Add tutorials.md and update docs index Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
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
1 participant
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.
Summary
docs/notebooks/quickstart.ipynb) demonstrating all scib-rapids metrics on toy datadocs/notebooks/lung_example.ipynb) mirroring scib-metrics' lung example with Harmony, scVI, scANVIscripts/benchmark_report.py) that compares speed and numerical agreement between scib-rapids and scib-metrics across all metricstutorials.md, updatedindex.md)Test plan
python scripts/benchmark_report.pyto verify report outputpytest tests/test_cross_validate.py -vto verify numerical agreementmake htmlin docs/ to verify tutorial rendering🤖 Generated with Claude Code