Metadata-Version: 2.1
Name: firekit
Version: 0.0.7
Summary: A library of classes and functions for working with PyTorch.
Project-URL: Homepage, https://github.com/olihawkins/firekit
Project-URL: Bug Tracker, https://github.com/olihawkins/firekit/issues
Author-email: Oliver Hawkins <oli@olihawkins.com>
License: ISC License (ISC)
        
        Copyright 2022 Oliver Hawkins
        
        Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.
        
        THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
Classifier: License :: OSI Approved :: ISC License (ISCL)
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.7
Requires-Dist: numpy
Requires-Dist: pandas
Requires-Dist: scikit-learn
Requires-Dist: torch
Requires-Dist: torchvision
Description-Content-Type: text/markdown

# firekit

Firekit is a library of classes and functions for training and evaluating PyTorch models. The main focus of the library is a `Trainer` class that performs the standard training and evaluation loops, reports the training and evaluation loss and the evaluation performance on user-defined metrics, saves the model state when performance improves, and reloads the best model at the end of training. 

This project exists to support my work. It is in active development and the API is not stable.

## Installation

Install with `pip` or `pipenv` in the normal way.

```zsh
pip install firekit
```

Use the `--extra-index-url` argument to install PyTorch for CUDA as a dependency. For example, use the following to get PyTorch with CUDA 11.3.

```zsh
pip install firekit --extra-index-url https://download.pytorch.org/whl/cu113
```

