Documentation error: eval_metric vs eval.metric in R mx.mlp

[Ishitori]

Description

R client's documentation of mx.mlp has a wrong name for the parameter. It is named "eval_metric" while it actually should be "eval.metric" as in mx.model.FeedForward.create. See https://github.com/apache/incubator-mxnet/blob/master/R-package/R/mlp.R

Environment info (Required)

----------Python Info----------
Version : 3.6.2
Compiler : GCC 4.2.1 Compatible Apple LLVM 8.1.0 (clang-802.0.42)
Build : ('default', 'Jul 17 2017 16:44:45')
Arch : ('64bit', '')
------------Pip Info-----------
Version : 9.0.1
Directory : /usr/local/lib/python3.6/site-packages/pip
----------MXNet Info-----------
Version : 0.11.0
Directory : /usr/local/lib/python3.6/site-packages/mxnet
Commit Hash : 53274b4a2b0d73f3fbdb10cfb5f9ed0c8263fda7
----------System Info----------
Platform : Darwin-16.7.0-x86_64-i386-64bit
system : Darwin
node : dca9048716cf.ant.amazon.com
release : 16.7.0
version : Darwin Kernel Version 16.7.0: Thu Jan 11 22:59:40 PST 2018; root:xnu-3789.73.81/RELEASE_X86_64
----------Hardware Info----------
machine : x86_64
processor : i386
b'machdep.cpu.extfeatures: SYSCALL XD 1GBPAGE EM64T LAHF LZCNT PREFETCHW RDTSCP TSCI'
b'machdep.cpu.leaf7_features: SMEP ERMS RDWRFSGS TSC_THREAD_OFFSET BMI1 HLE AVX2 BMI2 INVPCID RTM SMAP RDSEED ADX IPT SGX FPU_CSDS MPX CLFSOPT'
b'machdep.cpu.features: FPU VME DE PSE TSC MSR PAE MCE CX8 APIC SEP MTRR PGE MCA CMOV PAT PSE36 CLFSH DS ACPI MMX FXSR SSE SSE2 SS HTT TM PBE SSE3 PCLMULQDQ DTES64 MON DSCPL VMX SMX EST TM2 SSSE3 FMA CX16 TPR PDCM SSE4.1 SSE4.2 x2APIC MOVBE POPCNT AES PCID XSAVE OSXSAVE SEGLIM64 TSCTMR AVX1.0 RDRAND F16C'
b'machdep.cpu.brand_string: Intel(R) Core(TM) i7-7660U CPU @ 2.50GHz'
----------Network Test----------
Setting timeout: 10
Timing for MXNet: https://github.com/apache/incubator-mxnet, DNS: 0.0030 sec, LOAD: 0.6859 sec.
Timing for Gluon Tutorial(en): http://gluon.mxnet.io, DNS: 0.0009 sec, LOAD: 0.1113 sec.
Timing for Gluon Tutorial(cn): https://zh.gluon.ai, DNS: 0.0015 sec, LOAD: 0.2410 sec.
Timing for FashionMNIST: https://apache-mxnet.s3-accelerate.dualstack.amazonaws.com/gluon/dataset/fashion-mnist/train-labels-idx1-ubyte.gz, DNS: 0.0007 sec, LOAD: 0.2651 sec.
Timing for PYPI: https://pypi.python.org/pypi/pip, DNS: 0.0008 sec, LOAD: 0.2126 sec.
Timing for Conda: https://repo.continuum.io/pkgs/free/, DNS: 0.0006 sec, LOAD: 0.1419 sec.
sssokolo@dca9048716cf  /Volumes/Unix/workspace/MxNet/stack-exchange-qa  ls
45798125.py 48292162_rmse_version.R Data_breastcancer.csv diagnose.py
46195917.R 48292162_softmax_version.R Untitled.ipynb notMNIST.npz
48292162.R 48490010.R breast-cancer-wisconsin.data
sssokolo@dca9048716cf  /Volumes/Unix/workspace/MxNet/stack-exchange-qa  python3 diagnose.py
----------Python Info----------
Version : 3.6.2
Compiler : GCC 4.2.1 Compatible Apple LLVM 8.1.0 (clang-802.0.42)
Build : ('default', 'Jul 17 2017 16:44:45')
Arch : ('64bit', '')
------------Pip Info-----------
Version : 9.0.1
Directory : /usr/local/lib/python3.6/site-packages/pip
----------MXNet Info-----------
Version : 0.11.0
Directory : /usr/local/lib/python3.6/site-packages/mxnet
Commit Hash : 53274b4a2b0d73f3fbdb10cfb5f9ed0c8263fda7
----------System Info----------
Platform : Darwin-16.7.0-x86_64-i386-64bit
system : Darwin
node : dca9048716cf.ant.amazon.com
release : 16.7.0
version : Darwin Kernel Version 16.7.0: Thu Jan 11 22:59:40 PST 2018; root:xnu-3789.73.81/RELEASE_X86_64
----------Hardware Info----------
machine : x86_64
processor : i386
b'machdep.cpu.extfeatures: SYSCALL XD 1GBPAGE EM64T LAHF LZCNT PREFETCHW RDTSCP TSCI'
b'machdep.cpu.leaf7_features: SMEP ERMS RDWRFSGS TSC_THREAD_OFFSET BMI1 HLE AVX2 BMI2 INVPCID RTM SMAP RDSEED ADX IPT SGX FPU_CSDS MPX CLFSOPT'
b'machdep.cpu.features: FPU VME DE PSE TSC MSR PAE MCE CX8 APIC SEP MTRR PGE MCA CMOV PAT PSE36 CLFSH DS ACPI MMX FXSR SSE SSE2 SS HTT TM PBE SSE3 PCLMULQDQ DTES64 MON DSCPL VMX SMX EST TM2 SSSE3 FMA CX16 TPR PDCM SSE4.1 SSE4.2 x2APIC MOVBE POPCNT AES PCID XSAVE OSXSAVE SEGLIM64 TSCTMR AVX1.0 RDRAND F16C'
b'machdep.cpu.brand_string: Intel(R) Core(TM) i7-7660U CPU @ 2.50GHz'
----------Network Test----------
Setting timeout: 10
Timing for MXNet: https://github.com/apache/incubator-mxnet, DNS: 0.0560 sec, LOAD: 0.7075 sec.
Timing for Gluon Tutorial(en): http://gluon.mxnet.io, DNS: 0.0598 sec, LOAD: 0.2979 sec.
Timing for Gluon Tutorial(cn): https://zh.gluon.ai, DNS: 0.1063 sec, LOAD: 0.3277 sec.
Timing for FashionMNIST: https://apache-mxnet.s3-accelerate.dualstack.amazonaws.com/gluon/dataset/fashion-mnist/train-labels-idx1-ubyte.gz, DNS: 0.0712 sec, LOAD: 0.3575 sec.
Timing for PYPI: https://pypi.python.org/pypi/pip, DNS: 0.0525 sec, LOAD: 0.3438 sec.
Timing for Conda: https://repo.continuum.io/pkgs/free/, DNS: 0.0496 sec, LOAD: 0.1986 sec.

