Skip to content

kipoi/kipoi-interpret

Repository files navigation

kipoi_interpret

Model interepretation plugin for Kipoi.

CircleCI Coverage status

Warning

Kipoi Project - Sunset Announcement

After several impactful years, we have made the decision to archive the Kipoi repositories and end active maintenance of the project.

This is a bittersweet moment. While it’s always a little sad to sunset a project, the field of machine learning in genomics has evolved rapidly, with new technologies and platforms emerging that better meet current needs. Kipoi played an important role in its time, helping researchers share, reuse, and benchmark trained models in regulatory genomics. We’re proud of what it accomplished and grateful for the strong community support that made it possible.

Kipoi’s impact continues, however:

  • The Kipoi webinar series will carry on, supporting discussions around model reuse and interpretability.
  • Kipoiseq, our standard set of data-loaders for sequence-based modeling, also remains active and relevant.

Thanks to everyone who contributed, used, or supported Kipoi. It’s been a fantastic journey, and we're glad the project helped shape how models are shared in the field.

- The Kipoi Team

Installation

pip install kipoi_interpret

Usage example

# list all available methods
kipoi_interpret.importance_scores.available_methods()

Available methods:

# Gradient-based methods
from kipoi_interpret.importance_scores.gradient import Gradient, GradientXInput
# In-silico mutagenesis-based methods
from kipoi_interpret.importance_scores.ism import Mutation
# DeepLift
from kipoi_interpret.importance_scores.referencebased import DeepLift

Gradient * input example

# seqa = one-hot-encoded DNA sequence
import kipoi
model = kipoi.get_model("<my-model>")
ginp = GradientXInput(model)
val = ginp.score(batch_input)  # val is an array of importance scores

See notebooks/1-DNA-seq-model-example.ipynb for an example.

Release History

  • 0.1.0
    • First release to PyPI

About

Model interpretation plugin for Kipoi

Resources

License

Contributing

Stars

Watchers

Forks

Packages

 
 
 

Contributors