Add CIFAR10 example link

Tony-Y · Oct 26, 2024 · 6abf113 · 6abf113
1 parent 97e1410
commit 6abf113
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 1 deletion.
diff --git 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
@@ -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 <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.