Metrics for evaluating biological sequence design.
Project description
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
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.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file seqme-0.2.4.tar.gz.
File metadata
- Download URL: seqme-0.2.4.tar.gz
- Upload date:
- Size: 60.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
4bfc7a4765cbc674dc60dd1355084ee0c6061bd2efda7d58eb7936326b2a8bad
|
|
| MD5 |
711be5c87cfa1e642f752cd989fcdf4e
|
|
| BLAKE2b-256 |
dbf9f94146db5fc67e43bb5abbaa8658065fe6d2b6782beb1b486cff53416afa
|
Provenance
The following attestation bundles were made for seqme-0.2.4.tar.gz:
Publisher:
release.yml on szczurek-lab/seqme
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
seqme-0.2.4.tar.gz -
Subject digest:
4bfc7a4765cbc674dc60dd1355084ee0c6061bd2efda7d58eb7936326b2a8bad - Sigstore transparency entry: 640673313
- Sigstore integration time:
-
Permalink:
szczurek-lab/seqme@57f9971d9e4e40bbdec46749aa84b544216a29b2 -
Branch / Tag:
refs/tags/0.2.4 - Owner: https://github.com/szczurek-lab
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@57f9971d9e4e40bbdec46749aa84b544216a29b2 -
Trigger Event:
release
-
Statement type:
File details
Details for the file seqme-0.2.4-py3-none-any.whl.
File metadata
- Download URL: seqme-0.2.4-py3-none-any.whl
- Upload date:
- Size: 69.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
a1c5a423bdf5eb1c1d9a655e911a5c241941a43e2d0af5dfb7adb938ff8464f9
|
|
| MD5 |
6571410b4b43885af5ddf3803d7dba96
|
|
| BLAKE2b-256 |
4a6eae9e602888e428a37d04ca4b8d89b8209f88171719102764e7abc21cb4e1
|
Provenance
The following attestation bundles were made for seqme-0.2.4-py3-none-any.whl:
Publisher:
release.yml on szczurek-lab/seqme
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
seqme-0.2.4-py3-none-any.whl -
Subject digest:
a1c5a423bdf5eb1c1d9a655e911a5c241941a43e2d0af5dfb7adb938ff8464f9 - Sigstore transparency entry: 640673316
- Sigstore integration time:
-
Permalink:
szczurek-lab/seqme@57f9971d9e4e40bbdec46749aa84b544216a29b2 -
Branch / Tag:
refs/tags/0.2.4 - Owner: https://github.com/szczurek-lab
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@57f9971d9e4e40bbdec46749aa84b544216a29b2 -
Trigger Event:
release
-
Statement type: