[incubator-mxnet] branch master updated: [Example] Add docstring for test optimizer and test score (#13286)

[zh...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

zhasheng pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-mxnet.git


The following commit(s) were added to refs/heads/master by this push:
     new d3f5340  [Example] Add docstring for test optimizer and test score (#13286)
d3f5340 is described below

commit d3f5340fbbd247952293fe88dea37ee85f7e5b69
Author: Jake Lee <gs...@gmail.com>
AuthorDate: Fri Nov 16 15:58:21 2018 -0800

    [Example] Add docstring for test optimizer and test score (#13286)
    
    * update the doc for test_optimizer
    
    * add docstring for test_score
---
 cpp-package/example/test_optimizer.cpp | 4 ++++
 cpp-package/example/test_score.cpp     | 5 +++++
 2 files changed, 9 insertions(+)

diff --git a/cpp-package/example/test_optimizer.cpp b/cpp-package/example/test_optimizer.cpp
index ee12012..42547ea 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 f92560f..9252701 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"