Metadata-Version: 2.5
Name: altar-borzoi
Version: 0.8.1
Summary: Borzoi model binding for large-scale Altar variant-gene scoring
Project-URL: Documentation, https://kundajelab.github.io/altar/
Author: Riya Sinha
License-Expression: MIT
License-File: LICENSE
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Scientific/Engineering :: Bio-Informatics
Classifier: Typing :: Typed
Requires-Python: >=3.12
Requires-Dist: altar<0.9,>=0.8.1
Provides-Extra: test
Requires-Dist: pytest-asyncio>=0.24; extra == 'test'
Requires-Dist: pytest>=8; extra == 'test'
Description-Content-Type: text/markdown

# altar-borzoi

Adds [Borzoi](https://github.com/calico/borzoi) to Altar: predicted effects of human SNVs (hg38) on RNA-seq
coverage of nearby genes in the GTEx tissues you select, run in a container on an NVIDIA GPU or a CPU.

Validation: Upstream parity (GPU and CPU), against the official `borzoi_sed.py`.

```bash
pip install altar-borzoi
```

Fetch the four replicate weights and their annotations, and write their resource manifest:

```bash
altar-borzoi-resources fetch-official --output-dir borzoi-resources
```

A run spec section:

```toml
[models.borzoi]
type = "BORZOI"
resource_manifest = "borzoi-resources/borzoi.resources.json"

[models.borzoi.configuration]
target_indices = [7522]   # GTEx targets, original indices 7522 to 7610
```

`altar models borzoi` lists the columns, the `gene_effects` detail table and the configuration fields.

Documentation: https://kundajelab.github.io/altar/integrations/borzoi/

## Cite and terms

- Borzoi: Linder J, et al. Nature Genetics 57, 949–961 (2025),
  [doi:10.1038/s41588-024-02053-6](https://doi.org/10.1038/s41588-024-02053-6).
- The Borzoi code is licensed Apache 2.0. Its repository states no separate licence for the weights.

## Licence

MIT. See [LICENSE](https://github.com/kundajelab/altar/blob/main/bindings/borzoi/LICENSE).
