diff --git a/README.md b/README.md index 35a51b0..a7207e7 100644 --- a/README.md +++ b/README.md @@ -14,27 +14,18 @@ # Leakly: Leakage checks for any machine-learning pipeline -`Leakly` uses label permutation to test whether a machine-learning pipeline +`Leakly` uses label permutation to test whether a machine-learning pipeline performs above chance when no true signal is present. -performs above chance when no true signal is present. - -Above-chance performance after permutation may indicate leakage from - -preprocessing, feature selection, tuning, or another step of the pipeline. +Above-chance performance after permutation may indicate leakage from preprocessing, feature selection, tuning, or another step of the pipeline. ## How it works 1. Permute labels to remove the real feature-label association. - 2. Run the full pipeline exactly as in the original analysis. - 3. Compare the permuted score distribution with chance level. - 4. Above-chance permuted performance suggests possible leakage. -`Leakly` includes example configurations for a leaky pipeline and a non-leaky - -pipeline so users can inspect the effect directly. +`Leakly` includes example configurations for a leaky pipeline and a non-leaky pipeline so users can inspect the effect directly. ![Example permutation AUC summary](https://raw.githubusercontent.com/DeMONLab-BioFINDER/Leakly/main/assets/AUC.png) @@ -44,20 +35,6 @@ pipeline so users can inspect the effect directly. pip install Leakly ``` -For notebook environments that need the optional notebook dependencies: - -```bash -pip install "Leakly[notebook]" -``` - -For the current GitHub checkout: - -```bash -git clone https://github.com/DeMONLab-BioFINDER/Leakly.git -cd Leakly -pip install -e . -``` - ## Quick Start on Colab: Open example.ipynb in Colab ### Key Python snippet diff --git a/leakly/__init__.py b/leakly/__init__.py index 54a2651..7a45664 100644 --- a/leakly/__init__.py +++ b/leakly/__init__.py @@ -34,7 +34,7 @@ from .simulation import SimulatedDataset, simulate_dataset from .summary import SummaryPlotter -__version__ = "0.1.1" +__version__ = "0.1.2" __all__ = [ "__version__",