changes to update brief and details description

serizba · Sep 23, 2022 · 7a39f57 · 7a39f57
1 parent 391ade2
commit 7a39f57
Show file tree

Hide file tree

Showing 9 changed files with 47 additions and 18 deletions.
diff --git a/examples/eager_op_multithread/main.cpp b/examples/eager_op_multithread/main.cpp
@@ -23,6 +23,8 @@
 
 /*!
  *  @file       main.cpp
+ *  @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
@@ -25,10 +25,14 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
 
-##
-# @file       create_model.py
-# @author     Sergio Izquierdo
-# @date       @showdate "%B %d, %Y" 2020-09-16
+# @file create_model.py
+#
+# @brief Creates and saves an EfficientNet model.
+#
+# @section description_create_model Creates and saves an EfficientNet model.
+#
+# @section author_create_model Author(s)
+# - Created  by Sergio Izquierdo
 
 # Imports
 import tensorflow as tf

diff --git a/examples/efficientnet/main.cpp b/examples/efficientnet/main.cpp
@@ -23,6 +23,9 @@
 
 /*!
  *  @file       main.cpp
+ *  @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
@@ -27,12 +27,16 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
 
-##
-# @file       create_model.py
-# @author     Daisuke Kato
-# @author     Paul
-# @author     Sergio Izquierdo
-# @date       @showdate "%B %d, %Y" 2021-09-16
+# @file create_model.py
+#
+# @brief Creates and saves a simple Keras model as a frozen graph.
+#
+# @section Creates and saves a simple Keras model as a frozen graph.
+#
+# @section author_create_model Author(s)
+# - Created  by Daisuke Kato
+# - Created  by Paul
+# - Modified by Sergio Izquierdo
 
 # Imports
 import tensorflow as tf

diff --git a/examples/load_frozen_graph/main.cpp b/examples/load_frozen_graph/main.cpp
@@ -24,6 +24,9 @@
 
 /*!
  *  @file       main.cpp
+ *  @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
@@ -25,10 +25,14 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
 
-##
-# @file       create_model.py
-# @author     Sergio Izquierdo
-# @date       @showdate "%B %d, %Y" 2019-05-16
+# @file create_model.py
+#
+# @brief Creates and saves a simple Keras model as a saved model.
+#
+# @section Creates and saves a simple Keras model as a saved model.
+#
+# @section author_create_model Author(s)
+# - Created  by Sergio Izquierdo
 
 # Imports
 import tensorflow as tf

diff --git a/examples/multi_input_output/create_model.py b/examples/multi_input_output/create_model.py
@@ -25,10 +25,14 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
 
-##
-# @file       create_model.py
-# @author     Sergio Izquierdo
-# @date       @showdate "%B %d, %Y" 2020-10-20
+# @file create_model.py
+#
+# @brief Creates and saves a simple multi input multi output Keras model.
+#
+# @section Creates and saves a simple multi input multi output Keras model.
+#
+# @section author_create_model Author(s)
+# - Created  by Sergio Izquierdo
 
 # Imports
 import tensorflow as tf

diff --git a/examples/multi_input_output/main.cpp b/examples/multi_input_output/main.cpp
@@ -23,6 +23,9 @@
 
 /*!
  *  @file       main.cpp
+ *  @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,6 +24,8 @@
 
 /*!
  *  @file       main.cpp
+ *  @brief      Tests tensors allocation and deallocation
+ *  @details    Tests tensors allocation and deallocation
  *  @author     Jiannan Liu
  *  @author     Seungtaek Kim
  *  @author     Sergio Izquierdo