Practical overview
When it fits
Use it when you want an adaptable research starting point for training binding-prediction experiments and can supply the model inputs, training targets and data files.
Who it is for
- Computational biology researchers exploring transformer models for transcription-factor binding.
- Developers building experiments that combine DNA sequence, transcription-factor protein representations and assay context.
Documented uses
- Train an adapter model on DNA sequences, transcription-factor embeddings, contextual inputs and target values.
- Configure a binary bind-or-not-bind prediction objective.
- Prepare BigWig-based track training inputs using sequence, factor, annotation and track files.
- Compare input representations, including ESM or ProtAlbert protein embeddings and free-text experimental context.
Requirements & limits
The code repository is public and lists an MIT license.
- The README's examples move the model and tensors to CUDA.
- The basic example uses Enformer with an AdapterModel and precomputed amino-acid and context embeddings.
- ESM and ProtAlbert are shown as alternative transcription-factor embedding encoders; the README notes ProtAlbert's longer context length compared with ESM.
- Free-text context requires enabling
use_free_text_context; the README describes encoding it with a text transformer trained on PubMed abstracts. - The BigWig example expects multiple local data paths, including FASTA, BED, BigWig and annotation inputs.
Check current requirements in the official documentation. Source-based guidance does not mean OpenViST has run or independently tested this project.
Install the Python package and listed data dependencies
Set up the repository's Python package and install the two additional dependencies named in its README.
Before you start
- A local copy of the repository and Python environment.
- Conda, as used by the README for the additional packages.
Steps
From the project root, run the command below.
python setup.py install --userInstall
pybedtoolsandpyBigWigwithconda install --channel conda-forge --channel bioconda pybedtools pyBigWig.
Expected outcome
The repository package and the two separately listed dependencies are installed according to the README's setup instructions.
Guide limitations
- These steps cover installation only; they do not configure training data, Enformer or a working prediction run.
Sources & review
Source record details
- Source availability
- Active
- Sources checked
- 18 October 2026
- Original website title
- lucidrains/tf-bind-transformer · Official homepage title · retained in its source language

