Code Monkey home page Code Monkey logo

ersilia_fork's Introduction

Welcome to the Ersilia Model Hub!

Donate Contributor Covenant License: AGPL v3 DOI

documentation PyPI version fury.io Python 3.7 Code style: black Gitpod Ready-to-Code

Table of Contents

  1. Project Description
  2. Quick start guide
  3. Contribute
  4. License and citation
  5. About us

Project Description

The Ersilia Model Hub is a unified platform of pre-trained AI/ML models for infectious and neglected disease research. The end goal is to provide an open-source, no-code solution to access AI/ML models to accelerate drug discovery. The models embedded in the hub include both models published in the literature (with appropriate third party acknowledgement) and models developed by the Ersilia team or contributors.

Quick Start Guide

Please check the package requirements in the Installation Guide. The next steps are a quickstart guide to installing Ersilia.

  1. Create a conda environment and activate it

    conda create -n ersilia python=3.7
    conda activate ersilia
  2. Clone this repository and install with pip

    git clone https://github.com/ersilia-os/ersilia.git
    cd ersilia
    pip install -e .
  3. Once the Ersilia Model Hub is installed, you can use the CLI to run predictions. First, select a model from the Ersilia Model Hub and fetch it:

    ersilia fetch retrosynthetic-accessibility
  4. Generate a few (5) example molecules, to be used as input. The example command will generate the adequate input for the model in use

    ersilia example retrosynthetic-accessibility -n 5 -f my_molecules.csv
  5. Then, serve your model:

    ersilia serve chemprop-antibiotic
  6. And run the prediction API:

    ersilia api -i my_molecules.csv -o my_predictions.csv
  7. Finally, close the service when you are done.

    ersilia close

Please see the Ersilia Book for more examples and detailed explanations.

Contribute

The Ersilia Model Hub is a Free, Open Source Software and we highly value new contributors. There are several ways in which you can contribute to the project:

  • A good place to start is checking open issues.
  • If you have identified a bug in the code, please open a new issue using the bug template.
  • Share any feedback with the community using GitHub Discussions for the project
  • Check our Contributing Guide for more details

The Ersilia Open Source Initiative adheres to the Contributor Covenant code of conduct.

Submit a New Model

If you want to incorporate a new model in the platform, open a new issue using the model request template or contact us using the following form

After submitting your model request via an issue (suggested), a maintainer will review your request. If they /approve your request, a new model respository will be created for you to fork and use!

License and Citation

This repository is open-sourced under the GPL-3 License. Please cite us if you use it.

About Us

The Ersilia Open Source Initiative is a Non Profit Organization (1192266) with the mission is to equip labs, universities and clinics in LMIC with AI/ML tools for infectious disease research.

Help us achieve our mission or volunteer with us!

ersilia_fork's People

Contributors

miquelduranfrigola avatar gemmaturon avatar grantbirki avatar jaya3112 avatar amna-28 avatar honeyankit avatar harshita214 avatar dependabot[bot] avatar ps-19 avatar megamanics avatar sukriti-sood avatar pauline-banye avatar anshukumari197 avatar dchidindu5 avatar anamika-yadav99 avatar adeola-dev avatar kbetty avatar med16-11 avatar rufaida98 avatar kcfreshly avatar lehcar avatar elizabeth-joseph-mawutin avatar ifeoluwafavour avatar riyabelle25 avatar sayantani11 avatar martwebber avatar victorabba avatar loweyvana avatar dauinh avatar busiratbolanle avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.