Metadata-Version: 2.4
Name: visu-hlo
Version: 0.1
Summary: Displays the HLO representation of (un-)jitted functions as SVG
Project-URL: repository, https://github.com/CMBSciPol/visu_hlo
Author-email: Pierre Chanial <chanial@apc.in2p3.fr>
License-Expression: MIT
License-File: LICENSE
Classifier: Intended Audience :: Education
Classifier: Intended Audience :: Science/Research
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Scientific/Engineering :: Mathematics
Classifier: Topic :: Scientific/Engineering :: Visualization
Classifier: Topic :: Software Development :: Debuggers
Requires-Python: >=3.10
Requires-Dist: graphviz>=0.18.2
Requires-Dist: jax>=0.4.0
Requires-Dist: jaxlib>=0.4.0
Description-Content-Type: text/markdown

# visu-hlo

**visu-hlo** displays the HLO representation of JAX functions as SVG visualizations.

[![Documentation](https://readthedocs.org/projects/visu-hlo/badge/?version=latest)](https://visu-hlo.readthedocs.io/en/latest/?badge=latest)
[![PyPI version](https://badge.fury.io/py/visu-hlo.svg)](https://badge.fury.io/py/visu-hlo)

## Quick Example

```python
import jax.numpy as jnp
from jax import jit
from visu_hlo import show

def func(x):
    return 3 * x * 2

# Visualize original function
show(func, jnp.ones(10))

# Visualize jitted function
show(jit(func), jnp.ones(10))
```

## Installation

```bash
pip install visu-hlo
```

**System dependency:** Install [Graphviz](https://graphviz.org/download/)

## Features

- 🎯 **Easy Visualization**: Display HLO graphs with a single function call
- ⚡ **JIT Support**: Works with both regular and jitted JAX functions
- 🖼️ **SVG Output**: High-quality vector graphics that scale perfectly
- 🖥️ **Cross-Platform**: Supports Linux, macOS, and Windows
- 📦 **Lightweight**: Minimal dependencies - just JAX and Graphviz

## Documentation

Full documentation: https://visu-hlo.readthedocs.io/

## License

MIT
