Exomiser ML
Exomiser-ML is a Python-based machine learning pipeline designed to enhance variant prioritisation by integrating various Exomiser scores. It supports classification using Logistic Regression, Random Forest, and XGBoost, and includes utilities for feature extraction, data splitting, model training, and post-processing.
🚀 Features
- Extracts features from Exomiser variant TSV result files and Phenopackets.
- Supports multiple classifiers: Logistic Regression, Random Forest, and XGBoost.
- Provides CLI commands for training, and full pipeline execution.
- Generates metadata and post-processed results compatible with PhEval for benchmarking.
📦 Installation
Ensure you have Python 3.12 or higher installed.
pip install exomiser-ml
🧪 Usage
The package provides several CLI commands:
- run-model
Trains and evaluates a model using provided training data and test directory.
run-model \
--training-data path/to/train.tsv \
--test-dir path/to/test_dir \
--features FEATURE1 FEATURE2 ... \
--output-dir path/to/output \
--phenopacket-dir path/to/phenopackets \
--model MODEL_TYPE
Parameters:
- --training-data: Path to the training data TSV file.
- --test-dir: Directory containing test data files.
- --features: List of features to extract.
- --output-dir: Directory to save outputs.
- --phenopacket-dir: Directory containing Phenopacket JSON files.
- --model: Model type to use. Choices: LOGISTIC_REGRESSION, RANDOM_FOREST, XGBOOST_CLASSIFIER
- run-pipeline
Executes the full pipeline: feature extraction, data splitting, training, evaluation, and post-processing.
run-pipeline \
--phenopacket-dir path/to/phenopackets \
--result-dir path/to/exomiser_results \
--output-dir path/to/output \
--features FEATURE1 FEATURE2 ... \
--test-size 0.2 \
--model MODEL_TYPE
Parameters:
- --phenopacket-dir: Directory containing Phenopacket JSON files.
- --result-dir: Directory containing Exomiser result TSV files.
- --output-dir: Directory to save outputs.
- --features: List of features to extract.
- --test-size: Proportion of data to use for testing (e.g., 0.2 for 20%).
- --model: Model type to use. Choices: LOGISTIC_REGRESSION, RANDOM_FOREST, XGBOOST_CLASSIFIER.
- add-features
Adds features to Exomiser results.
add-features \
--phenopacket-dir path/to/phenopackets \
--result-dir path/to/exomiser_results \
--output-dir path/to/output
- split-data
Splits data (Exomiser TSV results) into training and testing sets.
split-data \
--input-dir path/to/input_data \
--test-size 0.2 \
--output-dir path/to/output
- post-process
Post-processes test results for downstream benchmarking with PhEval.
post-process \
--test-dir path/to/test_results \
--phenopacket-dir path/to/phenopackets \
--output-dir path/to/output \
--score NEW_SCORE
Metadata
Release files for exomiser-ml 0.1.18
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| exomiser_ml-0.1.18.tar.gz | 13.2 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| exomiser_ml-0.1.18-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 30.5 kB
Release files / exomiser_ml-0.1.18.tar.gz
| Download URL | exomiser_ml-0.1.18.tar.gz |
|---|---|
| Size | 13.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
82b842048ac2fce4f98c1ea5cc5cb3199555fdab617ac8666efbeb6e97b2c090
|
|
BLAKE2b-256 checksum How to use checksums |
1b1826720760d882d8bf0cfe74f374e3c9ee8c73c3ca5532d6c3a205b8583260
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.12.23 {"installer":{"name":"uv","version":"0.12.23","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
Release files / exomiser_ml-0.1.18-py3-none-any.whl
| Download URL | exomiser_ml-0.1.18-py3-none-any.whl |
|---|---|
| Size | 17.2 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
0215e8bc58b51b955c407c148a95dd1b784c595a8dda5efee817d6dc19422067
|
|
BLAKE2b-256 checksum How to use checksums |
7cf57e452ccf252d379f6f4031a7de3483a7e23c0e23a22b8ae19c0098310cd3
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.12.23 {"installer":{"name":"uv","version":"0.12.23","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|