diff --git a/README.md b/README.md index 33cbf15..84f7774 100644 --- a/README.md +++ b/README.md @@ -25,6 +25,8 @@ pip install -U pytorch_warmup ## Examples +* [CIFAR10](https://github.com/Tony-Y/pytorch_warmup/tree/master/examples/cifar10) - + A sample script to train a ResNet20 model on the CIFAR10 dataset using an optimization algorithm with a warmup. * [EMNIST](https://github.com/Tony-Y/pytorch_warmup/tree/master/examples/emnist) - A sample script to train a CNN model on the EMNIST dataset using the Adam algorithm with a warmup. * [Plots](https://github.com/Tony-Y/pytorch_warmup/tree/master/examples/plots) - diff --git a/docs/index.rst b/docs/index.rst index b26d10d..7ed3267 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -46,7 +46,10 @@ Examples .. image:: https://colab.research.google.com/assets/colab-badge.svg :alt: Open In Colab :target: https://colab.research.google.com/github/Tony-Y/colab-notebooks/blob/master/PyTorch_Warmup_Approach1_chaining.ipynb - + +* `CIFAR10 `_ - + A sample script to train a ResNet20 model on the CIFAR10 dataset using an optimization algorithm with a warmup. + * `EMNIST `_ - A sample script to train a CNN model on the EMNIST dataset using the Adam algorithm with a warmup.