Skip to content

Getting started

OpenPredict is a python package that helps data scientists to build, and publish prediction models in a FAIR and reproducible manner. It provides helpers for various steps of the process:

  • A template to help user quickly bootstrap a new prediction project with the recommended structure (MaastrichtU-IDS/cookiecutter-openpredict-api)
  • Helper function to easily save a generated model, its metadata, and the data used to generate it. It uses tools such as dvc and mlem to store large model outside of the git repository.
  • Deploy API endpoints for retrieving predictions, which comply with the NCATS Biomedical Data Translator standards (Translator Reasoner API and BioLink model), using a decorator @trapi_predict to simply annotate the function that produces predicted associations for a given input entity

Predictions are usually generated from machine learning models (e.g. predict disease treated by drug), but it can adapt to generic python function, as long as the input params and return object follow the expected structure.

Installation

To start a new project to develop and publish models for predictions we recommend to use the cookiecutter template that bootstrap, see the page create a model for more details.

Otherwise the openpredict package can be installed with pip:

pip install openpredict

Acknowledgments​

This service has been built from the fair-workflows/openpredict project. And Predictions of the OpenPredict API made using the PREDICT method.

This service is funded by the NIH NCATS Translator project.

Funded the the NIH NCATS Translator project