[GitHub] [incubator-mxnet] tolitius opened a new pull request #14553: [clojure]: add comp-metric based on CompositeEvalMetric

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

tolitius opened a new pull request #14553: [clojure]: add comp-metric based on CompositeEvalMetric
URL: https://github.com/apache/incubator-mxnet/pull/14553
 
 
   ## Description ##
   In order to be able to collect multiple metrics added a `comp-metric` function that can be used as:
   
   ```clojure
   => (require '[org.apache.clojure-mxnet.eval-metric :as em])
   
   => (def metric (em/comp-metric [(em/accuracy)
                                   (em/f1)
                                   (em/top-k-accuracy 2)]))
   
   => (fit ... {:eval-metric metric})
   ```
   ```
   Speed: 5.34 samples/sec	Train-accuracy=0.704545
   Speed: 5.34 samples/sec	Train-f1=0.819692
   Speed: 5.34 samples/sec	Train-top_k_accuracy=1.000000
   Speed: 5.24 samples/sec	Train-accuracy=0.764881
   Speed: 5.24 samples/sec	Train-f1=0.861308
   Speed: 5.24 samples/sec	Train-top_k_accuracy=1.000000
   ...
   ```
   
   comp metrics are read with the same `(eval-metric/get)`:
   
   ```clojure
   => (em/get metric)
   {"accuracy" 0.71634614, "f1" 0.8284848, "top_k_accuracy" 1.0}
   ```
   
   ## Checklist ##
   ### Essentials ###
   Please feel free to remove inapplicable items for your PR.
   - [ ] The PR title starts with [MXNET-$JIRA_ID], where $JIRA_ID refers to the relevant [JIRA issue](https://issues.apache.org/jira/projects/MXNET/issues) created (except PRs with tiny changes)
   - [x] Changes are complete (i.e. I finished coding on this PR)
   - [x] All changes have test coverage:
   - Unit tests are added for small changes to verify correctness (e.g. adding a new operator)
   - Nightly tests are added for complicated/long-running ones (e.g. changing distributed kvstore)
   - Build tests will be added for build configuration changes (e.g. adding a new build option with NCCL)
   - [x] Code is well-documented: 
   - For user-facing API changes, API doc string has been updated. 
   - For new C++ functions in header files, their functionalities and arguments are documented. 
   - For new examples, README.md is added to explain the what the example does, the source of the dataset, expected performance on test set and reference to the original paper if applicable
   - Check the API doc at http://mxnet-ci-doc.s3-accelerate.dualstack.amazonaws.com/PR-$PR_ID/$BUILD_ID/index.html
   - [x] To the my best knowledge, examples are either not affected by this change, or have been fixed to be compatible with this change
   
   ### Changes ###
   - [x] add `comp-metric`, tests, doc
   
   ## Comments ##
   - to remain backwards compatible `(eval-metric/get metric)` would keep returning vector for anything but `CompositeEvalMetric`, for which it will return a map
   

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to 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