Package used (Python/R/Scala/Julia):
R

For R user, please provide R sessionInfo():
R version 3.4.3 (2017-11-30)
Platform: x86_64-apple-darwin15.6.0 (64-bit)
Running under: macOS Sierra 10.12.6

Matrix products: default
BLAS: /System/Library/Frameworks/Accelerate.framework/Versions/A/Frameworks/vecLib.framework/Versions/A/libBLAS.dylib
LAPACK: /Library/Frameworks/R.framework/Versions/3.4/Resources/lib/libRlapack.dylib

locale:
[1] en_CA.UTF-8/en_CA.UTF-8/en_CA.UTF-8/C/en_CA.UTF-8/en_CA.UTF-8

attached base packages:
[1] stats graphics grDevices utils datasets methods base

other attached packages:
[1] mxnet_0.10.1

loaded via a namespace (and not attached):
[1] Rcpp_0.12.14 pillar_1.1.0 compiler_3.4.3 RColorBrewer_1.1-2 influenceR_0.1.0 plyr_1.8.4
[7] bindr_0.1 viridis_0.4.1 tools_3.4.3 digest_0.6.14 jsonlite_1.5 viridisLite_0.2.0
[13] tibble_1.4.1 gtable_0.2.0 rgexf_0.15.3 pkgconfig_2.0.1 rlang_0.1.6 igraph_1.1.2
[19] rstudioapi_0.7 yaml_2.1.16 bindrcpp_0.2 gridExtra_2.3 downloader_0.4 DiagrammeR_0.9.2
[25] dplyr_0.7.4 stringr_1.2.0 htmlwidgets_0.9 hms_0.4.0 grid_3.4.3 glue_1.2.0
[31] R6_2.2.2 Rook_1.1-1 XML_3.98-1.9 readr_1.1.1 purrr_0.2.4 tidyr_0.7.2
[37] ggplot2_2.2.1 magrittr_1.5 codetools_0.2-15 scales_0.5.0 htmltools_0.3.6 assertthat_0.2.0
[43] colorspace_1.3-2 brew_1.0-6 stringi_1.1.6 visNetwork_2.0.3 lazyeval_0.2.1 munsell_0.4.3

Error Message:

Error in mx.opt.sgd(...) :
unused argument (eval_metric = list(init = function ()
{
c(0, 0)
}, update = function (label, pred, state)
{
m <- feval(as.array(label), as.array(pred))
state <- c(state[[1]] + 1, state[[2]] + m)
return(state)
}, get = function (state)
{
list(name = name, value = (state[[2]]/state[[1]]))
}))

[Ishitori]

Fix has been merged.