Merge pull request #212 from sguttikon/master

Copyright + License changes to files in examples folder

Author: serizba

CITATION.cff

@@ -0,0 +1,11 @@
+cff-version: 1.2.0
+message: "If you use this software, please cite it as below."
+authors:
+- family-names: "Izquierdo"
+  given-names: "Sergio"
+  orcid: "https://orcid.org/0000-0002-5639-5035"
+title: "cppflow"
+version: 1.0.0
+doi: 10.5281/zenodo.1234
+date-released: 2019-05-16
+url: "https://github.com/serizba/cppflow"

README.md

@@ -56,7 +56,7 @@ There you can find quickstart guides and more information about how to install t
 
 ## Development
 
-CppFlow is basically a wrapper over Tensorflow C API. The basic class, [tensor](https://github.com/serizba/cppflow/blob/master/include/cppflow/tensor.h) is a wrapper of a TF eager tensor, and it just constains a pointer to its TF representation. 
+CppFlow is basically a wrapper over Tensorflow C API. The basic class, [tensor](https://github.com/serizba/cppflow/blob/master/include/cppflow/tensor.h) is a wrapper of a TF eager tensor, and it just constains a pointer to its TF representation.
 
 The TF C API provides the tools to call all the TF [raw ops](https://www.tensorflow.org/api_docs/python/tf/raw_ops), but using them is confusing. CppFlow includes a facade over these functions, so they can be called easily as normal C++ functions. To achieve this, the file [ops](https://github.com/serizba/cppflow/blob/master/include/cppflow/raw_ops.h) contains (mostly) all the TF raw ops functions, but with a simple C++ interface. This file has been generated automatically using a [small script](https://github.com/serizba/cppflow/blob/master/include/cppflow/ops_generator/generator.py).
 
@@ -74,6 +74,10 @@ There are still many things to implement... some of them may be:
 
 You can also use the [older version](https://github.com/serizba/cppflow/tree/243ff2fc4e33632b91676cad7d6cfc3c92308601) of this work.
 
+## Style guide
+
+We use the [Google's C++ style guide](https://google.github.io/styleguide/cppguide.html) using static code linker [cpplint](https://github.com/cpplint/cpplint).
+
 ## Remark
 
-CppFlow is not related with TensorFlow. The CppFlow icon is a modified version of the TensorFlow logo. TensorFlow, the TensorFlow logo and any related marks are trademarks of Google Inc.
+CppFlow is not related with TensorFlow. The CppFlow icon is a modified version of the TensorFlow logo. TensorFlow, the TensorFlow logo and any related marks are trademarks of Google Inc.

examples/eager_op_multithread/main.cpp

@@ -1,29 +1,64 @@
+// MIT License
+//
+// Copyright (c) 2020 Jiannan Liu
+// Copyright (c) 2022 Sergio Izquierdo
+//
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files (the "Software"), to deal
+// in the Software without restriction, including without limitation the rights
+// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+// copies of the Software, and to permit persons to whom the Software is
+// furnished to do so, subject to the following conditions:
+//
+// The above copyright notice and this permission notice shall be included in
+// all copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+// SOFTWARE.
+
+/*!
+ *  @file       main.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
+ */
+
+// CppFlow headers
+#include <cppflow/cppflow.h>
+
+// C++ headers
 #include <thread>
 #include <cmath>
 #include <vector>
 #include <iostream>
 
-#include <cppflow/cppflow.h>
-
 constexpr size_t num_iter = 10240;
 constexpr size_t num_threads = 32;
 
 void test1(float input1, float input2, float input3) {
     float target = (input1+input2)*input3;
-    for(size_t i = 0; i < num_iter; i++) {
+    for (size_t i = 0; i < num_iter; i++) {
         cppflow::tensor t1(input1), t2(input2), t3(input3);
         auto result = (t1+t2)*t3;
         float result_value = result.get_data<float>()[0];
-        if(std::abs(target/result_value-1.0f) > 1e-6) {
-            std::cout << "error: result_value=" << result_value << ", target=" << target << std::endl;
+        if (std::abs(target/result_value-1.0f) > 1e-6) {
+            std::cout << "error: result_value=" << result_value
+                      << ", target=" << target << std::endl;
         }
     }
 }
 
 int main() {
     std::vector<std::thread> threads;
-    for(size_t i = 0; i < num_threads; i++) {
-        if(i % 2 == 0) {
+    for (size_t i = 0; i < num_threads; i++) {
+        if (i % 2 == 0) {
             std::thread t1(test1, 3, 10, 100);
             threads.push_back(std::move(t1));
         } else {
@@ -32,7 +67,7 @@ int main() {
         }
     }
 
-    for(auto& t: threads) {
+    for (auto& t : threads) {
         t.join();
     }
 

examples/efficientnet/create_model.py

@@ -1,8 +1,40 @@
+#!/usr/bin/env python
+
+# MIT License
+#
+# Copyright (c) 2020 Sergio Izquierdo
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+# @file create_model.py
+#
+# @brief A brief description here.
+#
+# @section description_create_model Define custom details for the file here.
+#
+# @section author_create_model Author(s)
+# - Created  by Sergio Izquierdo
+
+# Imports
 import tensorflow as tf
 
 model = tf.keras.applications.EfficientNetB0()
 
 # Export the model to a SavedModel
 model.save('model', save_format='tf')
-
-

examples/efficientnet/main.cpp

@@ -1,17 +1,51 @@
-#include <iostream>
+// MIT License
+//
+// Copyright (c) 2020 Sergio Izquierdo
+// Copyright (c) 2021 Florian
+//
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files (the "Software"), to deal
+// in the Software without restriction, including without limitation the rights
+// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+// copies of the Software, and to permit persons to whom the Software is
+// furnished to do so, subject to the following conditions:
+//
+// The above copyright notice and this permission notice shall be included in
+// all copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+// SOFTWARE.
+
+/*!
+ *  @file       main.cpp
+ *  @brief      A brief description here.
+ *  @details    Define custom details for the file here.
+ *  @author     Florian
+ *  @author     Sergio Izquierdo
+ *  @date       @showdate "%B %d, %Y" 2020-09-16
+ */
 
+// CppFlow headers
 #include <cppflow/cppflow.h>
 
+// C++ headers
+#include <iostream>
 
 int main() {
-
-    auto input = cppflow::decode_jpeg(cppflow::read_file(std::string(CAT_PATH)));
+    auto input = cppflow::decode_jpeg(
+        cppflow::read_file(std::string(CAT_PATH)));
     input = cppflow::cast(input, TF_UINT8, TF_FLOAT);
     input = cppflow::expand_dims(input, 0);
     cppflow::model model(std::string(MODEL_PATH));
     auto output = model(input);
 
-    std::cout << "It's a tiger cat: " << cppflow::arg_max(output, 1) << std::endl;
+    std::cout << "It's a tiger cat: " << cppflow::arg_max(output, 1)
+              << std::endl;
 
     return 0;
 }

examples/load_frozen_graph/create_model.py

@@ -1,3 +1,41 @@
+#!/usr/bin/env python
+
+# MIT License
+#
+# Copyright (c) 2021 Daisuke Kato
+# Copyright (c) 2021 Paul
+# Copyright (c) 2022 Sergio Izquierdo
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+# @file create_model.py
+#
+# @brief A brief description here.
+#
+# @section description_create_model Define custom details for the file here.
+#
+# @section author_create_model Author(s)
+# - Created  by Daisuke Kato
+# - Created  by Paul
+# - Modified by Sergio Izquierdo
+
+# Imports
 import tensorflow as tf
 from tensorflow.python.framework.convert_to_constants import (
     convert_variables_to_constants_v2,
@@ -19,4 +57,4 @@
 
 # Save the graph as protobuf format
 directory = "."
-tf.io.write_graph(frozen_model.graph, directory, "model.pb", as_text=False)
+tf.io.write_graph(frozen_model.graph, directory, "model.pb", as_text=False)

examples/load_frozen_graph/main.cpp

@@ -1,16 +1,50 @@
-#include <iostream>
+// MIT License
+//
+// Copyright (c) 2021 Daisuke Kato
+// Copyright (c) 2021 Paul
+// Copyright (c) 2022 Sergio Izquierdo
+//
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files (the "Software"), to deal
+// in the Software without restriction, including without limitation the rights
+// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+// copies of the Software, and to permit persons to whom the Software is
+// furnished to do so, subject to the following conditions:
+//
+// The above copyright notice and this permission notice shall be included in
+// all copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+// SOFTWARE.
+
+/*!
+ *  @file       main.cpp
+ *  @brief      A brief description here.
+ *  @details    Define custom details for the file here.
+ *  @author     Daisuke Kato
+ *  @author     Paul
+ *  @author     Sergio Izquierdo
+ *  @date       @showdate "%B %d, %Y" 2021-09-16
+ */
 
+// CppFlow headers
 #include <cppflow/ops.h>
 #include <cppflow/model.h>
 
+// C++ headers
+#include <iostream>
 
 int main() {
-
     auto input = cppflow::fill({10, 5}, 1.0f);
     std::cout << "start" << std::endl;
     cppflow::model model("../model.pb", cppflow::model::FROZEN_GRAPH);
     auto output = model({{"x:0", input}}, {{"Identity:0"}})[0];
-    
+
     std::cout << output << std::endl;
 
     auto values = output.get_data<float>();

examples/load_model/create_model.py

@@ -1,7 +1,40 @@
+#!/usr/bin/env python
+
+# MIT License
+#
+# Copyright (c) 2019 Sergio Izquierdo
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+# @file create_model.py
+#
+# @brief A brief description here.
+#
+# @section description_create_model Define custom details for the file here.
+#
+# @section author_create_model Author(s)
+# - Created  by Sergio Izquierdo
+
+# Imports
 import tensorflow as tf
 import numpy as np
 
-
 input = tf.keras.Input(shape=(5,))
 
 output = tf.keras.layers.Dense(5, activation=tf.nn.relu)(input)
@@ -11,4 +44,4 @@
 model.compile()
 
 # Export the model to a SavedModel
-model.save('model', save_format='tf')
+model.save('model', save_format='tf')