Metadata-Version: 2.5
Name: altar-enformer
Version: 0.7.0
Summary: Enformer model binding for large-scale Altar variant 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.8,>=0.7.0
Provides-Extra: prepare
Requires-Dist: kagglehub<2,>=1; extra == 'prepare'
Provides-Extra: test
Requires-Dist: pytest-asyncio>=0.24; extra == 'test'
Requires-Dist: pytest>=8; extra == 'test'
Description-Content-Type: text/markdown

# altar-enformer

Adds [Enformer](https://github.com/google-deepmind/deepmind-research/tree/master/enformer) to Altar: predicted
effects of human SNVs (hg38) on the tracks you select from its 5,313 human tracks, run in a container on an NVIDIA
GPU or a CPU.

Validation: Upstream parity (CPU), against DeepMind's TF-Hub variant-scoring recipe.

```bash
pip install "altar-enformer[prepare]"
```

Fetch the SavedModel from Kaggle and the track table, and write their resource manifest (needs the `prepare`
extra):

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

A run spec section:

```toml
[models.enformer]
type = "ENFORMER"
resource_manifest = "enformer-resources/enformer.resources.json"

[models.enformer.configuration]
track_indices = [0]   # the tracks of targets_human.txt to score, by index
```

`altar models enformer` lists the columns, the `track_effects` detail table and the configuration fields.

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

## Cite and terms

- Enformer: Avsec Ž, et al. Nature Methods 18, 1196–1203 (2021),
  [doi:10.1038/s41592-021-01252-x](https://doi.org/10.1038/s41592-021-01252-x).
- The Enformer code and the Kaggle weights are licensed Apache 2.0.

## Licence

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