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.2.3.tar.gz (57.0 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.2.3-py3-none-any.whl (66.0 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for seqme-0.2.3.tar.gz
Algorithm Hash digest
SHA256 84ed950fd6b37bad096b6d892fb8f9005ed6f873a9781a94348da5a859f9de79
MD5 47624e3fe205979a71f424363753a9e0
BLAKE2b-256 fff506a6fac26f38b412d8d18d9c208f0b5b2dd6d2bd2e297f8d9369cb51019b

See more details on using hashes here.

Provenance

The following attestation bundles were made for seqme-0.2.3.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.2.3-py3-none-any.whl.

File metadata

  • Download URL: seqme-0.2.3-py3-none-any.whl
  • Upload date:
  • Size: 66.0 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.2.3-py3-none-any.whl
Algorithm Hash digest
SHA256 a39849efe0fc99e3bcd9e1645c05d43845b8374b3e03bc6e322c25823490dbdd
MD5 75bd62b445b1b1e65e2b177baff60983
BLAKE2b-256 13e0fa6659e252e427fe04ec586204a1cecc7ac77fb268139f473ba769dc39bd

See more details on using hashes here.

Provenance

The following attestation bundles were made for seqme-0.2.3-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