[GitHub] szha closed pull request #13286: [Example] Add docstring for test optimizer and test score

[GitBox <gi...@apache.org>]

szha closed pull request #13286: [Example] Add docstring for test optimizer and test score
URL: https://github.com/apache/incubator-mxnet/pull/13286
 
 
   

This is a PR merged from a forked repository.
As GitHub hides the original diff on merge, it is displayed below for
the sake of provenance:

As this is a foreign pull request (from a fork), the diff is supplied
below (as it won't show otherwise due to GitHub magic):

diff --git a/cpp-package/example/test_optimizer.cpp b/cpp-package/example/test_optimizer.cpp
index ee120122856..42547ea6c7c 100644
--- a/cpp-package/example/test_optimizer.cpp
+++ b/cpp-package/example/test_optimizer.cpp
@@ -15,6 +15,10 @@
  * KIND, either express or implied.  See the License for the
  * specific language governing permissions and limitations
  * under the License.
+ * 
+ * The file is used for testing if the optimizer could be created more than 1.
+ * By running: build/test_optimizer
+ * It return 0(means no error) if it succeed otherwise 1(error).
  */
 #include "mxnet-cpp/MxNetCpp.h"
 
diff --git a/cpp-package/example/test_score.cpp b/cpp-package/example/test_score.cpp
index f92560fe8f7..9252701e2ae 100644
--- a/cpp-package/example/test_score.cpp
+++ b/cpp-package/example/test_score.cpp
@@ -19,6 +19,11 @@
 
 /*!
  * Xin Li yakumolx@gmail.com
+ * The file is used for testing if the score(accurary) we get
+ * is better than the threshold we set using mlp model.
+ * By running: build/test_score 0.75
+ * 0.75 here means the threshold score
+ * It return 0 if we can achieve higher score than threshold, otherwise 1
  */
 #include <chrono>
 #include "utils.h"


 

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services