Metadata-Version: 2.3
Name: pyroml
Version: 2.0.0
Summary: Machine Learning framework allowing plug-and-play training for pytorch models
License: MIT License
         
         Copyright (c) 2023 Nachos
         
         Permission is hereby granted, free of charge, to any person obtaining a copy
         of this software and associated documentation files (the "Software"), to deal
         in the Software without restriction, including without limitation the rights
         to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
         copies of the Software, and to permit persons to whom the Software is
         furnished to do so, subject to the following conditions:
         
         The above copyright notice and this permission notice shall be included in all
         copies or substantial portions of the Software.
         
         THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
         IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
         FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
         AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
         LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
         OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
         SOFTWARE.
Author: Nathan MAIRE
Requires-Python: >=3.10
Classifier: License :: Other/Proprietary License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Requires-Dist: datasets (>=3.2.0,<4.0.0)
Requires-Dist: matplotlib (>=3.10.0,<4.0.0)
Requires-Dist: rich (>=13.9.4,<14.0.0)
Requires-Dist: safetensors (>=0.5.2,<0.6.0)
Requires-Dist: torch (>=2.6.0)
Requires-Dist: torchmetrics (>=1.6.1,<2.0.0)
Requires-Dist: torchvision (>=0.20.1)
Project-URL: github, https://github.com/peacefulotter/pyroml
Description-Content-Type: text/markdown

# 🔥 pyro

<b style='font-size:16px'>Lightweight Machine Learning framework allowing plug-and-play training for Pytorch models</b>

-   ⚡ <b>Lightning</b> inspired
-   💾 Support for <b>wandb</b> and <b>checkpoints</b> out-of-the-box
-   📊 Pretty <b>logs</b>, <b>plots</b> and support for <b>metrics</b>
-   ✨ Fully <b>type-safe</b>
-   🪶 Lightweight and <b>easy to use</b>

## Requirements

-   Python 3.10 : 3.12

## Installation

```shell
pip install pyroml
```

### Locally

```shell
# Clone the repo
git clone https://github.com/peacefulotter/pyroml.git
cd pyroml

# Install dependencies
poetry config virtualenvs.in-project true # Optional, easier for vscode to find the venv folder
poetry install
```

### Running tests

```shell
$ cd tests
$ python main.py # this will launch the training, follow the wandb link to access the plots
$ python pretrain.py # will load the last checkpoint and compute mse on a small part of the dataset, outputs True if model predicts correctly!
```

