Metadata-Version: 2.5
Name: exege
Version: 0.6.0
Summary: Tools for understanding and evaluating scientific machine-learning models: latent-space diagnostics, sparse autoencoders, figures, a local app
Project-URL: Homepage, https://mahf708.github.io/exege
Project-URL: Documentation, https://mahf708.github.io/exege/
Project-URL: Source, https://github.com/mahf708/exege
Project-URL: Issues, https://github.com/mahf708/exege/issues
Author: E3SM AI Group
License-Expression: BSD-3-Clause
Keywords: climate,e3sm,emulator,interpretability,machine-learning
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Science/Research
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Scientific/Engineering :: Atmospheric Science
Requires-Python: >=3.11
Requires-Dist: exege-core[app,hf]==0.6.0
Provides-Extra: nn
Requires-Dist: exege-core[nn]==0.6.0; extra == 'nn'
Description-Content-Type: text/markdown

# exege

Tools for understanding and evaluating scientific machine-learning models: what an
emulator holds inside, sparse autoencoders trained on it, figures, and a local app over
them. The name comes from the Greek stem *exēgē-*, associated with explanation and
interpretation.

> **Research tool.** `exege` is early. What is described here works; expect it to change.

```console
$ pip install exege            # everything but torch
$ pip install 'exege[nn]'      # and torch, for training sparse autoencoders
$ exege --help
```

This is the full install. It holds no code of its own: it installs
[exege-core](https://pypi.org/project/exege-core/) with every extra but `nn`, and both
provide the same `import exege` and the same `exege` command. For the light install,
Click only, with each subpackage's dependencies added as you need them:

```console
$ pip install 'exege-core[latents]'
```

- Documentation: <https://mahf708.github.io/exege/>
- Source and issues: <https://github.com/mahf708/exege>

BSD-3-Clause.
