Metadata-Version: 2.1
Name: boilr
Version: 0.5.12
Summary: Basic framework for training models with PyTorch
Home-page: https://github.com/addtt/boiler-pytorch
Author: Andrea Dittadi
Author-email: andrea.dittadi@gmail.com
License: UNKNOWN
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown
Requires-Dist: numpy (>=1.17)
Requires-Dist: torch (>=1.4)
Requires-Dist: torchvision (>=0.5)
Requires-Dist: matplotlib (>=3.1)
Requires-Dist: tqdm
Requires-Dist: pillow (>=7.0)

# boiler-pytorch

Basic framework for training stuff in PyTorch. It's quite tailored to projects 
I've been working on lately, so it's meant for personal use. Its sole purpose is 
to do away with *boiler*plate code, and having it here makes it easier to 
share it across projects.

## Install

```shell script
pip install boilr
```

## Usage example/template

There's a usage example that can be useful as template. It's a basic VAE
for MNIST quickly hacked together. The example files/folders are:
- `example.py`
- `models/`
- `experiments/`

Install requirements and run the example:

```shell script
pip install -r requirements.txt
CUDA_VISIBLE_DEVICES=0 python example.py
```

Tested with:

- `python 3.7.6`
- `numpy 1.18.1`
- `matplotlib 3.1.2`
- `torch 1.4.0`
- `torchvision 0.5.0`
- `tensorboard 2.1.0` (it also works without, but it won't save tensorboard logs)
- `pillow 7.0`
- `tqdm 4.41.1`


