Skip to main content

ML-based predictors for CCS, retention time, and fragment intensity in mass spectrometry.

Project description

imspy-predictors

ML-based predictors for CCS, retention time, and fragment intensity in mass spectrometry.

Installation

pip install imspy-predictors

For remote model access via Koina servers:

pip install imspy-predictors[koina]

Features

  • CCS Prediction: Deep learning models for collision cross section / ion mobility prediction
  • Retention Time Prediction: GRU-based retention time predictors
  • Fragment Intensity Prediction: Prosit 2023 timsTOF intensity predictor
  • Charge State Prediction: Binomial and deep learning charge state distribution models
  • Koina Integration: Access remote prediction models via Koina servers (optional)

Available Koina Remote Models

When using pip install imspy-predictors[koina], remote models can be configured in TimSim's [models] TOML section:

Task Model Name
RT Deeplc_hela_hf, Chronologer_RT, AlphaPeptDeep_rt_generic, Prosit_2019_irt
CCS AlphaPeptDeep_ccs_generic, IM2Deep
Intensity prosit, alphapeptdeep, ms2pip
[models]
rt_model = "AlphaPeptDeep_rt_generic"
ccs_model = ""                          # "" = local PyTorch model
intensity_model = "prosit"

Quick Start

from imspy_predictors import (
    load_deep_ccs_predictor,
    load_deep_retention_time_predictor,
    Prosit2023TimsTofWrapper,
)

# Load CCS predictor
ccs_model = load_deep_ccs_predictor()

# Load RT predictor
rt_model = load_deep_retention_time_predictor()

# Load intensity predictor
intensity_model = Prosit2023TimsTofWrapper()

Submodules

  • ccs/: CCS / ion mobility prediction
  • rt/: Retention time prediction
  • intensity/: Fragment intensity prediction (Prosit)
  • ionization/: Charge state distribution prediction
  • koina_models/: Koina remote model access (requires koinapy)
  • utilities/: Tokenizers for ML models

Dependencies

  • imspy-core: Core data structures (required)
  • PyTorch: Deep learning framework (required)
  • koinapy: Koina API client (optional, for remote models)

Optional Dependencies

Some functionality requires additional packages:

  • imspy-search: For PSM-based predictions using sagepy
  • imspy-simulation: For simulation utilities (e.g., flatten_prosit_array)

Related Packages

  • imspy-core: Core data structures and timsTOF readers
  • imspy-search: Database search functionality
  • imspy-simulation: Simulation tools for timsTOF data
  • imspy-vis: Visualization tools

License

MIT License - see LICENSE file for details.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

imspy_predictors-0.5.1.tar.gz (85.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

imspy_predictors-0.5.1-py3-none-any.whl (100.4 kB view details)

Uploaded Python 3

File details

Details for the file imspy_predictors-0.5.1.tar.gz.

File metadata

  • Download URL: imspy_predictors-0.5.1.tar.gz
  • Upload date:
  • Size: 85.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.14

File hashes

Hashes for imspy_predictors-0.5.1.tar.gz
Algorithm Hash digest
SHA256 58d4ce0baf1a46b95e052e7aeb997036f78c85b959ad54a5dc7d41624c8a619c
MD5 f2c68eb904e21959dd0ce51f45ab6798
BLAKE2b-256 c9cd5f8afd82aed3f198fed6e210ea8abe7fdfe645c2d293adbb76301f5c6bdc

See more details on using hashes here.

File details

Details for the file imspy_predictors-0.5.1-py3-none-any.whl.

File metadata

File hashes

Hashes for imspy_predictors-0.5.1-py3-none-any.whl
Algorithm Hash digest
SHA256 27a2422b139e4ba7bb045dcd7cedfc8cf80a09246825d68630f307da613f3e66
MD5 94055fd7b6192570fe26835e59a4f89a
BLAKE2b-256 140bba3394f07f0cc8e25c9c4572849da8fbe8b1ae50cbe65edb622d24406e45

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page