Updated examples descriptions

serizba · Sep 23, 2022 · 39fdbd3 · 39fdbd3
1 parent 16a3b93
commit 39fdbd3
Show file tree

Hide file tree

Showing 10 changed files with 21 additions and 20 deletions.
diff --git a/examples/eager_op_multithread/main.cpp b/examples/eager_op_multithread/main.cpp
@@ -23,8 +23,8 @@
 
 /*!
  *  @file       main.cpp
- *  @brief      A brief description here.
- *  @details    Define custom details for the file here.
+ *  @brief      Test the behavior of cppflow with multiple threads
+ *  @details    Test the behavior of cppflow with multiple threads
  *  @author     Jiannan Liu
  *  @author     Sergio Izquierdo
  *  @date       @showdate "%B %d, %Y" 2020-10-26

diff --git a/examples/efficientnet/create_model.py b/examples/efficientnet/create_model.py
@@ -24,9 +24,9 @@
 
 # @file create_model.py
 #
-# @brief A brief description here.
+# @brief Creates and saves an EfficientNet model.
 #
-# @section description_create_model Define custom details for the file here.
+# @section description_create_model Creates and saves an EfficientNet model.
 #
 # @section author_create_model Author(s)
 # - Created  by Sergio Izquierdo

diff --git a/examples/efficientnet/main.cpp b/examples/efficientnet/main.cpp
@@ -23,8 +23,9 @@
 
 /*!
  *  @file       main.cpp
- *  @brief      A brief description here.
- *  @details    Define custom details for the file here.
+ *  @brief      Run EfficientNet on a cat image as an example.
+ *  @details    Run an EfficientNet model on a cat image and print the result. 
+ *              The EfficientNet model should be downloaded running create_model.py
  *  @author     Florian
  *  @author     Sergio Izquierdo
  *  @date       @showdate "%B %d, %Y" 2020-09-16

diff --git a/examples/load_frozen_graph/create_model.py b/examples/load_frozen_graph/create_model.py
@@ -26,9 +26,9 @@
 
 # @file create_model.py
 #
-# @brief A brief description here.
+# @brief Creates and saves a simple Keras model as a frozen graph.
 #
-# @section description_create_model Define custom details for the file here.
+# @section Creates and saves a simple Keras model as a frozen graph.
 #
 # @section author_create_model Author(s)
 # - Created  by Daisuke Kato

diff --git a/examples/load_frozen_graph/main.cpp b/examples/load_frozen_graph/main.cpp
@@ -24,8 +24,9 @@
 
 /*!
  *  @file       main.cpp
- *  @brief      A brief description here.
- *  @details    Define custom details for the file here.
+ *  @brief      Loads a frozen graph model and runs it with dummy data
+ *  @details    Loads a simple Keras model saved in frozen graph format
+ *              and runs it with dummy data
  *  @author     Daisuke Kato
  *  @author     Paul
  *  @author     Sergio Izquierdo

diff --git a/examples/load_model/create_model.py b/examples/load_model/create_model.py
@@ -24,9 +24,9 @@
 
 # @file create_model.py
 #
-# @brief A brief description here.
+# @brief Creates and saves a simple Keras model as a saved model.
 #
-# @section description_create_model Define custom details for the file here.
+# @section Creates and saves a simple Keras model as a saved model.
 #
 # @section author_create_model Author(s)
 # - Created  by Sergio Izquierdo

diff --git a/examples/multi_input_output/create_model.py b/examples/multi_input_output/create_model.py
@@ -24,9 +24,9 @@
 
 # @file create_model.py
 #
-# @brief A brief description here.
+# @brief Creates and saves a simple multi input multi output Keras model.
 #
-# @section description_create_model Define custom details for the file here.
+# @section Creates and saves a simple multi input multi output Keras model.
 #
 # @section author_create_model Author(s)
 # - Created  by Sergio Izquierdo

diff --git a/examples/multi_input_output/main.cpp b/examples/multi_input_output/main.cpp
@@ -23,8 +23,9 @@
 
 /*!
  *  @file       main.cpp
- *  @brief      A brief description here.
- *  @details    Define custom details for the file here.
+ *  @brief      Loads a saved multi input/output model and runs it with dummy data
+ *  @details    Loads a simple Keras model with multiple inputs and outputs saved 
+ *              in saved model format and runs it with dummy data
  *  @author     Florian
  *  @author     Sergio Izquierdo
  *  @date       @showdate "%B %d, %Y" 2020-10-15

diff --git a/examples/tensor/main.cpp b/examples/tensor/main.cpp
@@ -24,8 +24,8 @@
 
 /*!
  *  @file       main.cpp
- *  @brief      A brief description here.
- *  @details    Define custom details for the file here.
+ *  @brief      Tests tensors allocation and deallocation
+ *  @details    Tests tensors allocation and deallocation
  *  @author     Jiannan Liu
  *  @author     Seungtaek Kim
  *  @author     Sergio Izquierdo

diff --git a/examples/tensor/odr.cpp b/examples/tensor/odr.cpp
@@ -23,8 +23,6 @@
 
 /*!
  *  @file       odr.cpp
- *  @brief      A brief description here.
- *  @details    Define custom details for the file here.
  *  @author     Jiannan Liu
  *  @author     Sergio Izquierdo
  *  @date       @showdate "%B %d, %Y" 2020-10-26