Metadata-Version: 2.4
Name: sonusai-torchl
Version: 1.3.0
Summary: PyTorch Lightning model tools for SonusAI
Project-URL: Homepage, https://aaware.com
Author-email: Chris Eddington <chris@aaware.com>, Jason Calderwood <jason@aaware.com>
License-Expression: GPL-3.0-only
Requires-Python: <3.15,>=3.13
Requires-Dist: docopt~=0.6.2
Requires-Dist: h5py~=3.16.0
Requires-Dist: lightning~=2.6.1
Requires-Dist: numpy~=2.4.4
Requires-Dist: onnxconverter-common~=1.16.0
Requires-Dist: onnxsim~=0.6.3
Requires-Dist: openvino~=2026.1.0
Requires-Dist: psutil~=7.2.2
Requires-Dist: pyaaware~=3.0.1
Requires-Dist: sonusai~=1.3.2
Requires-Dist: torchinfo~=1.8.0
Requires-Dist: torch~=2.11.0
Description-Content-Type: text/markdown

# SonusAI Torchl

PyTorch Lightning model tools for SonusAI.

SonusAI Torchl is a companion project to [SonusAI](../sonusai), providing tools and utilities for training, predicting, and exporting deep neural network models using PyTorch Lightning.

## Key Features

- **Lightning Training**: Streamlined training workflows using PyTorch Lightning.
- **Model Export**: Tools for converting trained models to ONNX and PyTorch AOTInductor (.so) formats.
- **Data Loading**: Specialized data generators and datasets compatible with SonusAI mixture databases.
- **Inference**: Prediction tools for running inference on trained Lightning models.

## Getting Started

Refer to the [Development Guide](docs/development.md) for installation and setup instructions.

### Prerequisites
- Python 3.13+ (Python 3.13 and 3.14 supported)
- `sonusai`
- `uv`

### Quick Install
If you have `uv` installed, you can sync the environment:
```bash
uv sync
```

## Documentation

- **[CLI Reference](docs/cli.md)**: Overview of available `sonusai_torchl` commands.
- **[Development Guide](docs/development.md)**: Setup, build, and test instructions.
- **[Data Formats & Dimensions](docs/data_formats.md)**: Technical specifications for data processing.
- **[Architecture](.context/architecture.md)**: Details on the project structure and integration.

## Command Overview

```
   torchl2aoti                  Convert a trained PyTorch Lightning model to AOTInductor
   torchl_onnx                  Convert a trained PyTorch Lightning model to ONNX
   torchl_predict               Run PyTorch Lightning predict on a trained model
   torchl_train                 Train a model using PyTorch Lightning
```

Use `python -m sonusai_torchl.<command> --help` for detailed information on any command.
