Skip to main content

A performant and user-friendly reimplementation of UniRep in JAX.

Project description

Build Status codecov Code style: black

jax-unirep

A performant reimplementation of the UniRep protein featurization model in JAX.

The UniRep model was developed in George Church's lab, see the original publication here (bioRxiv) or here (Nature Methods), as well as the repository containing the original model.

This repo is a self-contained version of the UniRep model (so far only the 1900 hidden-unit mLSTM), with additional utility APIs that support protein engineering workflows.

Installation

Ensure that your compute environment allows you to run JAX code. (A modern Linux or macOS with a GLIBC>=2.23 is probably necessary.)

Then, you can install from PyPI:

pip install jax-unirep

If you want the latest and greatest, you can install directly from source:

pip install git+https://github.com/ElArkk/jax-unirep.git

More Details

Documentation on how to use jax-unirep is available here.

We highly encourage community contributions to this project! For more information, see the section in the docs on our contributing guidelines.

To read more about how we reimplemented the model in JAX, check out our preprint on bioarxiv.

License

All the model weights are licensed under the terms of Creative Commons Attribution-NonCommercial 4.0 International License. To view a copy of this license, visit here) or send a letter to Creative Commons, PO Box 1866, Mountain View, CA 94042, USA.

Otherwise the code in this repository is licensed under the terms of GPL v3.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

jax_unirep-1.0.1.tar.gz (22.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

jax_unirep-1.0.1-py3-none-any.whl (67.7 MB view details)

Uploaded Python 3

File details

Details for the file jax_unirep-1.0.1.tar.gz.

File metadata

  • Download URL: jax_unirep-1.0.1.tar.gz
  • Upload date:
  • Size: 22.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.1.3.post20200325 requests-toolbelt/0.9.1 tqdm/4.43.0 CPython/3.7.6

File hashes

Hashes for jax_unirep-1.0.1.tar.gz
Algorithm Hash digest
SHA256 74dac85d25b395a4e57f11646b6c5e411852e1848983a73c702f453d17acbdcb
MD5 654fe036dc61474682bbb14b46385f54
BLAKE2b-256 6782e2972bf636c9084e7778e874ba64f2735b585a82803714b87d47f768058c

See more details on using hashes here.

File details

Details for the file jax_unirep-1.0.1-py3-none-any.whl.

File metadata

  • Download URL: jax_unirep-1.0.1-py3-none-any.whl
  • Upload date:
  • Size: 67.7 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.1.3.post20200325 requests-toolbelt/0.9.1 tqdm/4.43.0 CPython/3.7.6

File hashes

Hashes for jax_unirep-1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 cd2a1f3e42bf9b312eca56e3708339ff0a4ccc984584d103ee93c87fc24cb8ed
MD5 3125124352ee3db2e161d2f347a78b6d
BLAKE2b-256 4e371978d51bed095d8bb5efe6aadce3bfef7981a0a1f2341c36c478fcaf3f4d

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page