Skip to main content

Linux builds on Actions codecov Documentation Status PyPI version Anaconda-Server Badge PyPI - Python Version

DeepNOG: protein orthologous groups assignment

Assign proteins to orthologous groups (eggNOG 5) on CPUs or GPUs with deep networks. DeepNOG is much faster than alignment-based methods, providing accuracy similar to HMMER.

Installation guide

The easiest way to install DeepNOG is to obtain it from PyPI:

pip install deepnog

Alternatively, you can clone or download bleeding edge versions from GitHub and run

pip install /path/to/DeepNOG

If you plan to extend DeepNOG as a developer, run

pip install -e /path/to/DeepNOG

instead.

deepnog can also be installed from bioconda like this:

conda install deepnog

Usage

Call the deepnog command line tool with a protein sequence file in FASTA format. Example usages:

  • deepnog infer proteins.faa
    • Predicted groups of proteins in proteins.faa will be written to the console. By default, eggNOG5 bacteria level is used.
  • deepnog infer proteins.faa --out prediction.csv
    • Write into prediction.csv instead
  • deepnog infer proteins.faa -db eggNOG5 -t 1236 -V 3 -c 0.99
    • Predict EggNOG5 Gammaproteobacteria (tax 1236) groups
    • discard individual predictions below 99 % confidence
    • Show detailed progress report (-V 3)
  • deepnog train train.fa val.fa train.csv val.csv -a deepnog -e 15 --shuffle -r 123 -db eggNOG5 -t 3 -o /path/to/outdir
    • Train a model for the (hypothetical) tax level 3 of eggNOG5 with a fixed random seed for reproducible results.

The individual models for OG predictions are not stored on GitHub or PyPI, because they exceed file size limitations (up to 200M). deepnog automatically downloads the models, and puts them into a cache directory (default ~/deepnog_data/). You can change this directory by setting the DEEPNOG_DATA environment variable.

For help and advanced options, call deepnog --help, and deepnog infer --help or deepnog train --help for specific options for inference or training, respectively. See also the user & developer guide.

File formats supported

Preferred: FASTA (raw, .gz, or .xz)

DeepNOG supports protein sequences stored in all file formats listed in https://biopython.org/wiki/SeqIO, but is tested for the FASTA-file format only.

Databases currently supported

  • eggNOG 5.0
    • taxonomic level 1 (root level)
    • taxonomic level 2 (bacteria level)
    • For >100 additional eggNOG 5.0 levels, consult the docs.
  • COG 2020
  • (for additional databases/levels, please create an issue on Github, or train a model yourself---new in v1.2)

Deep network architectures currently supported

  • DeepNOG
  • DeepFam (no precomputed model currently available)

Required packages

deepnog builds upon the following packages:

  • PyTorch
  • NumPy
  • pandas
  • scikit-learn
  • tensorboard
  • Biopython
  • PyYAML
  • tqdm
  • pytest (for tests only)

See also requirements/*.txt for platform-specific recommendations (sometimes, specific versions might be required due to platform-specific bugs in the deepnog requirements)

Acknowledgements

This research is supported by the Austrian Science Fund (FWF): P27703, P31988; and by the GPU grant program of Nvidia corporation.

Citation

If you use DeepNOG, please consider citing our research article (click here for bibtex):

Roman Feldbauer, Lukas Gosch, Lukas Lüftinger, Patrick Hyden, Arthur Flexer, Thomas Rattei, DeepNOG: Fast and accurate protein orthologous group assignment, Bioinformatics, 2020, btaa1051, https://doi.org/10.1093/bioinformatics/btaa1051

Metadata

Release files for deepnog 1.2.4

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for deepnog 1.2.4
File Size Uploaded Provenance
deepnog-1.2.4.tar.gz 41.6 kB Without provenance Details

Built distribution (wheel)

Table of built distributions (wheels) for deepnog 1.2.4
File Interpreter ABI Platform
deepnog-1.2.4-py3-none-any.whl Python 3 none any Details

Total release size: 90.1 kB

Release files / deepnog-1.2.4.tar.gz

Download URL deepnog-1.2.4.tar.gz
Size 41.6 kB
Tags Source
SHA-256 checksum
How to use checksums
24c754c9d36d91b8dae91cb38f5d90ea68db4a25e0a3aef12c59813f28cdd3a2
BLAKE2b-256 checksum
How to use checksums
310cce20a79198b733a911e8ff1ff3b64a5080f31ce3b44f27be18c564e8ed8b
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.9.13 {"installer":{"name":"uv","version":"0.9.13"},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

Release files / deepnog-1.2.4-py3-none-any.whl

Download URL deepnog-1.2.4-py3-none-any.whl
Size 48.5 kB
Tags Python 3
SHA-256 checksum
How to use checksums
665ff5942a5d5cc7d3fc7b75bbd23759aee902dce53499f64095a54685a2bd77
BLAKE2b-256 checksum
How to use checksums
81fda32df7e13e140a89f2bd11569b0377432b0702882017f357f5be63437835
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.9.13 {"installer":{"name":"uv","version":"0.9.13"},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

Security for deepnog 1.2.4

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page