PhageAI is an AI-driven software platform using advanced Machine Learning and Natural Language Processing techniques for deeper understanding of the bacteriophages genomics.
Project description
PhageAI is an AI-driven software platform using advanced Machine Learning and Natural Language Processing techniques for deeper understanding of the bacteriophages genomics.
Table of Contents
Framework modules | Documentation | Installation | Community and Contributions | Have a question? | Found a bug? | Team | Change log | License | Cite
Framework modules
lifecycle
- set of methods related with bacteriophage lifecycle research (exploration, prediction);
taxonomy
- set of methods related with bacteriophage taxonomy research (TBA);
repository
- set of methods related with PhageAI bacteriophage repository (TBA);
Documentation
The official technical documentation is hosted on ReadTheDocs: https://phageai.readthedocs.io
Installation and usage
PhageAI user account (1/3)
Create a free user account in the PhageAI web platform or use an existing one. If you had to create new one, activate your account by activation link which was sent on your mail inbox. After that, log into the platform successfully and click "My profile" on menu (left sidebar). From the "API access" section copy the access token (string) and keep it for the steps below.
PhageAI package (2/3)
PhageAI requires Python 3.8.0+ to run and can be installed by running:
pip install phageai
Alternatively, you also can use the Conda ecosystem:
conda install -c conda-forge phageai
If you can't wait for the latest hotness from the develop branch, then install it directly from the repository:
pip install git+git://github.com/ProteonPharmaceuticals/phageai.git@develop
PhageAI execution (3/3)
from phageai.lifecycle.classifier import LifeCycleClassifier
lcc = LifeCycleClassifier(access_token='<PASTE_YOUR_ACCESS_TOKEN_HERE>')
lcc.predict(fasta_path='<PASTE_YOUR_FASTA_PATH_HERE>')
Expected output for MG945357.fasta
bacateriophage sample:
{
"model_class_label": "Virulent",
"prediction_accuracy": "98.94",
"gc": "39.47",
"sequence_length": 4915
}
We shared numerous examples of using the framework in Jupyter Notebook format (*.ipynb).
Community and Contributions
Happy to see you willing to make the PhageAI better. Development on the latest stable version of Python 3+ is preferred. As of this writing it's 3.8. You can use any operating system.
If you're fixing a bug or adding a new feature, add a test with pytest and check the code with Black and mypy. Before adding any large feature, first open an issue for us to discuss the idea with the core devs and community.
Have a question?
Obviously if you have a private question or want to cooperate with us, you can always reach out to us directly by mail.
Found a bug?
Feel free to add a new issue with a respective title and description on the the PhageAI repository. If you already found a solution to your problem, we would be happy to review your pull request.
Team
Core Developers and Domain Experts who contributing to PhageAI:
- Piotr Tynecki
- Joanna Kazimierczak
- Arkadiusz Guziński
- Bogusław Zimnoch
Change log
The log's will become rather long. It moved to its own file.
See CHANGELOG.md.
License
The PhageAI package is released under the under terms of the MIT License.
Cite
PhageAI - Bacteriophage Life Cycle Recognition with Machine Learning and Natural Language Processing
Tynecki, P.; Guziński, A.; Kazimierczak, J.; Jadczuk, M.; Dastych, J.; Onisko, A.
Bioinformatics 2020, DOI: 10.1101/2020.07.11.198606
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.