Skip to main content

Metrics for evaluating biological sequence design.

Project description

seqme logo

PyPI Python 3.10+ License Read the Docs

seqme is a modular and extendable python library containing model-agnostic metrics for evaluating biological sequence designs. It enables benchmarking and comparison of generative models for small molecules, DNA, RNA, peptides, and proteins.

Key features:

  • Metrics: A collection of sequence-, embedding-, and property-based metrics for evaluating generative models designs.
  • Models: Out-of-the-box, pre-trained property and embedding models for small molecules, DNA, RNA, peptides, and proteins.
  • Visualizations: Functionality to display metric results from single-shot and iterative optimization methods as tables and plots.

Is a metric or model missing? seqme's modular metric and third-party model interfaces make adding your own easy.

Installation

You need to have Python 3.10 or newer installed on your system. To install the base package do:

$ pip install seqme

To install sequence-specific models as well, include the appropriate extras specifiers. Check the individual model docs for installation instructions.

Quick start

Install seqme and the protein language model, ESM-2.

$ pip install "seqme[esm2]"

Run in a Jupyter notebook:

import seqme as sm

sequences = {
    "Random": ["MKQW", "RKSPL"],
    "UniProt": ["KKWQ", "RKSPL", "RASD"],
    "HydrAMP": ["MMRK", "RKSPL", "RRLSK", "RRLSK"],
}

cache = sm.Cache(
    models={"esm2": sm.models.ESM2(
        model_name="facebook/esm2_t6_8M_UR50D", batch_size=256, device="cpu")
    }
)

metrics = [
    sm.metrics.Uniqueness(),
    sm.metrics.Novelty(reference=sequences["UniProt"]),
    sm.metrics.FBD(reference=sequences["Random"], embedder=cache.model("esm2")),
]

df = sm.evaluate(sequences, metrics)
sm.show(df) # Note: Will only display the table in a notebook.

Check out the docs for in-depth tutorials and examples.

Citation

Preprint is coming soon.

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

seqme-0.3.0.tar.gz (60.5 kB view details)

Uploaded Source

Built Distribution

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

seqme-0.3.0-py3-none-any.whl (69.3 kB view details)

Uploaded Python 3

File details

Details for the file seqme-0.3.0.tar.gz.

File metadata

  • Download URL: seqme-0.3.0.tar.gz
  • Upload date:
  • Size: 60.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for seqme-0.3.0.tar.gz
Algorithm Hash digest
SHA256 cb004cf795928859b3621b1d4d4af2d1c4324284dcb767fe595e03e0ac9f7667
MD5 38871662c4219d0b22000b4226f9791c
BLAKE2b-256 edc509141e6df45aba2bc209f0f1e17f5df96da15a8f3a41420b3a0308c91ac8

See more details on using hashes here.

Provenance

The following attestation bundles were made for seqme-0.3.0.tar.gz:

Publisher: release.yml on szczurek-lab/seqme

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file seqme-0.3.0-py3-none-any.whl.

File metadata

  • Download URL: seqme-0.3.0-py3-none-any.whl
  • Upload date:
  • Size: 69.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for seqme-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 3c343cb8dd88a2a53f7d3f3c05ab1196995c821f41bf2ac63603481ce2593207
MD5 7453913a462042415cd45581f263a10a
BLAKE2b-256 186e98d1d26b012d5d37100d2ec1769fae6dc0229e2f8020593d64cb3ba3f26c

See more details on using hashes here.

Provenance

The following attestation bundles were made for seqme-0.3.0-py3-none-any.whl:

Publisher: release.yml on szczurek-lab/seqme

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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