Add CIFAR100 sample to CI (#113)

* Add CIFAR100 sample to CI

Author: TolyaTalamanov

.travis.yml

@@ -36,6 +36,8 @@ jobs:
         - ./samples/mnist/run_mnist_test.sh
         - ./samples/cifar10/run_cifar10_train.sh
         - ./samples/cifar10/run_cifar10_test.sh
+        - ./samples/cifar100/run_cifar100_train.sh
+        - ./samples/cifar100/run_cifar100_test.sh
     - stage: benchmarks
       script:
         - mkdir build

cmake/download.cmake

@@ -19,6 +19,7 @@ if (NOT EXISTS "${DATASETS_DIR}/MNIST")
     file(REMOVE "${DATASETS_DIR}/MNIST.zip")
 endif()
 
+# NB: Download CIFAR10 dataset if it doesn't exist
 if (NOT EXISTS "${DATASETS_DIR}/CIFAR10")
     message(STATUS "Downloading CIFAR10 dataset")
     file(DOWNLOAD
@@ -31,3 +32,17 @@ if (NOT EXISTS "${DATASETS_DIR}/CIFAR10")
     file(RENAME "${DATASETS_DIR}/CIFAR-10-JPG-master" "${DATASETS_DIR}/CIFAR10")
     file(REMOVE "${DATASETS_DIR}/CIFAR10.zip")
 endif()
+
+# NB: Download CIFAR100 dataset if it doesn't exist
+if (NOT EXISTS "${DATASETS_DIR}/CIFAR100")
+    message(STATUS "Downloading CIFAR100 dataset")
+    file(DOWNLOAD
+         https://github.com/SemicolonStruggles/CIFAR-100-JPG/archive/refs/heads/master.zip
+         "${DATASETS_DIR}/CIFAR100.zip" SHOW_PROGRESS)
+
+    execute_process(COMMAND ${CMAKE_COMMAND} -E tar xf "CIFAR100.zip"
+                    WORKING_DIRECTORY "${DATASETS_DIR}")
+
+    file(RENAME "${DATASETS_DIR}/CIFAR-100-JPG-master" "${DATASETS_DIR}/CIFAR100")
+    file(REMOVE "${DATASETS_DIR}/CIFAR100.zip")
+endif()

samples/README.md

@@ -8,3 +8,4 @@ export DATASETS_DIR=<path-to-deepworks-root>/datasets
 
 * [MNIST sample](./mnist/README.md)
 * [CIFAR10 sample](./cifar10/README.md)
+* [CIFAR100 sample](./cifar100/README.md)

samples/cifar10/README.md

@@ -31,10 +31,10 @@ Accuracy: 0.343249
 You can also run samples using binary target directly:
 * Run train:
 ```bash
-./bin/sample_cifar10_train train <path-to-deepworks>/datasets/CIFAR10 <batch_size> <num_epochs> <dump-frequency>
+./bin/sample_cifar10_train train <path-to-deepworks>/datasets/CIFAR10 <batch_size> <num_epochs> <dump-frequency> <path-to-dump>
 ```
 
 * Run test:
 ```bash
-./bin/sample_cifar10_train test <path-to-deepworks>/datasets/CIFAR10 <batch_size>
+./bin/sample_cifar10_train test <path-to-deepworks>/datasets/CIFAR10 <batch_size> <path-to-model>
 ```

samples/cifar100/README.md

@@ -1,16 +1,40 @@
-# Training simple network on CIFAR100 dataset
-## Download CIFAR100 dataset
+## Training convolution network on CIFAR100 dataset
+
+* Follow instruction to setup enviroment: [DeepWorks samples](../README.md)
+
+* Run train:
+```bash
+./samples/mnist/run_cifar100_train.sh
+```
+
+Possible output:
+```bash
+Epoch: 0
+Loss: 4.60511
+Loss: 4.55751
+Loss: 4.44311
+Loss: 4.42878
+Accuracy: 0.0556891
+Model saved: build/cifar100_model.bin
 ```
-cd /tmp
-wget -O CIFAR100.zip https://github.com/SemicolonStruggles/CIFAR-100-JPG/archive/refs/heads/master.zip
-unzip CIFAR100.zip
-mv CIFAR-100-JPG-master CIFAR100
+
+* Run test:
+```bash
+./samples/mnist/run_cifar100_test.sh
+```
+
+Output:
+```bash
+Accuracy: 0.0556891
 ```
 
-## Build & Run
+You can also run samples using binary target directly:
+* Run train:
+```bash
+./bin/sample_cifar100_train train <path-to-deepworks>/datasets/CIFAR100 <batch_size> <num_epochs> <dump-frequency> <path-to-dump>
 ```
-cd <deepworks-build>
-cmake ../ -DBUILD_SAMPLES=ON -DCMAKE_BUILD_TYPE=Release
-make -j8
-./bin/sample_cifar100_train /tmp/CIFAR100 <batch_size> <num_epochs> <dump-frequency>
+
+* Run test:
+```bash
+./bin/sample_cifar100_train test <path-to-deepworks>/datasets/CIFAR100 <batch_size> <path-to-model>
 ```

samples/cifar100/run_cifar100_test.sh

@@ -0,0 +1,15 @@
+#!/bin/bash
+
+if test -z ${DW_BUILD_PATH}
+then
+    echo "Please specify DW_BUILD_PATH variable that is the path to deepworks binary files."
+    exit
+fi
+
+if test -z ${DATASETS_DIR}
+then
+    echo "Please specify DATASETS_DIR variable that is the path to deepworks datasets."
+    exit
+fi
+
+${DW_BUILD_PATH}/bin/sample_cifar100_train test ${DATASETS_DIR}/CIFAR100/ 128 ${DW_BUILD_PATH}/cifar100_model.bin

samples/cifar100/run_cifar100_train.sh

@@ -0,0 +1,15 @@
+#!/bin/bash
+
+if test -z ${DW_BUILD_PATH}
+then
+    echo "Please specify DW_BUILD_PATH variable that is the path to deepworks binary files."
+    exit
+fi
+
+if test -z ${DATASETS_DIR}
+then
+    echo "Please specify DATASETS_DIR variable that is the path to deepworks datasets."
+    exit
+fi
+
+${DW_BUILD_PATH}/bin/sample_cifar100_train train ${DATASETS_DIR}/CIFAR100/ 128 1 1000 ${DW_BUILD_PATH}/cifar100_model.bin

samples/mnist/README.md

@@ -35,10 +35,10 @@ Accuracy: 0.96244
 You can also run samples using binary target directly:
 * Run train:
 ```bash
-./bin/sample_mnist_train train <path-to-deepworks>/datasets/MNIST <batch_size> <num_epochs> <dump-frequency>
+./bin/sample_mnist_train train <path-to-deepworks>/datasets/MNIST <batch_size> <num_epochs> <dump-frequency> <path-to-dump>
 ```
 
 * Run test:
 ```bash
-./bin/sample_mnist_train test <path-to-deepworks>/datasets/MNIST <batch_size>
+./bin/sample_mnist_train test <path-to-deepworks>/datasets/MNIST <batch_size> <path-to-model>
 ```