Metadata-Version: 2.5
Name: modeldive
Version: 0.0.1
Summary: Readable, publication-quality diagrams of neural network architectures, extracted automatically from the model.
Project-URL: Repository, https://github.com/joanna88/ModelDive
Project-URL: Changelog, https://github.com/joanna88/ModelDive/blob/main/CHANGELOG.md
Author: Joanna Zarnecka
License-Expression: MIT
License-File: LICENSE
Keywords: architecture,deep learning,neural networks,pytorch,visualization
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Science/Research
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Classifier: Topic :: Scientific/Engineering :: Visualization
Classifier: Typing :: Typed
Requires-Python: >=3.11
Provides-Extra: docs
Requires-Dist: pydata-sphinx-theme; extra == 'docs'
Requires-Dist: sphinx; extra == 'docs'
Provides-Extra: lint
Requires-Dist: mypy==2.4.1; extra == 'lint'
Requires-Dist: ruff==0.17.3; extra == 'lint'
Provides-Extra: test
Requires-Dist: pytest-cov>=7; extra == 'test'
Requires-Dist: pytest>=9; extra == 'test'
Provides-Extra: torch
Requires-Dist: torch>=2.6; extra == 'torch'
Description-Content-Type: text/markdown

# ModelDive

Readable, publication-quality diagrams of neural network architectures, extracted
automatically from the model.

> **Status: early development.** Nothing is usable yet. The design is described in
> [DESIGN.md](https://github.com/joanna88/ModelDive/blob/main/DESIGN.md).

## Planned usage

```python
import modeldive as md

fig = md.draw(model, detail=2, style="modern")
fig.save("model.svg")
```

`detail` sets how deep the diagram goes, from 1 (top-level stages only) to 3 (individual
layers).

## Development

Using the pinned Docker environment:

```bash
docker build -t modeldive-dev docker/
docker run --rm -v "$PWD":/workspace modeldive-dev \
    bash -c 'pip install -q --no-deps -e . && pytest'
```

## License

[MIT](https://github.com/joanna88/ModelDive/blob/main/LICENSE)
