This release is a pre-release and may not be stable for production use.
TL;DR
Ignite is a high-level library to help with training neural networks in PyTorch.
- ignite helps you write compact but full-featured training loops in a few lines of code
- you get a training loop with metrics, early-stopping, model checkpointing and other features without the boilerplate
Below we show a side-by-side comparison of using pure pytorch and using ignite to create a training loop to train and validate your model with occasional checkpointing:
As you can see, the code is more concise and readable with ignite. Furthermore, adding additional metrics, or things like early stopping is a breeze in ignite, but can start to rapidly increase the complexity of your code when "rolling your own" training loop.
Table of Contents
- Installation
- Why Ignite?
- Documentation
- Structure
- Examples
- Contributing
- Projects using Ignite
- User feedback
Installation
From pip:
pip install pytorch-ignite
From conda:
conda install ignite -c pytorch
From source:
pip install git+https://github.com/pytorch/ignite
Nightly releases
From pip:
pip install --pre pytorch-ignite
From conda (this suggests to install pytorch nightly release instead of stable version as dependency):
conda install ignite -c pytorch-nightly
Why Ignite?
Ignite's high level of abstraction assumes less about the type of network (or networks) that you are training, and we require the user to define the closure to be run in the training and validation loop. This level of abstraction allows for a great deal more of flexibility, such as co-training multiple models (i.e. GANs) and computing/tracking multiple losses and metrics in your training loop.
Ignite also allows for multiple handlers to be attached to events, and a finer granularity of events in the engine loop.
Documentation
API documentation and an overview of the library can be found here.
Additional Materials
- 8 Creators and Core Contributors Talk About Their Model Training Libraries From PyTorch Ecosystem
- Ignite Posters from Pytorch Developer Conferences:
Structure
- ignite: Core of the library, contains an engine for training and evaluating, all of the classic machine learning metrics and a variety of handlers to ease the pain of training and validation of neural networks!
- ignite.contrib: The Contrib directory contains additional modules contributed by Ignite users. Modules vary from TBPTT engine, various optimisation parameter schedulers, logging handlers and a metrics module containing many regression metrics (ignite.contrib.metrics.regression)!
The code in ignite.contrib is not as fully maintained as the core part of the library. It may change or be removed at any time without notice.
Examples
We provide several examples ported from
pytorch/examples using ignite to display how it helps to write compact and
full-featured training loops in a few lines of code:
MNIST Example
Basic neural network training on MNIST dataset with/without ignite.contrib module:
- MNIST with ignite.contrib TQDM/Tensorboard/Visdom loggers
- MNIST with native TQDM/Tensorboard/Visdom logging
Tutorials
Text Classification using Convolutional Neural Networks
Distributed CIFAR10 Example
Training a small variant of ResNet on CIFAR10 in various configurations: 1) single gpu, 2) single node multiple gpus, 3) multiple nodes and multilple gpus.
Other Examples
Reproducible Training Examples
Inspired by torchvision/references, we provide several reproducible baselines for vision tasks:
Features:
- Distributed training with mixed precision by nvidia/apex
- Experiments tracking with MLflow or Polyaxon
Contributing
We appreciate all contributions. If you are planning to contribute back bug-fixes, please do so without any further discussion. If you plan to contribute new features, utility functions or extensions, please first open an issue and discuss the feature with us.
Please see the contribution guidelines for more information.
As always, PRs are welcome :)
Projects using Ignite
- State-of-the-Art Conversational AI with Transfer Learning
- Tutorial on Transfer Learning in NLP held at NAACL 2019
- Implementation of "Attention is All You Need" paper
- Implementation of DropBlock: A regularization method for convolutional networks in PyTorch
- Deep-Reinforcement-Learning-Hands-On-Second-Edition, published by Packt
- Kaggle Kuzushiji Recognition: 2nd place solution
- Unsupervised Data Augmentation experiments in PyTorch
- Hyperparameters tuning with Optuna
- Project MONAI - AI Toolkit for Healthcare Imaging
See other projects at "Used by"
If your project implements a paper, represents other use-cases not covered in our official tutorials, Kaggle competition's code or just your code presents interesting results and uses Ignite. We would like to add your project in this list, so please send a PR with brief description of the project.
User feedback
We have created a form for "user feedback". We appreciate any type of feedback and this is how we would like to see our community:
- If you like the project and want to say thanks, this the right place.
- If you do not like something, please, share it with us and we can see how to improve it.
Thank you !
Release files for pytorch-ignite 0.4.0.dev20200312
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| pytorch-ignite-0.4.0.dev20200312.tar.gz | 84.7 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| pytorch_ignite-0.4.0.dev20200312-py2.py3-none-any.whl | Python 2, Python 3 | none | any | Details |
Total release size: 207.3 kB
Release files / pytorch-ignite-0.4.0.dev20200312.tar.gz
| Download URL | pytorch-ignite-0.4.0.dev20200312.tar.gz |
|---|---|
| Size | 84.7 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
091a8b8cc829aba728e5b6c78f0ca91bbab604f136187cdd91a2e4c71e269784
|
|
BLAKE2b-256 checksum How to use checksums |
f8118e9e512815a5cf6b891f26c5f0377d84fa11f6ae71752f4c52d9754caec3
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.0.0.post20200309 requests-toolbelt/0.9.1 tqdm/4.43.0 CPython/3.7.6
|
Release files / pytorch_ignite-0.4.0.dev20200312-py2.py3-none-any.whl
| Download URL | pytorch_ignite-0.4.0.dev20200312-py2.py3-none-any.whl |
|---|---|
| Size | 122.5 kB |
| Tags | Python 2 Python 3 |
|
SHA-256 checksum How to use checksums |
3f01c2e50a013b72ffb82895395f6a7cee497f3ab1b4766e7e10361643bb8b4b
|
|
BLAKE2b-256 checksum How to use checksums |
fd5447f2af17fecd4a50c0b47c2ac42c8df0bedc395d23b3f6895301ca0de869
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.0.0.post20200309 requests-toolbelt/0.9.1 tqdm/4.43.0 CPython/3.7.6
|
