| <!DOCTYPE html> |
| |
| <html xmlns="http://www.w3.org/1999/xhtml"> |
| <head> |
| <meta charset="utf-8" /> |
| <meta charset="utf-8"> |
| <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"> |
| <meta http-equiv="x-ua-compatible" content="ie=edge"> |
| <style> |
| .dropdown { |
| position: relative; |
| display: inline-block; |
| } |
| |
| .dropdown-content { |
| display: none; |
| position: absolute; |
| background-color: #f9f9f9; |
| min-width: 160px; |
| box-shadow: 0px 8px 16px 0px rgba(0,0,0,0.2); |
| padding: 12px 16px; |
| z-index: 1; |
| text-align: left; |
| } |
| |
| .dropdown:hover .dropdown-content { |
| display: block; |
| } |
| |
| .dropdown-option:hover { |
| color: #FF4500; |
| } |
| |
| .dropdown-option-active { |
| color: #FF4500; |
| font-weight: lighter; |
| } |
| |
| .dropdown-option { |
| color: #000000; |
| font-weight: lighter; |
| } |
| |
| .dropdown-header { |
| color: #FFFFFF; |
| display: inline-flex; |
| } |
| |
| .dropdown-caret { |
| width: 18px; |
| height: 54px; |
| } |
| |
| .dropdown-caret-path { |
| fill: #FFFFFF; |
| } |
| </style> |
| |
| <title>gluon.metric — Apache MXNet documentation</title> |
| |
| <link rel="stylesheet" href="../../../_static/basic.css" type="text/css" /> |
| <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" /> |
| <link rel="stylesheet" type="text/css" href="../../../_static/mxnet.css" /> |
| <link rel="stylesheet" href="../../../_static/material-design-lite-1.3.0/material.blue-deep_orange.min.css" type="text/css" /> |
| <link rel="stylesheet" href="../../../_static/sphinx_materialdesign_theme.css" type="text/css" /> |
| <link rel="stylesheet" href="../../../_static/fontawesome/all.css" type="text/css" /> |
| <link rel="stylesheet" href="../../../_static/fonts.css" type="text/css" /> |
| <link rel="stylesheet" href="../../../_static/feedback.css" type="text/css" /> |
| <script id="documentation_options" data-url_root="../../../" src="../../../_static/documentation_options.js"></script> |
| <script src="../../../_static/jquery.js"></script> |
| <script src="../../../_static/underscore.js"></script> |
| <script src="../../../_static/doctools.js"></script> |
| <script src="../../../_static/language_data.js"></script> |
| <script src="../../../_static/matomo_analytics.js"></script> |
| <script src="../../../_static/autodoc.js"></script> |
| <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script> |
| <script async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/latest.js?config=TeX-AMS-MML_HTMLorMML"></script> |
| <script type="text/x-mathjax-config">MathJax.Hub.Config({"tex2jax": {"inlineMath": [["$", "$"], ["\\(", "\\)"]], "processEscapes": true, "ignoreClass": "document", "processClass": "math|output_area"}})</script> |
| <script src="../../../_static/sphinx_materialdesign_theme.js"></script> |
| <link rel="shortcut icon" href="../../../_static/mxnet-icon.png"/> |
| <link rel="index" title="Index" href="../../../genindex.html" /> |
| <link rel="search" title="Search" href="../../../search.html" /> |
| <link rel="next" title="gluon.model_zoo.vision" href="../model_zoo/index.html" /> |
| <link rel="prev" title="gluon.loss" href="../loss/index.html" /> |
| </head> |
| <body><header class="site-header" role="banner"> |
| <div class="wrapper"> |
| <a class="site-title" rel="author" href="/"><img |
| src="../../../_static/mxnet_logo.png" class="site-header-logo"></a> |
| <nav class="site-nav"> |
| <input type="checkbox" id="nav-trigger" class="nav-trigger"/> |
| <label for="nav-trigger"> |
| <span class="menu-icon"> |
| <svg viewBox="0 0 18 15" width="18px" height="15px"> |
| <path d="M18,1.484c0,0.82-0.665,1.484-1.484,1.484H1.484C0.665,2.969,0,2.304,0,1.484l0,0C0,0.665,0.665,0,1.484,0 h15.032C17.335,0,18,0.665,18,1.484L18,1.484z M18,7.516C18,8.335,17.335,9,16.516,9H1.484C0.665,9,0,8.335,0,7.516l0,0 c0-0.82,0.665-1.484,1.484-1.484h15.032C17.335,6.031,18,6.696,18,7.516L18,7.516z M18,13.516C18,14.335,17.335,15,16.516,15H1.484 C0.665,15,0,14.335,0,13.516l0,0c0-0.82,0.665-1.483,1.484-1.483h15.032C17.335,12.031,18,12.695,18,13.516L18,13.516z"/> |
| </svg> |
| </span> |
| </label> |
| |
| <div class="trigger"> |
| <a class="page-link" href="/get_started">Get Started</a> |
| <a class="page-link" href="/features">Features</a> |
| <a class="page-link" href="/ecosystem">Ecosystem</a> |
| <a class="page-link page-current" href="/api">Docs & Tutorials</a> |
| <a class="page-link" href="/trusted_by">Trusted By</a> |
| <a class="page-link" href="https://github.com/apache/mxnet">GitHub</a> |
| <div class="dropdown" style="min-width:100px"> |
| <span class="dropdown-header">Apache |
| <svg class="dropdown-caret" viewBox="0 0 32 32" class="icon icon-caret-bottom" aria-hidden="true"><path class="dropdown-caret-path" d="M24 11.305l-7.997 11.39L8 11.305z"></path></svg> |
| </span> |
| <div class="dropdown-content" style="min-width:250px"> |
| <a href="https://www.apache.org/foundation/">Apache Software Foundation</a> |
| <a href="https://incubator.apache.org/">Apache Incubator</a> |
| <a href="https://www.apache.org/licenses/">License</a> |
| <a href="/versions/1.9.1/api/faq/security.html">Security</a> |
| <a href="https://privacy.apache.org/policies/privacy-policy-public.html">Privacy</a> |
| <a href="https://www.apache.org/events/current-event">Events</a> |
| <a href="https://www.apache.org/foundation/sponsorship.html">Sponsorship</a> |
| <a href="https://www.apache.org/foundation/thanks.html">Thanks</a> |
| </div> |
| </div> |
| <div class="dropdown"> |
| <span class="dropdown-header">master |
| <svg class="dropdown-caret" viewBox="0 0 32 32" class="icon icon-caret-bottom" aria-hidden="true"><path class="dropdown-caret-path" d="M24 11.305l-7.997 11.39L8 11.305z"></path></svg> |
| </span> |
| <div class="dropdown-content"> |
| <a class="dropdown-option-active" href="/versions/master/">master</a><br> |
| <a class="dropdown-option" href="/versions/1.9.1/">1.9.1</a><br> |
| <a class="dropdown-option" href="/versions/1.8.0/">1.8.0</a><br> |
| <a class="dropdown-option" href="/versions/1.7.0/">1.7.0</a><br> |
| <a class="dropdown-option" href="/versions/1.6.0/">1.6.0</a><br> |
| <a class="dropdown-option" href="/versions/1.5.0/">1.5.0</a><br> |
| <a class="dropdown-option" href="/versions/1.4.1/">1.4.1</a><br> |
| <a class="dropdown-option" href="/versions/1.3.1/">1.3.1</a><br> |
| <a class="dropdown-option" href="/versions/1.2.1/">1.2.1</a><br> |
| <a class="dropdown-option" href="/versions/1.1.0/">1.1.0</a><br> |
| <a class="dropdown-option" href="/versions/1.0.0/">1.0.0</a><br> |
| <a class="dropdown-option" href="/versions/0.12.1/">0.12.1</a><br> |
| <a class="dropdown-option" href="/versions/0.11.0/">0.11.0</a> |
| </div> |
| </div> |
| </div> |
| </nav> |
| </div> |
| </header> |
| <div class="mdl-layout mdl-js-layout mdl-layout--fixed-header mdl-layout--fixed-drawer"><header class="mdl-layout__header mdl-layout__header--waterfall "> |
| <div class="mdl-layout__header-row"> |
| |
| <nav class="mdl-navigation breadcrumb"> |
| <a class="mdl-navigation__link" href="../../index.html">Python API</a><i class="material-icons">navigate_next</i> |
| <a class="mdl-navigation__link" href="../index.html">mxnet.gluon</a><i class="material-icons">navigate_next</i> |
| <a class="mdl-navigation__link is-active">gluon.metric</a> |
| </nav> |
| <div class="mdl-layout-spacer"></div> |
| <nav class="mdl-navigation"> |
| |
| <form class="form-inline pull-sm-right" action="../../../search.html" method="get"> |
| <div class="mdl-textfield mdl-js-textfield mdl-textfield--expandable mdl-textfield--floating-label mdl-textfield--align-right"> |
| <label id="quick-search-icon" class="mdl-button mdl-js-button mdl-button--icon" for="waterfall-exp"> |
| <i class="material-icons">search</i> |
| </label> |
| <div class="mdl-textfield__expandable-holder"> |
| <input class="mdl-textfield__input" type="text" name="q" id="waterfall-exp" placeholder="Search" /> |
| <input type="hidden" name="check_keywords" value="yes" /> |
| <input type="hidden" name="area" value="default" /> |
| </div> |
| </div> |
| <div class="mdl-tooltip" data-mdl-for="quick-search-icon"> |
| Quick search |
| </div> |
| </form> |
| |
| <a id="button-show-github" |
| href="https://github.com/apache/mxnet/edit/master/docs/python_docs/python/api/gluon/metric/index.rst" class="mdl-button mdl-js-button mdl-button--icon"> |
| <i class="material-icons">edit</i> |
| </a> |
| <div class="mdl-tooltip" data-mdl-for="button-show-github"> |
| Edit on Github |
| </div> |
| </nav> |
| </div> |
| <div class="mdl-layout__header-row header-links"> |
| <div class="mdl-layout-spacer"></div> |
| <nav class="mdl-navigation"> |
| </nav> |
| </div> |
| </header><header class="mdl-layout__drawer"> |
| |
| <div class="globaltoc"> |
| <span class="mdl-layout-title toc">Table Of Contents</span> |
| |
| |
| |
| <nav class="mdl-navigation"> |
| <ul class="current"> |
| <li class="toctree-l1"><a class="reference internal" href="../../../tutorials/index.html">Python Tutorials</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="../../../tutorials/getting-started/index.html">Getting Started</a><ul> |
| <li class="toctree-l3"><a class="reference internal" href="../../../tutorials/getting-started/crash-course/index.html">Crash Course</a><ul> |
| <li class="toctree-l4"><a class="reference internal" href="../../../tutorials/getting-started/crash-course/0-introduction.html">Introduction</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="../../../tutorials/getting-started/crash-course/1-nparray.html">Step 1: Manipulate data with NP on MXNet</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="../../../tutorials/getting-started/crash-course/2-create-nn.html">Step 2: Create a neural network</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="../../../tutorials/getting-started/crash-course/3-autograd.html">Step 3: Automatic differentiation with autograd</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="../../../tutorials/getting-started/crash-course/4-components.html">Step 4: Necessary components that are not in the network</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="../../../tutorials/getting-started/crash-course/5-datasets.html">Step 5: <code class="docutils literal notranslate"><span class="pre">Dataset</span></code>s and <code class="docutils literal notranslate"><span class="pre">DataLoader</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="../../../tutorials/getting-started/crash-course/5-datasets.html#Using-own-data-with-included-Datasets">Using own data with included <code class="docutils literal notranslate"><span class="pre">Dataset</span></code>s</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="../../../tutorials/getting-started/crash-course/5-datasets.html#Using-your-own-data-with-custom-Datasets">Using your own data with custom <code class="docutils literal notranslate"><span class="pre">Dataset</span></code>s</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="../../../tutorials/getting-started/crash-course/5-datasets.html#New-in-MXNet-2.0:-faster-C++-backend-dataloaders">New in MXNet 2.0: faster C++ backend dataloaders</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="../../../tutorials/getting-started/crash-course/6-train-nn.html">Step 6: Train a Neural Network</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="../../../tutorials/getting-started/crash-course/7-use-gpus.html">Step 7: Load and Run a NN using GPU</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l3"><a class="reference internal" href="../../../tutorials/getting-started/to-mxnet/index.html">Moving to MXNet from Other Frameworks</a><ul> |
| <li class="toctree-l4"><a class="reference internal" href="../../../tutorials/getting-started/to-mxnet/pytorch.html">PyTorch vs Apache MXNet</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l3"><a class="reference internal" href="../../../tutorials/getting-started/gluon_from_experiment_to_deployment.html">Gluon: from experiment to deployment</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../../tutorials/getting-started/gluon_migration_guide.html">Gluon2.0: Migration Guide</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../../tutorials/getting-started/logistic_regression_explained.html">Logistic regression explained</a></li> |
| <li class="toctree-l3"><a class="reference external" href="https://mxnet.apache.org/api/python/docs/tutorials/packages/gluon/image/mnist.html">MNIST</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l2"><a class="reference internal" href="../../../tutorials/packages/index.html">Packages</a><ul> |
| <li class="toctree-l3"><a class="reference internal" href="../../../tutorials/packages/autograd/index.html">Automatic Differentiation</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../../tutorials/packages/gluon/index.html">Gluon</a><ul> |
| <li class="toctree-l4"><a class="reference internal" href="../../../tutorials/packages/gluon/blocks/index.html">Blocks</a><ul> |
| <li class="toctree-l5"><a class="reference internal" href="../../../tutorials/packages/gluon/blocks/custom-layer.html">Custom Layers</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../../tutorials/packages/gluon/blocks/hybridize.html">Hybridize</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../../tutorials/packages/gluon/blocks/init.html">Initialization</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../../tutorials/packages/gluon/blocks/naming.html">Parameter and Block Naming</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../../tutorials/packages/gluon/blocks/nn.html">Layers and Blocks</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../../tutorials/packages/gluon/blocks/parameters.html">Parameter Management</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../../tutorials/packages/gluon/blocks/save_load_params.html">Saving and Loading Gluon Models</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../../tutorials/packages/gluon/blocks/activations/activations.html">Activation Blocks</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l4"><a class="reference internal" href="../../../tutorials/packages/gluon/data/index.html">Data Tutorials</a><ul> |
| <li class="toctree-l5"><a class="reference internal" href="../../../tutorials/packages/gluon/data/data_augmentation.html">Image Augmentation</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../../tutorials/packages/gluon/data/datasets.html">Gluon <code class="docutils literal notranslate"><span class="pre">Dataset</span></code>s and <code class="docutils literal notranslate"><span class="pre">DataLoader</span></code></a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../../tutorials/packages/gluon/data/datasets.html#Using-own-data-with-included-Datasets">Using own data with included <code class="docutils literal notranslate"><span class="pre">Dataset</span></code>s</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../../tutorials/packages/gluon/data/datasets.html#Using-own-data-with-custom-Datasets">Using own data with custom <code class="docutils literal notranslate"><span class="pre">Dataset</span></code>s</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../../tutorials/packages/gluon/data/datasets.html#Appendix:-Upgrading-from-Module-DataIter-to-Gluon-DataLoader">Appendix: Upgrading from Module <code class="docutils literal notranslate"><span class="pre">DataIter</span></code> to Gluon <code class="docutils literal notranslate"><span class="pre">DataLoader</span></code></a></li> |
| </ul> |
| </li> |
| <li class="toctree-l4"><a class="reference internal" href="../../../tutorials/packages/gluon/image/index.html">Image Tutorials</a><ul> |
| <li class="toctree-l5"><a class="reference internal" href="../../../tutorials/packages/gluon/image/info_gan.html">Image similarity search with InfoGAN</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../../tutorials/packages/gluon/image/mnist.html">Handwritten Digit Recognition</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l4"><a class="reference internal" href="../../../tutorials/packages/gluon/loss/index.html">Losses</a><ul> |
| <li class="toctree-l5"><a class="reference internal" href="../../../tutorials/packages/gluon/loss/custom-loss.html">Custom Loss Blocks</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../../tutorials/packages/gluon/loss/kl_divergence.html">Kullback-Leibler (KL) Divergence</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../../tutorials/packages/gluon/loss/loss.html">Loss functions</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l4"><a class="reference internal" href="../../../tutorials/packages/gluon/text/index.html">Text Tutorials</a><ul> |
| <li class="toctree-l5"><a class="reference internal" href="../../../tutorials/packages/gluon/text/gnmt.html">Google Neural Machine Translation</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../../tutorials/packages/gluon/text/transformer.html">Machine Translation with Transformer</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l4"><a class="reference internal" href="../../../tutorials/packages/gluon/training/index.html">Training</a><ul> |
| <li class="toctree-l5"><a class="reference internal" href="../../../tutorials/packages/gluon/training/fit_api_tutorial.html">MXNet Gluon Fit API</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../../tutorials/packages/gluon/training/trainer.html">Trainer</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../../tutorials/packages/gluon/training/learning_rates/index.html">Learning Rates</a><ul> |
| <li class="toctree-l6"><a class="reference internal" href="../../../tutorials/packages/gluon/training/learning_rates/learning_rate_finder.html">Learning Rate Finder</a></li> |
| <li class="toctree-l6"><a class="reference internal" href="../../../tutorials/packages/gluon/training/learning_rates/learning_rate_schedules.html">Learning Rate Schedules</a></li> |
| <li class="toctree-l6"><a class="reference internal" href="../../../tutorials/packages/gluon/training/learning_rates/learning_rate_schedules_advanced.html">Advanced Learning Rate Schedules</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l5"><a class="reference internal" href="../../../tutorials/packages/gluon/training/normalization/index.html">Normalization Blocks</a></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| <li class="toctree-l3"><a class="reference internal" href="../../../tutorials/packages/kvstore/index.html">KVStore</a><ul> |
| <li class="toctree-l4"><a class="reference internal" href="../../../tutorials/packages/kvstore/kvstore.html">Distributed Key-Value Store</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l3"><a class="reference internal" href="../../../tutorials/packages/legacy/index.html">Legacy</a><ul> |
| <li class="toctree-l4"><a class="reference internal" href="../../../tutorials/packages/legacy/ndarray/index.html">NDArray</a><ul> |
| <li class="toctree-l5"><a class="reference internal" href="../../../tutorials/packages/legacy/ndarray/01-ndarray-intro.html">An Intro: Manipulate Data the MXNet Way with NDArray</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../../tutorials/packages/legacy/ndarray/02-ndarray-operations.html">NDArray Operations</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../../tutorials/packages/legacy/ndarray/03-ndarray-contexts.html">NDArray Contexts</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../../tutorials/packages/legacy/ndarray/gotchas_numpy_in_mxnet.html">Gotchas using NumPy in Apache MXNet</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../../tutorials/packages/legacy/ndarray/sparse/index.html">Tutorials</a><ul> |
| <li class="toctree-l6"><a class="reference internal" href="../../../tutorials/packages/legacy/ndarray/sparse/csr.html">CSRNDArray - NDArray in Compressed Sparse Row Storage Format</a></li> |
| <li class="toctree-l6"><a class="reference internal" href="../../../tutorials/packages/legacy/ndarray/sparse/row_sparse.html">RowSparseNDArray - NDArray for Sparse Gradient Updates</a></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| <li class="toctree-l3"><a class="reference internal" href="../../../tutorials/packages/np/index.html">What is NP on MXNet</a><ul> |
| <li class="toctree-l4"><a class="reference internal" href="../../../tutorials/packages/np/cheat-sheet.html">The NP on MXNet cheat sheet</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="../../../tutorials/packages/np/np-vs-numpy.html">Differences between NP on MXNet and NumPy</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l3"><a class="reference internal" href="../../../tutorials/packages/onnx/index.html">ONNX</a><ul> |
| <li class="toctree-l4"><a class="reference internal" href="../../../tutorials/packages/onnx/fine_tuning_gluon.html">Fine-tuning an ONNX model</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="../../../tutorials/packages/onnx/inference_on_onnx_model.html">Running inference on MXNet/Gluon from an ONNX model</a></li> |
| <li class="toctree-l4"><a class="reference external" href="https://mxnet.apache.org/api/python/docs/tutorials/deploy/export/onnx.html">Export ONNX Models</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l3"><a class="reference internal" href="../../../tutorials/packages/optimizer/index.html">Optimizers</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../../tutorials/packages/viz/index.html">Visualization</a><ul> |
| <li class="toctree-l4"><a class="reference external" href="https://mxnet.apache.org/api/faq/visualize_graph">Visualize networks</a></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| <li class="toctree-l2"><a class="reference internal" href="../../../tutorials/performance/index.html">Performance</a><ul> |
| <li class="toctree-l3"><a class="reference internal" href="../../../tutorials/performance/compression/index.html">Compression</a><ul> |
| <li class="toctree-l4"><a class="reference internal" href="../../../tutorials/performance/compression/int8.html">Deploy with int-8</a></li> |
| <li class="toctree-l4"><a class="reference external" href="https://mxnet.apache.org/api/faq/float16">Float16</a></li> |
| <li class="toctree-l4"><a class="reference external" href="https://mxnet.apache.org/api/faq/gradient_compression">Gradient Compression</a></li> |
| <li class="toctree-l4"><a class="reference external" href="https://gluon-cv.mxnet.io/build/examples_deployment/int8_inference.html">GluonCV with Quantized Models</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l3"><a class="reference internal" href="../../../tutorials/performance/backend/index.html">Accelerated Backend Tools</a><ul> |
| <li class="toctree-l4"><a class="reference internal" href="../../../tutorials/performance/backend/dnnl/index.html">oneDNN</a><ul> |
| <li class="toctree-l5"><a class="reference internal" href="../../../tutorials/performance/backend/dnnl/dnnl_readme.html">Install MXNet with oneDNN</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../../tutorials/performance/backend/dnnl/dnnl_quantization.html">oneDNN Quantization</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../../tutorials/performance/backend/dnnl/dnnl_quantization_inc.html">Improving accuracy with Intel® Neural Compressor</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l4"><a class="reference internal" href="../../../tutorials/performance/backend/tvm.html">Use TVM</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="../../../tutorials/performance/backend/profiler.html">Profiling MXNet Models</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="../../../tutorials/performance/backend/amp.html">Using AMP: Automatic Mixed Precision</a></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| <li class="toctree-l2"><a class="reference internal" href="../../../tutorials/deploy/index.html">Deployment</a><ul> |
| <li class="toctree-l3"><a class="reference internal" href="../../../tutorials/deploy/export/index.html">Export</a><ul> |
| <li class="toctree-l4"><a class="reference internal" href="../../../tutorials/deploy/export/onnx.html">Exporting to ONNX format</a></li> |
| <li class="toctree-l4"><a class="reference external" href="https://gluon-cv.mxnet.io/build/examples_deployment/export_network.html">Export Gluon CV Models</a></li> |
| <li class="toctree-l4"><a class="reference external" href="https://mxnet.apache.org/api/python/docs/tutorials/packages/gluon/blocks/save_load_params.html">Save / Load Parameters</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l3"><a class="reference internal" href="../../../tutorials/deploy/inference/index.html">Inference</a><ul> |
| <li class="toctree-l4"><a class="reference internal" href="../../../tutorials/deploy/inference/cpp.html">Deploy into C++</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="../../../tutorials/deploy/inference/image_classification_jetson.html">Image Classication using pretrained ResNet-50 model on Jetson module</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l3"><a class="reference internal" href="../../../tutorials/deploy/run-on-aws/index.html">Run on AWS</a><ul> |
| <li class="toctree-l4"><a class="reference internal" href="../../../tutorials/deploy/run-on-aws/use_ec2.html">Run on an EC2 Instance</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="../../../tutorials/deploy/run-on-aws/use_sagemaker.html">Run on Amazon SageMaker</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="../../../tutorials/deploy/run-on-aws/cloud.html">MXNet on the Cloud</a></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| <li class="toctree-l2"><a class="reference internal" href="../../../tutorials/extend/index.html">Extend</a><ul> |
| <li class="toctree-l3"><a class="reference internal" href="../../../tutorials/extend/customop.html">Custom Numpy Operators</a></li> |
| <li class="toctree-l3"><a class="reference external" href="https://mxnet.apache.org/api/faq/new_op">New Operator Creation</a></li> |
| <li class="toctree-l3"><a class="reference external" href="https://mxnet.apache.org/api/faq/add_op_in_backend">New Operator in MXNet Backend</a></li> |
| <li class="toctree-l3"><a class="reference external" href="https://mxnet.apache.org/api/faq/using_rtc">Using RTC for CUDA kernels</a></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| <li class="toctree-l1 current"><a class="reference internal" href="../../index.html">Python API</a><ul class="current"> |
| <li class="toctree-l2"><a class="reference internal" href="../../np/index.html">mxnet.np</a><ul> |
| <li class="toctree-l3"><a class="reference internal" href="../../np/arrays.html">Array objects</a><ul> |
| <li class="toctree-l4"><a class="reference internal" href="../../np/arrays.ndarray.html">The N-dimensional array (<code class="xref py py-class docutils literal notranslate"><span class="pre">ndarray</span></code>)</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="../../np/arrays.indexing.html">Indexing</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l3"><a class="reference internal" href="../../np/routines.html">Routines</a><ul> |
| <li class="toctree-l4"><a class="reference internal" href="../../np/routines.array-creation.html">Array creation routines</a><ul> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.eye.html">mxnet.np.eye</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.empty.html">mxnet.np.empty</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.full.html">mxnet.np.full</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.identity.html">mxnet.np.identity</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.ones.html">mxnet.np.ones</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.ones_like.html">mxnet.np.ones_like</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.zeros.html">mxnet.np.zeros</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.zeros_like.html">mxnet.np.zeros_like</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.array.html">mxnet.np.array</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.copy.html">mxnet.np.copy</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.arange.html">mxnet.np.arange</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.linspace.html">mxnet.np.linspace</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.logspace.html">mxnet.np.logspace</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.meshgrid.html">mxnet.np.meshgrid</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.tril.html">mxnet.np.tril</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l4"><a class="reference internal" href="../../np/routines.array-manipulation.html">Array manipulation routines</a><ul> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.reshape.html">mxnet.np.reshape</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.ravel.html">mxnet.np.ravel</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.ndarray.flatten.html">mxnet.np.ndarray.flatten</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.swapaxes.html">mxnet.np.swapaxes</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.ndarray.T.html">mxnet.np.ndarray.T</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.transpose.html">mxnet.np.transpose</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.moveaxis.html">mxnet.np.moveaxis</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.rollaxis.html">mxnet.np.rollaxis</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.expand_dims.html">mxnet.np.expand_dims</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.squeeze.html">mxnet.np.squeeze</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.broadcast_to.html">mxnet.np.broadcast_to</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.broadcast_arrays.html">mxnet.np.broadcast_arrays</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.atleast_1d.html">mxnet.np.atleast_1d</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.atleast_2d.html">mxnet.np.atleast_2d</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.atleast_3d.html">mxnet.np.atleast_3d</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.concatenate.html">mxnet.np.concatenate</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.stack.html">mxnet.np.stack</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.dstack.html">mxnet.np.dstack</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.vstack.html">mxnet.np.vstack</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.column_stack.html">mxnet.np.column_stack</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.hstack.html">mxnet.np.hstack</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.split.html">mxnet.np.split</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.hsplit.html">mxnet.np.hsplit</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.vsplit.html">mxnet.np.vsplit</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.array_split.html">mxnet.np.array_split</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.dsplit.html">mxnet.np.dsplit</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.tile.html">mxnet.np.tile</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.repeat.html">mxnet.np.repeat</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.unique.html">mxnet.np.unique</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.delete.html">mxnet.np.delete</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.insert.html">mxnet.np.insert</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.append.html">mxnet.np.append</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.resize.html">mxnet.np.resize</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.trim_zeros.html">mxnet.np.trim_zeros</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.reshape.html">mxnet.np.reshape</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.flip.html">mxnet.np.flip</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.roll.html">mxnet.np.roll</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.rot90.html">mxnet.np.rot90</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.fliplr.html">mxnet.np.fliplr</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.flipud.html">mxnet.np.flipud</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l4"><a class="reference internal" href="../../np/routines.io.html">Input and output</a><ul> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.genfromtxt.html">mxnet.np.genfromtxt</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.ndarray.tolist.html">mxnet.np.ndarray.tolist</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.set_printoptions.html">mxnet.np.set_printoptions</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l4"><a class="reference internal" href="../../np/routines.linalg.html">Linear algebra (<code class="xref py py-mod docutils literal notranslate"><span class="pre">numpy.linalg</span></code>)</a><ul> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.dot.html">mxnet.np.dot</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.vdot.html">mxnet.np.vdot</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.inner.html">mxnet.np.inner</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.outer.html">mxnet.np.outer</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.tensordot.html">mxnet.np.tensordot</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.einsum.html">mxnet.np.einsum</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.linalg.multi_dot.html">mxnet.np.linalg.multi_dot</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.matmul.html">mxnet.np.matmul</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.linalg.matrix_power.html">mxnet.np.linalg.matrix_power</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.kron.html">mxnet.np.kron</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.linalg.svd.html">mxnet.np.linalg.svd</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.linalg.cholesky.html">mxnet.np.linalg.cholesky</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.linalg.qr.html">mxnet.np.linalg.qr</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.linalg.eig.html">mxnet.np.linalg.eig</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.linalg.eigh.html">mxnet.np.linalg.eigh</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.linalg.eigvals.html">mxnet.np.linalg.eigvals</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.linalg.eigvalsh.html">mxnet.np.linalg.eigvalsh</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.linalg.norm.html">mxnet.np.linalg.norm</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.trace.html">mxnet.np.trace</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.linalg.cond.html">mxnet.np.linalg.cond</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.linalg.det.html">mxnet.np.linalg.det</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.linalg.matrix_rank.html">mxnet.np.linalg.matrix_rank</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.linalg.slogdet.html">mxnet.np.linalg.slogdet</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.linalg.solve.html">mxnet.np.linalg.solve</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.linalg.tensorsolve.html">mxnet.np.linalg.tensorsolve</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.linalg.lstsq.html">mxnet.np.linalg.lstsq</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.linalg.inv.html">mxnet.np.linalg.inv</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.linalg.pinv.html">mxnet.np.linalg.pinv</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.linalg.tensorinv.html">mxnet.np.linalg.tensorinv</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l4"><a class="reference internal" href="../../np/routines.math.html">Mathematical functions</a><ul> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.sin.html">mxnet.np.sin</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.cos.html">mxnet.np.cos</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.tan.html">mxnet.np.tan</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.arcsin.html">mxnet.np.arcsin</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.arccos.html">mxnet.np.arccos</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.arctan.html">mxnet.np.arctan</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.degrees.html">mxnet.np.degrees</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.radians.html">mxnet.np.radians</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.hypot.html">mxnet.np.hypot</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.arctan2.html">mxnet.np.arctan2</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.deg2rad.html">mxnet.np.deg2rad</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.rad2deg.html">mxnet.np.rad2deg</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.unwrap.html">mxnet.np.unwrap</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.sinh.html">mxnet.np.sinh</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.cosh.html">mxnet.np.cosh</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.tanh.html">mxnet.np.tanh</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.arcsinh.html">mxnet.np.arcsinh</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.arccosh.html">mxnet.np.arccosh</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.arctanh.html">mxnet.np.arctanh</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.rint.html">mxnet.np.rint</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.fix.html">mxnet.np.fix</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.floor.html">mxnet.np.floor</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.ceil.html">mxnet.np.ceil</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.trunc.html">mxnet.np.trunc</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.around.html">mxnet.np.around</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.round_.html">mxnet.np.round_</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.sum.html">mxnet.np.sum</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.prod.html">mxnet.np.prod</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.cumsum.html">mxnet.np.cumsum</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.nanprod.html">mxnet.np.nanprod</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.nansum.html">mxnet.np.nansum</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.cumprod.html">mxnet.np.cumprod</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.nancumprod.html">mxnet.np.nancumprod</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.nancumsum.html">mxnet.np.nancumsum</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.diff.html">mxnet.np.diff</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.ediff1d.html">mxnet.np.ediff1d</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.cross.html">mxnet.np.cross</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.trapz.html">mxnet.np.trapz</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.exp.html">mxnet.np.exp</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.expm1.html">mxnet.np.expm1</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.log.html">mxnet.np.log</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.log10.html">mxnet.np.log10</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.log2.html">mxnet.np.log2</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.log1p.html">mxnet.np.log1p</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.logaddexp.html">mxnet.np.logaddexp</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.i0.html">mxnet.np.i0</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.ldexp.html">mxnet.np.ldexp</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.signbit.html">mxnet.np.signbit</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.copysign.html">mxnet.np.copysign</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.frexp.html">mxnet.np.frexp</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.spacing.html">mxnet.np.spacing</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.lcm.html">mxnet.np.lcm</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.gcd.html">mxnet.np.gcd</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.add.html">mxnet.np.add</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.reciprocal.html">mxnet.np.reciprocal</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.negative.html">mxnet.np.negative</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.divide.html">mxnet.np.divide</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.power.html">mxnet.np.power</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.subtract.html">mxnet.np.subtract</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.mod.html">mxnet.np.mod</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.multiply.html">mxnet.np.multiply</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.true_divide.html">mxnet.np.true_divide</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.remainder.html">mxnet.np.remainder</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.positive.html">mxnet.np.positive</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.float_power.html">mxnet.np.float_power</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.fmod.html">mxnet.np.fmod</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.modf.html">mxnet.np.modf</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.divmod.html">mxnet.np.divmod</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.floor_divide.html">mxnet.np.floor_divide</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.clip.html">mxnet.np.clip</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.sqrt.html">mxnet.np.sqrt</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.cbrt.html">mxnet.np.cbrt</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.square.html">mxnet.np.square</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.absolute.html">mxnet.np.absolute</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.sign.html">mxnet.np.sign</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.maximum.html">mxnet.np.maximum</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.minimum.html">mxnet.np.minimum</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.fabs.html">mxnet.np.fabs</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.heaviside.html">mxnet.np.heaviside</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.fmax.html">mxnet.np.fmax</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.fmin.html">mxnet.np.fmin</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.nan_to_num.html">mxnet.np.nan_to_num</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.interp.html">mxnet.np.interp</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l4"><a class="reference internal" href="../../np/random/index.html">np.random</a><ul> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/random/generated/mxnet.np.random.choice.html">mxnet.np.random.choice</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/random/generated/mxnet.np.random.shuffle.html">mxnet.np.random.shuffle</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/random/generated/mxnet.np.random.normal.html">mxnet.np.random.normal</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/random/generated/mxnet.np.random.uniform.html">mxnet.np.random.uniform</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/random/generated/mxnet.np.random.rand.html">mxnet.np.random.rand</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/random/generated/mxnet.np.random.randint.html">mxnet.np.random.randint</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/random/generated/mxnet.np.random.beta.html">mxnet.np.random.beta</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/random/generated/mxnet.np.random.chisquare.html">mxnet.np.random.chisquare</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/random/generated/mxnet.np.random.exponential.html">mxnet.np.random.exponential</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/random/generated/mxnet.np.random.f.html">mxnet.np.random.f</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/random/generated/mxnet.np.random.gamma.html">mxnet.np.random.gamma</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/random/generated/mxnet.np.random.gumbel.html">mxnet.np.random.gumbel</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/random/generated/mxnet.np.random.laplace.html">mxnet.np.random.laplace</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/random/generated/mxnet.np.random.logistic.html">mxnet.np.random.logistic</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/random/generated/mxnet.np.random.lognormal.html">mxnet.np.random.lognormal</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/random/generated/mxnet.np.random.multinomial.html">mxnet.np.random.multinomial</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/random/generated/mxnet.np.random.multivariate_normal.html">mxnet.np.random.multivariate_normal</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/random/generated/mxnet.np.random.pareto.html">mxnet.np.random.pareto</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/random/generated/mxnet.np.random.power.html">mxnet.np.random.power</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/random/generated/mxnet.np.random.rayleigh.html">mxnet.np.random.rayleigh</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/random/generated/mxnet.np.random.weibull.html">mxnet.np.random.weibull</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l4"><a class="reference internal" href="../../np/routines.sort.html">Sorting, searching, and counting</a><ul> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.ndarray.sort.html">mxnet.np.ndarray.sort</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.sort.html">mxnet.np.sort</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.lexsort.html">mxnet.np.lexsort</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.argsort.html">mxnet.np.argsort</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.msort.html">mxnet.np.msort</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.partition.html">mxnet.np.partition</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.argpartition.html">mxnet.np.argpartition</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.argmax.html">mxnet.np.argmax</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.argmin.html">mxnet.np.argmin</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.nanargmax.html">mxnet.np.nanargmax</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.nanargmin.html">mxnet.np.nanargmin</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.argwhere.html">mxnet.np.argwhere</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.nonzero.html">mxnet.np.nonzero</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.flatnonzero.html">mxnet.np.flatnonzero</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.where.html">mxnet.np.where</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.searchsorted.html">mxnet.np.searchsorted</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.extract.html">mxnet.np.extract</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.count_nonzero.html">mxnet.np.count_nonzero</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l4"><a class="reference internal" href="../../np/routines.statistics.html">Statistics</a><ul> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.min.html">mxnet.np.min</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.max.html">mxnet.np.max</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.amin.html">mxnet.np.amin</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.amax.html">mxnet.np.amax</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.nanmin.html">mxnet.np.nanmin</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.nanmax.html">mxnet.np.nanmax</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.ptp.html">mxnet.np.ptp</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.percentile.html">mxnet.np.percentile</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.nanpercentile.html">mxnet.np.nanpercentile</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.quantile.html">mxnet.np.quantile</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.nanquantile.html">mxnet.np.nanquantile</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.mean.html">mxnet.np.mean</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.std.html">mxnet.np.std</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.var.html">mxnet.np.var</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.median.html">mxnet.np.median</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.average.html">mxnet.np.average</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.nanmedian.html">mxnet.np.nanmedian</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.nanstd.html">mxnet.np.nanstd</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.nanvar.html">mxnet.np.nanvar</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.corrcoef.html">mxnet.np.corrcoef</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.correlate.html">mxnet.np.correlate</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.cov.html">mxnet.np.cov</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.histogram.html">mxnet.np.histogram</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.histogram2d.html">mxnet.np.histogram2d</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.histogramdd.html">mxnet.np.histogramdd</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.bincount.html">mxnet.np.bincount</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.histogram_bin_edges.html">mxnet.np.histogram_bin_edges</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.digitize.html">mxnet.np.digitize</a></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| <li class="toctree-l2"><a class="reference internal" href="../../npx/index.html">NPX: NumPy Neural Network Extension</a><ul> |
| <li class="toctree-l3"><a class="reference internal" href="../../npx/generated/mxnet.npx.set_np.html">mxnet.npx.set_np</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../npx/generated/mxnet.npx.reset_np.html">mxnet.npx.reset_np</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../npx/generated/mxnet.npx.cpu.html">mxnet.npx.cpu</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../npx/generated/mxnet.npx.cpu_pinned.html">mxnet.npx.cpu_pinned</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../npx/generated/mxnet.npx.gpu.html">mxnet.npx.gpu</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../npx/generated/mxnet.npx.gpu_memory_info.html">mxnet.npx.gpu_memory_info</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../npx/generated/mxnet.npx.current_device.html">mxnet.npx.current_device</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../npx/generated/mxnet.npx.num_gpus.html">mxnet.npx.num_gpus</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../npx/generated/mxnet.npx.activation.html">mxnet.npx.activation</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../npx/generated/mxnet.npx.batch_norm.html">mxnet.npx.batch_norm</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../npx/generated/mxnet.npx.convolution.html">mxnet.npx.convolution</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../npx/generated/mxnet.npx.dropout.html">mxnet.npx.dropout</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../npx/generated/mxnet.npx.embedding.html">mxnet.npx.embedding</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../npx/generated/mxnet.npx.fully_connected.html">mxnet.npx.fully_connected</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../npx/generated/mxnet.npx.layer_norm.html">mxnet.npx.layer_norm</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../npx/generated/mxnet.npx.pooling.html">mxnet.npx.pooling</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../npx/generated/mxnet.npx.rnn.html">mxnet.npx.rnn</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../npx/generated/mxnet.npx.leaky_relu.html">mxnet.npx.leaky_relu</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../npx/generated/mxnet.npx.multibox_detection.html">mxnet.npx.multibox_detection</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../npx/generated/mxnet.npx.multibox_prior.html">mxnet.npx.multibox_prior</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../npx/generated/mxnet.npx.multibox_target.html">mxnet.npx.multibox_target</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../npx/generated/mxnet.npx.roi_pooling.html">mxnet.npx.roi_pooling</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../npx/generated/mxnet.npx.sigmoid.html">mxnet.npx.sigmoid</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../npx/generated/mxnet.npx.relu.html">mxnet.npx.relu</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../npx/generated/mxnet.npx.smooth_l1.html">mxnet.npx.smooth_l1</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../npx/generated/mxnet.npx.softmax.html">mxnet.npx.softmax</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../npx/generated/mxnet.npx.log_softmax.html">mxnet.npx.log_softmax</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../npx/generated/mxnet.npx.topk.html">mxnet.npx.topk</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../npx/generated/mxnet.npx.waitall.html">mxnet.npx.waitall</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../npx/generated/mxnet.npx.load.html">mxnet.npx.load</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../npx/generated/mxnet.npx.save.html">mxnet.npx.save</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../npx/generated/mxnet.npx.one_hot.html">mxnet.npx.one_hot</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../npx/generated/mxnet.npx.pick.html">mxnet.npx.pick</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../npx/generated/mxnet.npx.reshape_like.html">mxnet.npx.reshape_like</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../npx/generated/mxnet.npx.batch_flatten.html">mxnet.npx.batch_flatten</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../npx/generated/mxnet.npx.batch_dot.html">mxnet.npx.batch_dot</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../npx/generated/mxnet.npx.gamma.html">mxnet.npx.gamma</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../npx/generated/mxnet.npx.sequence_mask.html">mxnet.npx.sequence_mask</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l2 current"><a class="reference internal" href="../index.html">mxnet.gluon</a><ul class="current"> |
| <li class="toctree-l3"><a class="reference internal" href="../block.html">gluon.Block</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../hybrid_block.html">gluon.HybridBlock</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../symbol_block.html">gluon.SymbolBlock</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../constant.html">gluon.Constant</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../parameter.html">gluon.Parameter</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../trainer.html">gluon.Trainer</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../contrib/index.html">gluon.contrib</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../data/index.html">gluon.data</a><ul> |
| <li class="toctree-l4"><a class="reference internal" href="../data/vision/index.html">data.vision</a><ul> |
| <li class="toctree-l5"><a class="reference internal" href="../data/vision/datasets/index.html">vision.datasets</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../data/vision/transforms/index.html">vision.transforms</a></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| <li class="toctree-l3"><a class="reference internal" href="../loss/index.html">gluon.loss</a></li> |
| <li class="toctree-l3 current"><a class="current reference internal" href="#">gluon.metric</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../model_zoo/index.html">gluon.model_zoo.vision</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../nn/index.html">gluon.nn</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../rnn/index.html">gluon.rnn</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../utils/index.html">gluon.utils</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l2"><a class="reference internal" href="../../autograd/index.html">mxnet.autograd</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../initializer/index.html">mxnet.initializer</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../optimizer/index.html">mxnet.optimizer</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../lr_scheduler/index.html">mxnet.lr_scheduler</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../kvstore/index.html">KVStore: Communication for Distributed Training</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../kvstore/index.html#horovod">Horovod</a><ul> |
| <li class="toctree-l3"><a class="reference internal" href="../../kvstore/generated/mxnet.kvstore.Horovod.html">mxnet.kvstore.Horovod</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l2"><a class="reference internal" href="../../kvstore/index.html#byteps">BytePS</a><ul> |
| <li class="toctree-l3"><a class="reference internal" href="../../kvstore/generated/mxnet.kvstore.BytePS.html">mxnet.kvstore.BytePS</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l2"><a class="reference internal" href="../../kvstore/index.html#kvstore-interface">KVStore Interface</a><ul> |
| <li class="toctree-l3"><a class="reference internal" href="../../kvstore/generated/mxnet.kvstore.KVStore.html">mxnet.kvstore.KVStore</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../kvstore/generated/mxnet.kvstore.KVStoreBase.html">mxnet.kvstore.KVStoreBase</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../kvstore/generated/mxnet.kvstore.KVStoreServer.html">mxnet.kvstore.KVStoreServer</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l2"><a class="reference internal" href="../../contrib/index.html">mxnet.contrib</a><ul> |
| <li class="toctree-l3"><a class="reference internal" href="../../contrib/io/index.html">contrib.io</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../contrib/ndarray/index.html">contrib.ndarray</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../contrib/onnx/index.html">contrib.onnx</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../contrib/quantization/index.html">contrib.quantization</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../contrib/symbol/index.html">contrib.symbol</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../contrib/tensorboard/index.html">contrib.tensorboard</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../contrib/tensorrt/index.html">contrib.tensorrt</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../contrib/text/index.html">contrib.text</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l2"><a class="reference internal" href="../../legacy/index.html">Legacy</a><ul> |
| <li class="toctree-l3"><a class="reference internal" href="../../legacy/callback/index.html">mxnet.callback</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../legacy/image/index.html">mxnet.image</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../legacy/io/index.html">mxnet.io</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../legacy/ndarray/index.html">mxnet.ndarray</a><ul> |
| <li class="toctree-l4"><a class="reference internal" href="../../legacy/ndarray/ndarray.html">ndarray</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="../../legacy/ndarray/contrib/index.html">ndarray.contrib</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="../../legacy/ndarray/image/index.html">ndarray.image</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="../../legacy/ndarray/linalg/index.html">ndarray.linalg</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="../../legacy/ndarray/op/index.html">ndarray.op</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="../../legacy/ndarray/random/index.html">ndarray.random</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="../../legacy/ndarray/register/index.html">ndarray.register</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="../../legacy/ndarray/sparse/index.html">ndarray.sparse</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="../../legacy/ndarray/utils/index.html">ndarray.utils</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l3"><a class="reference internal" href="../../legacy/recordio/index.html">mxnet.recordio</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../legacy/symbol/index.html">mxnet.symbol</a><ul> |
| <li class="toctree-l4"><a class="reference internal" href="../../legacy/symbol/symbol.html">symbol</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="../../legacy/symbol/contrib/index.html">symbol.contrib</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="../../legacy/symbol/image/index.html">symbol.image</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="../../legacy/symbol/linalg/index.html">symbol.linalg</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="../../legacy/symbol/op/index.html">symbol.op</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="../../legacy/symbol/random/index.html">symbol.random</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="../../legacy/symbol/register/index.html">symbol.register</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="../../legacy/symbol/sparse/index.html">symbol.sparse</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l3"><a class="reference internal" href="../../legacy/visualization/index.html">mxnet.visualization</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l2"><a class="reference internal" href="../../device/index.html">mxnet.device</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../engine/index.html">mxnet.engine</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../executor/index.html">mxnet.executor</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../kvstore_server/index.html">mxnet.kvstore_server</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../profiler/index.html">mxnet.profiler</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../rtc/index.html">mxnet.rtc</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../runtime/index.html">mxnet.runtime</a><ul> |
| <li class="toctree-l3"><a class="reference internal" href="../../runtime/generated/mxnet.runtime.Feature.html">mxnet.runtime.Feature</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../runtime/generated/mxnet.runtime.Features.html">mxnet.runtime.Features</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../runtime/generated/mxnet.runtime.feature_list.html">mxnet.runtime.feature_list</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l2"><a class="reference internal" href="../../test_utils/index.html">mxnet.test_utils</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../util/index.html">mxnet.util</a></li> |
| </ul> |
| </li> |
| </ul> |
| |
| </nav> |
| |
| </div> |
| |
| </header> |
| <main class="mdl-layout__content" tabIndex="0"> |
| <header class="mdl-layout__drawer"> |
| |
| <div class="globaltoc"> |
| <span class="mdl-layout-title toc">Table Of Contents</span> |
| |
| |
| |
| <nav class="mdl-navigation"> |
| <ul class="current"> |
| <li class="toctree-l1"><a class="reference internal" href="../../../tutorials/index.html">Python Tutorials</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="../../../tutorials/getting-started/index.html">Getting Started</a><ul> |
| <li class="toctree-l3"><a class="reference internal" href="../../../tutorials/getting-started/crash-course/index.html">Crash Course</a><ul> |
| <li class="toctree-l4"><a class="reference internal" href="../../../tutorials/getting-started/crash-course/0-introduction.html">Introduction</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="../../../tutorials/getting-started/crash-course/1-nparray.html">Step 1: Manipulate data with NP on MXNet</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="../../../tutorials/getting-started/crash-course/2-create-nn.html">Step 2: Create a neural network</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="../../../tutorials/getting-started/crash-course/3-autograd.html">Step 3: Automatic differentiation with autograd</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="../../../tutorials/getting-started/crash-course/4-components.html">Step 4: Necessary components that are not in the network</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="../../../tutorials/getting-started/crash-course/5-datasets.html">Step 5: <code class="docutils literal notranslate"><span class="pre">Dataset</span></code>s and <code class="docutils literal notranslate"><span class="pre">DataLoader</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="../../../tutorials/getting-started/crash-course/5-datasets.html#Using-own-data-with-included-Datasets">Using own data with included <code class="docutils literal notranslate"><span class="pre">Dataset</span></code>s</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="../../../tutorials/getting-started/crash-course/5-datasets.html#Using-your-own-data-with-custom-Datasets">Using your own data with custom <code class="docutils literal notranslate"><span class="pre">Dataset</span></code>s</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="../../../tutorials/getting-started/crash-course/5-datasets.html#New-in-MXNet-2.0:-faster-C++-backend-dataloaders">New in MXNet 2.0: faster C++ backend dataloaders</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="../../../tutorials/getting-started/crash-course/6-train-nn.html">Step 6: Train a Neural Network</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="../../../tutorials/getting-started/crash-course/7-use-gpus.html">Step 7: Load and Run a NN using GPU</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l3"><a class="reference internal" href="../../../tutorials/getting-started/to-mxnet/index.html">Moving to MXNet from Other Frameworks</a><ul> |
| <li class="toctree-l4"><a class="reference internal" href="../../../tutorials/getting-started/to-mxnet/pytorch.html">PyTorch vs Apache MXNet</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l3"><a class="reference internal" href="../../../tutorials/getting-started/gluon_from_experiment_to_deployment.html">Gluon: from experiment to deployment</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../../tutorials/getting-started/gluon_migration_guide.html">Gluon2.0: Migration Guide</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../../tutorials/getting-started/logistic_regression_explained.html">Logistic regression explained</a></li> |
| <li class="toctree-l3"><a class="reference external" href="https://mxnet.apache.org/api/python/docs/tutorials/packages/gluon/image/mnist.html">MNIST</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l2"><a class="reference internal" href="../../../tutorials/packages/index.html">Packages</a><ul> |
| <li class="toctree-l3"><a class="reference internal" href="../../../tutorials/packages/autograd/index.html">Automatic Differentiation</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../../tutorials/packages/gluon/index.html">Gluon</a><ul> |
| <li class="toctree-l4"><a class="reference internal" href="../../../tutorials/packages/gluon/blocks/index.html">Blocks</a><ul> |
| <li class="toctree-l5"><a class="reference internal" href="../../../tutorials/packages/gluon/blocks/custom-layer.html">Custom Layers</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../../tutorials/packages/gluon/blocks/hybridize.html">Hybridize</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../../tutorials/packages/gluon/blocks/init.html">Initialization</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../../tutorials/packages/gluon/blocks/naming.html">Parameter and Block Naming</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../../tutorials/packages/gluon/blocks/nn.html">Layers and Blocks</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../../tutorials/packages/gluon/blocks/parameters.html">Parameter Management</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../../tutorials/packages/gluon/blocks/save_load_params.html">Saving and Loading Gluon Models</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../../tutorials/packages/gluon/blocks/activations/activations.html">Activation Blocks</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l4"><a class="reference internal" href="../../../tutorials/packages/gluon/data/index.html">Data Tutorials</a><ul> |
| <li class="toctree-l5"><a class="reference internal" href="../../../tutorials/packages/gluon/data/data_augmentation.html">Image Augmentation</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../../tutorials/packages/gluon/data/datasets.html">Gluon <code class="docutils literal notranslate"><span class="pre">Dataset</span></code>s and <code class="docutils literal notranslate"><span class="pre">DataLoader</span></code></a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../../tutorials/packages/gluon/data/datasets.html#Using-own-data-with-included-Datasets">Using own data with included <code class="docutils literal notranslate"><span class="pre">Dataset</span></code>s</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../../tutorials/packages/gluon/data/datasets.html#Using-own-data-with-custom-Datasets">Using own data with custom <code class="docutils literal notranslate"><span class="pre">Dataset</span></code>s</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../../tutorials/packages/gluon/data/datasets.html#Appendix:-Upgrading-from-Module-DataIter-to-Gluon-DataLoader">Appendix: Upgrading from Module <code class="docutils literal notranslate"><span class="pre">DataIter</span></code> to Gluon <code class="docutils literal notranslate"><span class="pre">DataLoader</span></code></a></li> |
| </ul> |
| </li> |
| <li class="toctree-l4"><a class="reference internal" href="../../../tutorials/packages/gluon/image/index.html">Image Tutorials</a><ul> |
| <li class="toctree-l5"><a class="reference internal" href="../../../tutorials/packages/gluon/image/info_gan.html">Image similarity search with InfoGAN</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../../tutorials/packages/gluon/image/mnist.html">Handwritten Digit Recognition</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l4"><a class="reference internal" href="../../../tutorials/packages/gluon/loss/index.html">Losses</a><ul> |
| <li class="toctree-l5"><a class="reference internal" href="../../../tutorials/packages/gluon/loss/custom-loss.html">Custom Loss Blocks</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../../tutorials/packages/gluon/loss/kl_divergence.html">Kullback-Leibler (KL) Divergence</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../../tutorials/packages/gluon/loss/loss.html">Loss functions</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l4"><a class="reference internal" href="../../../tutorials/packages/gluon/text/index.html">Text Tutorials</a><ul> |
| <li class="toctree-l5"><a class="reference internal" href="../../../tutorials/packages/gluon/text/gnmt.html">Google Neural Machine Translation</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../../tutorials/packages/gluon/text/transformer.html">Machine Translation with Transformer</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l4"><a class="reference internal" href="../../../tutorials/packages/gluon/training/index.html">Training</a><ul> |
| <li class="toctree-l5"><a class="reference internal" href="../../../tutorials/packages/gluon/training/fit_api_tutorial.html">MXNet Gluon Fit API</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../../tutorials/packages/gluon/training/trainer.html">Trainer</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../../tutorials/packages/gluon/training/learning_rates/index.html">Learning Rates</a><ul> |
| <li class="toctree-l6"><a class="reference internal" href="../../../tutorials/packages/gluon/training/learning_rates/learning_rate_finder.html">Learning Rate Finder</a></li> |
| <li class="toctree-l6"><a class="reference internal" href="../../../tutorials/packages/gluon/training/learning_rates/learning_rate_schedules.html">Learning Rate Schedules</a></li> |
| <li class="toctree-l6"><a class="reference internal" href="../../../tutorials/packages/gluon/training/learning_rates/learning_rate_schedules_advanced.html">Advanced Learning Rate Schedules</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l5"><a class="reference internal" href="../../../tutorials/packages/gluon/training/normalization/index.html">Normalization Blocks</a></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| <li class="toctree-l3"><a class="reference internal" href="../../../tutorials/packages/kvstore/index.html">KVStore</a><ul> |
| <li class="toctree-l4"><a class="reference internal" href="../../../tutorials/packages/kvstore/kvstore.html">Distributed Key-Value Store</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l3"><a class="reference internal" href="../../../tutorials/packages/legacy/index.html">Legacy</a><ul> |
| <li class="toctree-l4"><a class="reference internal" href="../../../tutorials/packages/legacy/ndarray/index.html">NDArray</a><ul> |
| <li class="toctree-l5"><a class="reference internal" href="../../../tutorials/packages/legacy/ndarray/01-ndarray-intro.html">An Intro: Manipulate Data the MXNet Way with NDArray</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../../tutorials/packages/legacy/ndarray/02-ndarray-operations.html">NDArray Operations</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../../tutorials/packages/legacy/ndarray/03-ndarray-contexts.html">NDArray Contexts</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../../tutorials/packages/legacy/ndarray/gotchas_numpy_in_mxnet.html">Gotchas using NumPy in Apache MXNet</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../../tutorials/packages/legacy/ndarray/sparse/index.html">Tutorials</a><ul> |
| <li class="toctree-l6"><a class="reference internal" href="../../../tutorials/packages/legacy/ndarray/sparse/csr.html">CSRNDArray - NDArray in Compressed Sparse Row Storage Format</a></li> |
| <li class="toctree-l6"><a class="reference internal" href="../../../tutorials/packages/legacy/ndarray/sparse/row_sparse.html">RowSparseNDArray - NDArray for Sparse Gradient Updates</a></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| <li class="toctree-l3"><a class="reference internal" href="../../../tutorials/packages/np/index.html">What is NP on MXNet</a><ul> |
| <li class="toctree-l4"><a class="reference internal" href="../../../tutorials/packages/np/cheat-sheet.html">The NP on MXNet cheat sheet</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="../../../tutorials/packages/np/np-vs-numpy.html">Differences between NP on MXNet and NumPy</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l3"><a class="reference internal" href="../../../tutorials/packages/onnx/index.html">ONNX</a><ul> |
| <li class="toctree-l4"><a class="reference internal" href="../../../tutorials/packages/onnx/fine_tuning_gluon.html">Fine-tuning an ONNX model</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="../../../tutorials/packages/onnx/inference_on_onnx_model.html">Running inference on MXNet/Gluon from an ONNX model</a></li> |
| <li class="toctree-l4"><a class="reference external" href="https://mxnet.apache.org/api/python/docs/tutorials/deploy/export/onnx.html">Export ONNX Models</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l3"><a class="reference internal" href="../../../tutorials/packages/optimizer/index.html">Optimizers</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../../tutorials/packages/viz/index.html">Visualization</a><ul> |
| <li class="toctree-l4"><a class="reference external" href="https://mxnet.apache.org/api/faq/visualize_graph">Visualize networks</a></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| <li class="toctree-l2"><a class="reference internal" href="../../../tutorials/performance/index.html">Performance</a><ul> |
| <li class="toctree-l3"><a class="reference internal" href="../../../tutorials/performance/compression/index.html">Compression</a><ul> |
| <li class="toctree-l4"><a class="reference internal" href="../../../tutorials/performance/compression/int8.html">Deploy with int-8</a></li> |
| <li class="toctree-l4"><a class="reference external" href="https://mxnet.apache.org/api/faq/float16">Float16</a></li> |
| <li class="toctree-l4"><a class="reference external" href="https://mxnet.apache.org/api/faq/gradient_compression">Gradient Compression</a></li> |
| <li class="toctree-l4"><a class="reference external" href="https://gluon-cv.mxnet.io/build/examples_deployment/int8_inference.html">GluonCV with Quantized Models</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l3"><a class="reference internal" href="../../../tutorials/performance/backend/index.html">Accelerated Backend Tools</a><ul> |
| <li class="toctree-l4"><a class="reference internal" href="../../../tutorials/performance/backend/dnnl/index.html">oneDNN</a><ul> |
| <li class="toctree-l5"><a class="reference internal" href="../../../tutorials/performance/backend/dnnl/dnnl_readme.html">Install MXNet with oneDNN</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../../tutorials/performance/backend/dnnl/dnnl_quantization.html">oneDNN Quantization</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../../tutorials/performance/backend/dnnl/dnnl_quantization_inc.html">Improving accuracy with Intel® Neural Compressor</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l4"><a class="reference internal" href="../../../tutorials/performance/backend/tvm.html">Use TVM</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="../../../tutorials/performance/backend/profiler.html">Profiling MXNet Models</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="../../../tutorials/performance/backend/amp.html">Using AMP: Automatic Mixed Precision</a></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| <li class="toctree-l2"><a class="reference internal" href="../../../tutorials/deploy/index.html">Deployment</a><ul> |
| <li class="toctree-l3"><a class="reference internal" href="../../../tutorials/deploy/export/index.html">Export</a><ul> |
| <li class="toctree-l4"><a class="reference internal" href="../../../tutorials/deploy/export/onnx.html">Exporting to ONNX format</a></li> |
| <li class="toctree-l4"><a class="reference external" href="https://gluon-cv.mxnet.io/build/examples_deployment/export_network.html">Export Gluon CV Models</a></li> |
| <li class="toctree-l4"><a class="reference external" href="https://mxnet.apache.org/api/python/docs/tutorials/packages/gluon/blocks/save_load_params.html">Save / Load Parameters</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l3"><a class="reference internal" href="../../../tutorials/deploy/inference/index.html">Inference</a><ul> |
| <li class="toctree-l4"><a class="reference internal" href="../../../tutorials/deploy/inference/cpp.html">Deploy into C++</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="../../../tutorials/deploy/inference/image_classification_jetson.html">Image Classication using pretrained ResNet-50 model on Jetson module</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l3"><a class="reference internal" href="../../../tutorials/deploy/run-on-aws/index.html">Run on AWS</a><ul> |
| <li class="toctree-l4"><a class="reference internal" href="../../../tutorials/deploy/run-on-aws/use_ec2.html">Run on an EC2 Instance</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="../../../tutorials/deploy/run-on-aws/use_sagemaker.html">Run on Amazon SageMaker</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="../../../tutorials/deploy/run-on-aws/cloud.html">MXNet on the Cloud</a></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| <li class="toctree-l2"><a class="reference internal" href="../../../tutorials/extend/index.html">Extend</a><ul> |
| <li class="toctree-l3"><a class="reference internal" href="../../../tutorials/extend/customop.html">Custom Numpy Operators</a></li> |
| <li class="toctree-l3"><a class="reference external" href="https://mxnet.apache.org/api/faq/new_op">New Operator Creation</a></li> |
| <li class="toctree-l3"><a class="reference external" href="https://mxnet.apache.org/api/faq/add_op_in_backend">New Operator in MXNet Backend</a></li> |
| <li class="toctree-l3"><a class="reference external" href="https://mxnet.apache.org/api/faq/using_rtc">Using RTC for CUDA kernels</a></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| <li class="toctree-l1 current"><a class="reference internal" href="../../index.html">Python API</a><ul class="current"> |
| <li class="toctree-l2"><a class="reference internal" href="../../np/index.html">mxnet.np</a><ul> |
| <li class="toctree-l3"><a class="reference internal" href="../../np/arrays.html">Array objects</a><ul> |
| <li class="toctree-l4"><a class="reference internal" href="../../np/arrays.ndarray.html">The N-dimensional array (<code class="xref py py-class docutils literal notranslate"><span class="pre">ndarray</span></code>)</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="../../np/arrays.indexing.html">Indexing</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l3"><a class="reference internal" href="../../np/routines.html">Routines</a><ul> |
| <li class="toctree-l4"><a class="reference internal" href="../../np/routines.array-creation.html">Array creation routines</a><ul> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.eye.html">mxnet.np.eye</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.empty.html">mxnet.np.empty</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.full.html">mxnet.np.full</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.identity.html">mxnet.np.identity</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.ones.html">mxnet.np.ones</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.ones_like.html">mxnet.np.ones_like</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.zeros.html">mxnet.np.zeros</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.zeros_like.html">mxnet.np.zeros_like</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.array.html">mxnet.np.array</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.copy.html">mxnet.np.copy</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.arange.html">mxnet.np.arange</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.linspace.html">mxnet.np.linspace</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.logspace.html">mxnet.np.logspace</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.meshgrid.html">mxnet.np.meshgrid</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.tril.html">mxnet.np.tril</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l4"><a class="reference internal" href="../../np/routines.array-manipulation.html">Array manipulation routines</a><ul> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.reshape.html">mxnet.np.reshape</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.ravel.html">mxnet.np.ravel</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.ndarray.flatten.html">mxnet.np.ndarray.flatten</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.swapaxes.html">mxnet.np.swapaxes</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.ndarray.T.html">mxnet.np.ndarray.T</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.transpose.html">mxnet.np.transpose</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.moveaxis.html">mxnet.np.moveaxis</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.rollaxis.html">mxnet.np.rollaxis</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.expand_dims.html">mxnet.np.expand_dims</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.squeeze.html">mxnet.np.squeeze</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.broadcast_to.html">mxnet.np.broadcast_to</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.broadcast_arrays.html">mxnet.np.broadcast_arrays</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.atleast_1d.html">mxnet.np.atleast_1d</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.atleast_2d.html">mxnet.np.atleast_2d</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.atleast_3d.html">mxnet.np.atleast_3d</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.concatenate.html">mxnet.np.concatenate</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.stack.html">mxnet.np.stack</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.dstack.html">mxnet.np.dstack</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.vstack.html">mxnet.np.vstack</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.column_stack.html">mxnet.np.column_stack</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.hstack.html">mxnet.np.hstack</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.split.html">mxnet.np.split</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.hsplit.html">mxnet.np.hsplit</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.vsplit.html">mxnet.np.vsplit</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.array_split.html">mxnet.np.array_split</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.dsplit.html">mxnet.np.dsplit</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.tile.html">mxnet.np.tile</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.repeat.html">mxnet.np.repeat</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.unique.html">mxnet.np.unique</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.delete.html">mxnet.np.delete</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.insert.html">mxnet.np.insert</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.append.html">mxnet.np.append</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.resize.html">mxnet.np.resize</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.trim_zeros.html">mxnet.np.trim_zeros</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.reshape.html">mxnet.np.reshape</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.flip.html">mxnet.np.flip</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.roll.html">mxnet.np.roll</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.rot90.html">mxnet.np.rot90</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.fliplr.html">mxnet.np.fliplr</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.flipud.html">mxnet.np.flipud</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l4"><a class="reference internal" href="../../np/routines.io.html">Input and output</a><ul> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.genfromtxt.html">mxnet.np.genfromtxt</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.ndarray.tolist.html">mxnet.np.ndarray.tolist</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.set_printoptions.html">mxnet.np.set_printoptions</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l4"><a class="reference internal" href="../../np/routines.linalg.html">Linear algebra (<code class="xref py py-mod docutils literal notranslate"><span class="pre">numpy.linalg</span></code>)</a><ul> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.dot.html">mxnet.np.dot</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.vdot.html">mxnet.np.vdot</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.inner.html">mxnet.np.inner</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.outer.html">mxnet.np.outer</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.tensordot.html">mxnet.np.tensordot</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.einsum.html">mxnet.np.einsum</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.linalg.multi_dot.html">mxnet.np.linalg.multi_dot</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.matmul.html">mxnet.np.matmul</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.linalg.matrix_power.html">mxnet.np.linalg.matrix_power</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.kron.html">mxnet.np.kron</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.linalg.svd.html">mxnet.np.linalg.svd</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.linalg.cholesky.html">mxnet.np.linalg.cholesky</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.linalg.qr.html">mxnet.np.linalg.qr</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.linalg.eig.html">mxnet.np.linalg.eig</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.linalg.eigh.html">mxnet.np.linalg.eigh</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.linalg.eigvals.html">mxnet.np.linalg.eigvals</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.linalg.eigvalsh.html">mxnet.np.linalg.eigvalsh</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.linalg.norm.html">mxnet.np.linalg.norm</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.trace.html">mxnet.np.trace</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.linalg.cond.html">mxnet.np.linalg.cond</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.linalg.det.html">mxnet.np.linalg.det</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.linalg.matrix_rank.html">mxnet.np.linalg.matrix_rank</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.linalg.slogdet.html">mxnet.np.linalg.slogdet</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.linalg.solve.html">mxnet.np.linalg.solve</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.linalg.tensorsolve.html">mxnet.np.linalg.tensorsolve</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.linalg.lstsq.html">mxnet.np.linalg.lstsq</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.linalg.inv.html">mxnet.np.linalg.inv</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.linalg.pinv.html">mxnet.np.linalg.pinv</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.linalg.tensorinv.html">mxnet.np.linalg.tensorinv</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l4"><a class="reference internal" href="../../np/routines.math.html">Mathematical functions</a><ul> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.sin.html">mxnet.np.sin</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.cos.html">mxnet.np.cos</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.tan.html">mxnet.np.tan</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.arcsin.html">mxnet.np.arcsin</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.arccos.html">mxnet.np.arccos</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.arctan.html">mxnet.np.arctan</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.degrees.html">mxnet.np.degrees</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.radians.html">mxnet.np.radians</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.hypot.html">mxnet.np.hypot</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.arctan2.html">mxnet.np.arctan2</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.deg2rad.html">mxnet.np.deg2rad</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.rad2deg.html">mxnet.np.rad2deg</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.unwrap.html">mxnet.np.unwrap</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.sinh.html">mxnet.np.sinh</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.cosh.html">mxnet.np.cosh</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.tanh.html">mxnet.np.tanh</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.arcsinh.html">mxnet.np.arcsinh</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.arccosh.html">mxnet.np.arccosh</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.arctanh.html">mxnet.np.arctanh</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.rint.html">mxnet.np.rint</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.fix.html">mxnet.np.fix</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.floor.html">mxnet.np.floor</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.ceil.html">mxnet.np.ceil</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.trunc.html">mxnet.np.trunc</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.around.html">mxnet.np.around</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.round_.html">mxnet.np.round_</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.sum.html">mxnet.np.sum</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.prod.html">mxnet.np.prod</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.cumsum.html">mxnet.np.cumsum</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.nanprod.html">mxnet.np.nanprod</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.nansum.html">mxnet.np.nansum</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.cumprod.html">mxnet.np.cumprod</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.nancumprod.html">mxnet.np.nancumprod</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.nancumsum.html">mxnet.np.nancumsum</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.diff.html">mxnet.np.diff</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.ediff1d.html">mxnet.np.ediff1d</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.cross.html">mxnet.np.cross</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.trapz.html">mxnet.np.trapz</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.exp.html">mxnet.np.exp</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.expm1.html">mxnet.np.expm1</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.log.html">mxnet.np.log</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.log10.html">mxnet.np.log10</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.log2.html">mxnet.np.log2</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.log1p.html">mxnet.np.log1p</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.logaddexp.html">mxnet.np.logaddexp</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.i0.html">mxnet.np.i0</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.ldexp.html">mxnet.np.ldexp</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.signbit.html">mxnet.np.signbit</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.copysign.html">mxnet.np.copysign</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.frexp.html">mxnet.np.frexp</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.spacing.html">mxnet.np.spacing</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.lcm.html">mxnet.np.lcm</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.gcd.html">mxnet.np.gcd</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.add.html">mxnet.np.add</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.reciprocal.html">mxnet.np.reciprocal</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.negative.html">mxnet.np.negative</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.divide.html">mxnet.np.divide</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.power.html">mxnet.np.power</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.subtract.html">mxnet.np.subtract</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.mod.html">mxnet.np.mod</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.multiply.html">mxnet.np.multiply</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.true_divide.html">mxnet.np.true_divide</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.remainder.html">mxnet.np.remainder</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.positive.html">mxnet.np.positive</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.float_power.html">mxnet.np.float_power</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.fmod.html">mxnet.np.fmod</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.modf.html">mxnet.np.modf</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.divmod.html">mxnet.np.divmod</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.floor_divide.html">mxnet.np.floor_divide</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.clip.html">mxnet.np.clip</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.sqrt.html">mxnet.np.sqrt</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.cbrt.html">mxnet.np.cbrt</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.square.html">mxnet.np.square</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.absolute.html">mxnet.np.absolute</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.sign.html">mxnet.np.sign</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.maximum.html">mxnet.np.maximum</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.minimum.html">mxnet.np.minimum</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.fabs.html">mxnet.np.fabs</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.heaviside.html">mxnet.np.heaviside</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.fmax.html">mxnet.np.fmax</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.fmin.html">mxnet.np.fmin</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.nan_to_num.html">mxnet.np.nan_to_num</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.interp.html">mxnet.np.interp</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l4"><a class="reference internal" href="../../np/random/index.html">np.random</a><ul> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/random/generated/mxnet.np.random.choice.html">mxnet.np.random.choice</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/random/generated/mxnet.np.random.shuffle.html">mxnet.np.random.shuffle</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/random/generated/mxnet.np.random.normal.html">mxnet.np.random.normal</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/random/generated/mxnet.np.random.uniform.html">mxnet.np.random.uniform</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/random/generated/mxnet.np.random.rand.html">mxnet.np.random.rand</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/random/generated/mxnet.np.random.randint.html">mxnet.np.random.randint</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/random/generated/mxnet.np.random.beta.html">mxnet.np.random.beta</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/random/generated/mxnet.np.random.chisquare.html">mxnet.np.random.chisquare</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/random/generated/mxnet.np.random.exponential.html">mxnet.np.random.exponential</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/random/generated/mxnet.np.random.f.html">mxnet.np.random.f</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/random/generated/mxnet.np.random.gamma.html">mxnet.np.random.gamma</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/random/generated/mxnet.np.random.gumbel.html">mxnet.np.random.gumbel</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/random/generated/mxnet.np.random.laplace.html">mxnet.np.random.laplace</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/random/generated/mxnet.np.random.logistic.html">mxnet.np.random.logistic</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/random/generated/mxnet.np.random.lognormal.html">mxnet.np.random.lognormal</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/random/generated/mxnet.np.random.multinomial.html">mxnet.np.random.multinomial</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/random/generated/mxnet.np.random.multivariate_normal.html">mxnet.np.random.multivariate_normal</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/random/generated/mxnet.np.random.pareto.html">mxnet.np.random.pareto</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/random/generated/mxnet.np.random.power.html">mxnet.np.random.power</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/random/generated/mxnet.np.random.rayleigh.html">mxnet.np.random.rayleigh</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/random/generated/mxnet.np.random.weibull.html">mxnet.np.random.weibull</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l4"><a class="reference internal" href="../../np/routines.sort.html">Sorting, searching, and counting</a><ul> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.ndarray.sort.html">mxnet.np.ndarray.sort</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.sort.html">mxnet.np.sort</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.lexsort.html">mxnet.np.lexsort</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.argsort.html">mxnet.np.argsort</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.msort.html">mxnet.np.msort</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.partition.html">mxnet.np.partition</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.argpartition.html">mxnet.np.argpartition</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.argmax.html">mxnet.np.argmax</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.argmin.html">mxnet.np.argmin</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.nanargmax.html">mxnet.np.nanargmax</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.nanargmin.html">mxnet.np.nanargmin</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.argwhere.html">mxnet.np.argwhere</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.nonzero.html">mxnet.np.nonzero</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.flatnonzero.html">mxnet.np.flatnonzero</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.where.html">mxnet.np.where</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.searchsorted.html">mxnet.np.searchsorted</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.extract.html">mxnet.np.extract</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.count_nonzero.html">mxnet.np.count_nonzero</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l4"><a class="reference internal" href="../../np/routines.statistics.html">Statistics</a><ul> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.min.html">mxnet.np.min</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.max.html">mxnet.np.max</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.amin.html">mxnet.np.amin</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.amax.html">mxnet.np.amax</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.nanmin.html">mxnet.np.nanmin</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.nanmax.html">mxnet.np.nanmax</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.ptp.html">mxnet.np.ptp</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.percentile.html">mxnet.np.percentile</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.nanpercentile.html">mxnet.np.nanpercentile</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.quantile.html">mxnet.np.quantile</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.nanquantile.html">mxnet.np.nanquantile</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.mean.html">mxnet.np.mean</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.std.html">mxnet.np.std</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.var.html">mxnet.np.var</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.median.html">mxnet.np.median</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.average.html">mxnet.np.average</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.nanmedian.html">mxnet.np.nanmedian</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.nanstd.html">mxnet.np.nanstd</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.nanvar.html">mxnet.np.nanvar</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.corrcoef.html">mxnet.np.corrcoef</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.correlate.html">mxnet.np.correlate</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.cov.html">mxnet.np.cov</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.histogram.html">mxnet.np.histogram</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.histogram2d.html">mxnet.np.histogram2d</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.histogramdd.html">mxnet.np.histogramdd</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.bincount.html">mxnet.np.bincount</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.histogram_bin_edges.html">mxnet.np.histogram_bin_edges</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../np/generated/mxnet.np.digitize.html">mxnet.np.digitize</a></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| <li class="toctree-l2"><a class="reference internal" href="../../npx/index.html">NPX: NumPy Neural Network Extension</a><ul> |
| <li class="toctree-l3"><a class="reference internal" href="../../npx/generated/mxnet.npx.set_np.html">mxnet.npx.set_np</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../npx/generated/mxnet.npx.reset_np.html">mxnet.npx.reset_np</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../npx/generated/mxnet.npx.cpu.html">mxnet.npx.cpu</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../npx/generated/mxnet.npx.cpu_pinned.html">mxnet.npx.cpu_pinned</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../npx/generated/mxnet.npx.gpu.html">mxnet.npx.gpu</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../npx/generated/mxnet.npx.gpu_memory_info.html">mxnet.npx.gpu_memory_info</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../npx/generated/mxnet.npx.current_device.html">mxnet.npx.current_device</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../npx/generated/mxnet.npx.num_gpus.html">mxnet.npx.num_gpus</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../npx/generated/mxnet.npx.activation.html">mxnet.npx.activation</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../npx/generated/mxnet.npx.batch_norm.html">mxnet.npx.batch_norm</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../npx/generated/mxnet.npx.convolution.html">mxnet.npx.convolution</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../npx/generated/mxnet.npx.dropout.html">mxnet.npx.dropout</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../npx/generated/mxnet.npx.embedding.html">mxnet.npx.embedding</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../npx/generated/mxnet.npx.fully_connected.html">mxnet.npx.fully_connected</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../npx/generated/mxnet.npx.layer_norm.html">mxnet.npx.layer_norm</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../npx/generated/mxnet.npx.pooling.html">mxnet.npx.pooling</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../npx/generated/mxnet.npx.rnn.html">mxnet.npx.rnn</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../npx/generated/mxnet.npx.leaky_relu.html">mxnet.npx.leaky_relu</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../npx/generated/mxnet.npx.multibox_detection.html">mxnet.npx.multibox_detection</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../npx/generated/mxnet.npx.multibox_prior.html">mxnet.npx.multibox_prior</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../npx/generated/mxnet.npx.multibox_target.html">mxnet.npx.multibox_target</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../npx/generated/mxnet.npx.roi_pooling.html">mxnet.npx.roi_pooling</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../npx/generated/mxnet.npx.sigmoid.html">mxnet.npx.sigmoid</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../npx/generated/mxnet.npx.relu.html">mxnet.npx.relu</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../npx/generated/mxnet.npx.smooth_l1.html">mxnet.npx.smooth_l1</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../npx/generated/mxnet.npx.softmax.html">mxnet.npx.softmax</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../npx/generated/mxnet.npx.log_softmax.html">mxnet.npx.log_softmax</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../npx/generated/mxnet.npx.topk.html">mxnet.npx.topk</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../npx/generated/mxnet.npx.waitall.html">mxnet.npx.waitall</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../npx/generated/mxnet.npx.load.html">mxnet.npx.load</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../npx/generated/mxnet.npx.save.html">mxnet.npx.save</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../npx/generated/mxnet.npx.one_hot.html">mxnet.npx.one_hot</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../npx/generated/mxnet.npx.pick.html">mxnet.npx.pick</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../npx/generated/mxnet.npx.reshape_like.html">mxnet.npx.reshape_like</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../npx/generated/mxnet.npx.batch_flatten.html">mxnet.npx.batch_flatten</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../npx/generated/mxnet.npx.batch_dot.html">mxnet.npx.batch_dot</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../npx/generated/mxnet.npx.gamma.html">mxnet.npx.gamma</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../npx/generated/mxnet.npx.sequence_mask.html">mxnet.npx.sequence_mask</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l2 current"><a class="reference internal" href="../index.html">mxnet.gluon</a><ul class="current"> |
| <li class="toctree-l3"><a class="reference internal" href="../block.html">gluon.Block</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../hybrid_block.html">gluon.HybridBlock</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../symbol_block.html">gluon.SymbolBlock</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../constant.html">gluon.Constant</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../parameter.html">gluon.Parameter</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../trainer.html">gluon.Trainer</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../contrib/index.html">gluon.contrib</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../data/index.html">gluon.data</a><ul> |
| <li class="toctree-l4"><a class="reference internal" href="../data/vision/index.html">data.vision</a><ul> |
| <li class="toctree-l5"><a class="reference internal" href="../data/vision/datasets/index.html">vision.datasets</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../data/vision/transforms/index.html">vision.transforms</a></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| <li class="toctree-l3"><a class="reference internal" href="../loss/index.html">gluon.loss</a></li> |
| <li class="toctree-l3 current"><a class="current reference internal" href="#">gluon.metric</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../model_zoo/index.html">gluon.model_zoo.vision</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../nn/index.html">gluon.nn</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../rnn/index.html">gluon.rnn</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../utils/index.html">gluon.utils</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l2"><a class="reference internal" href="../../autograd/index.html">mxnet.autograd</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../initializer/index.html">mxnet.initializer</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../optimizer/index.html">mxnet.optimizer</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../lr_scheduler/index.html">mxnet.lr_scheduler</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../kvstore/index.html">KVStore: Communication for Distributed Training</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../kvstore/index.html#horovod">Horovod</a><ul> |
| <li class="toctree-l3"><a class="reference internal" href="../../kvstore/generated/mxnet.kvstore.Horovod.html">mxnet.kvstore.Horovod</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l2"><a class="reference internal" href="../../kvstore/index.html#byteps">BytePS</a><ul> |
| <li class="toctree-l3"><a class="reference internal" href="../../kvstore/generated/mxnet.kvstore.BytePS.html">mxnet.kvstore.BytePS</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l2"><a class="reference internal" href="../../kvstore/index.html#kvstore-interface">KVStore Interface</a><ul> |
| <li class="toctree-l3"><a class="reference internal" href="../../kvstore/generated/mxnet.kvstore.KVStore.html">mxnet.kvstore.KVStore</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../kvstore/generated/mxnet.kvstore.KVStoreBase.html">mxnet.kvstore.KVStoreBase</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../kvstore/generated/mxnet.kvstore.KVStoreServer.html">mxnet.kvstore.KVStoreServer</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l2"><a class="reference internal" href="../../contrib/index.html">mxnet.contrib</a><ul> |
| <li class="toctree-l3"><a class="reference internal" href="../../contrib/io/index.html">contrib.io</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../contrib/ndarray/index.html">contrib.ndarray</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../contrib/onnx/index.html">contrib.onnx</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../contrib/quantization/index.html">contrib.quantization</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../contrib/symbol/index.html">contrib.symbol</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../contrib/tensorboard/index.html">contrib.tensorboard</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../contrib/tensorrt/index.html">contrib.tensorrt</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../contrib/text/index.html">contrib.text</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l2"><a class="reference internal" href="../../legacy/index.html">Legacy</a><ul> |
| <li class="toctree-l3"><a class="reference internal" href="../../legacy/callback/index.html">mxnet.callback</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../legacy/image/index.html">mxnet.image</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../legacy/io/index.html">mxnet.io</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../legacy/ndarray/index.html">mxnet.ndarray</a><ul> |
| <li class="toctree-l4"><a class="reference internal" href="../../legacy/ndarray/ndarray.html">ndarray</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="../../legacy/ndarray/contrib/index.html">ndarray.contrib</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="../../legacy/ndarray/image/index.html">ndarray.image</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="../../legacy/ndarray/linalg/index.html">ndarray.linalg</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="../../legacy/ndarray/op/index.html">ndarray.op</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="../../legacy/ndarray/random/index.html">ndarray.random</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="../../legacy/ndarray/register/index.html">ndarray.register</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="../../legacy/ndarray/sparse/index.html">ndarray.sparse</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="../../legacy/ndarray/utils/index.html">ndarray.utils</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l3"><a class="reference internal" href="../../legacy/recordio/index.html">mxnet.recordio</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../legacy/symbol/index.html">mxnet.symbol</a><ul> |
| <li class="toctree-l4"><a class="reference internal" href="../../legacy/symbol/symbol.html">symbol</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="../../legacy/symbol/contrib/index.html">symbol.contrib</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="../../legacy/symbol/image/index.html">symbol.image</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="../../legacy/symbol/linalg/index.html">symbol.linalg</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="../../legacy/symbol/op/index.html">symbol.op</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="../../legacy/symbol/random/index.html">symbol.random</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="../../legacy/symbol/register/index.html">symbol.register</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="../../legacy/symbol/sparse/index.html">symbol.sparse</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l3"><a class="reference internal" href="../../legacy/visualization/index.html">mxnet.visualization</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l2"><a class="reference internal" href="../../device/index.html">mxnet.device</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../engine/index.html">mxnet.engine</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../executor/index.html">mxnet.executor</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../kvstore_server/index.html">mxnet.kvstore_server</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../profiler/index.html">mxnet.profiler</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../rtc/index.html">mxnet.rtc</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../runtime/index.html">mxnet.runtime</a><ul> |
| <li class="toctree-l3"><a class="reference internal" href="../../runtime/generated/mxnet.runtime.Feature.html">mxnet.runtime.Feature</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../runtime/generated/mxnet.runtime.Features.html">mxnet.runtime.Features</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../runtime/generated/mxnet.runtime.feature_list.html">mxnet.runtime.feature_list</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l2"><a class="reference internal" href="../../test_utils/index.html">mxnet.test_utils</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../util/index.html">mxnet.util</a></li> |
| </ul> |
| </li> |
| </ul> |
| |
| </nav> |
| |
| </div> |
| |
| </header> |
| |
| <div class="document"> |
| <div class="page-content" role="main"> |
| |
| <div class="section" id="module-mxnet.gluon.metric"> |
| <span id="gluon-metric"></span><h1>gluon.metric<a class="headerlink" href="#module-mxnet.gluon.metric" title="Permalink to this headline">¶</a></h1> |
| <p>Online evaluation metric module.</p> |
| <p><strong>Classes</strong></p> |
| <table class="longtable docutils align-default"> |
| <colgroup> |
| <col style="width: 10%" /> |
| <col style="width: 90%" /> |
| </colgroup> |
| <tbody> |
| <tr class="row-odd"><td><p><a class="reference internal" href="#mxnet.gluon.metric.Accuracy" title="mxnet.gluon.metric.Accuracy"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Accuracy</span></code></a>([axis, name, output_names, label_names])</p></td> |
| <td><p>Computes accuracy classification score.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="#mxnet.gluon.metric.BinaryAccuracy" title="mxnet.gluon.metric.BinaryAccuracy"><code class="xref py py-obj docutils literal notranslate"><span class="pre">BinaryAccuracy</span></code></a>([name, output_names, …])</p></td> |
| <td><p>Computes the accuracy of a binary or multilabel classification problem.</p></td> |
| </tr> |
| <tr class="row-odd"><td><p><a class="reference internal" href="#mxnet.gluon.metric.CompositeEvalMetric" title="mxnet.gluon.metric.CompositeEvalMetric"><code class="xref py py-obj docutils literal notranslate"><span class="pre">CompositeEvalMetric</span></code></a>([metrics, name, …])</p></td> |
| <td><p>Manages multiple evaluation metrics.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="#mxnet.gluon.metric.CrossEntropy" title="mxnet.gluon.metric.CrossEntropy"><code class="xref py py-obj docutils literal notranslate"><span class="pre">CrossEntropy</span></code></a>([eps, ignore_label, axis, …])</p></td> |
| <td><p>Computes Cross Entropy loss.</p></td> |
| </tr> |
| <tr class="row-odd"><td><p><a class="reference internal" href="#mxnet.gluon.metric.CustomMetric" title="mxnet.gluon.metric.CustomMetric"><code class="xref py py-obj docutils literal notranslate"><span class="pre">CustomMetric</span></code></a>(feval[, name, …])</p></td> |
| <td><p>Computes a customized evaluation metric.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="#mxnet.gluon.metric.EvalMetric" title="mxnet.gluon.metric.EvalMetric"><code class="xref py py-obj docutils literal notranslate"><span class="pre">EvalMetric</span></code></a>(name[, output_names, label_names])</p></td> |
| <td><p>Base class for all evaluation metrics.</p></td> |
| </tr> |
| <tr class="row-odd"><td><p><a class="reference internal" href="#mxnet.gluon.metric.F1" title="mxnet.gluon.metric.F1"><code class="xref py py-obj docutils literal notranslate"><span class="pre">F1</span></code></a>([name, output_names, label_names, …])</p></td> |
| <td><p>Computes the F1 score of a binary classification problem.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="#mxnet.gluon.metric.Fbeta" title="mxnet.gluon.metric.Fbeta"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Fbeta</span></code></a>([name, output_names, label_names, …])</p></td> |
| <td><p>Computes the Fbeta score of a binary classification problem.</p></td> |
| </tr> |
| <tr class="row-odd"><td><p><a class="reference internal" href="#mxnet.gluon.metric.Loss" title="mxnet.gluon.metric.Loss"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Loss</span></code></a>([name, output_names, label_names])</p></td> |
| <td><p>Dummy metric for directly printing loss.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="#mxnet.gluon.metric.MAE" title="mxnet.gluon.metric.MAE"><code class="xref py py-obj docutils literal notranslate"><span class="pre">MAE</span></code></a>([name, output_names, label_names])</p></td> |
| <td><p>Computes Mean Absolute Error (MAE) loss.</p></td> |
| </tr> |
| <tr class="row-odd"><td><p><a class="reference internal" href="#mxnet.gluon.metric.MCC" title="mxnet.gluon.metric.MCC"><code class="xref py py-obj docutils literal notranslate"><span class="pre">MCC</span></code></a>([name, output_names, label_names])</p></td> |
| <td><p>Computes the Matthews Correlation Coefficient of a binary classification problem.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="#mxnet.gluon.metric.MSE" title="mxnet.gluon.metric.MSE"><code class="xref py py-obj docutils literal notranslate"><span class="pre">MSE</span></code></a>([name, output_names, label_names])</p></td> |
| <td><p>Computes Mean Squared Error (MSE) loss.</p></td> |
| </tr> |
| <tr class="row-odd"><td><p><a class="reference internal" href="#mxnet.gluon.metric.MeanCosineSimilarity" title="mxnet.gluon.metric.MeanCosineSimilarity"><code class="xref py py-obj docutils literal notranslate"><span class="pre">MeanCosineSimilarity</span></code></a>([name, output_names, …])</p></td> |
| <td><p>Computes Mean Cosine Similarity.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="#mxnet.gluon.metric.MeanPairwiseDistance" title="mxnet.gluon.metric.MeanPairwiseDistance"><code class="xref py py-obj docutils literal notranslate"><span class="pre">MeanPairwiseDistance</span></code></a>([name, output_names, …])</p></td> |
| <td><p>Computes Mean Pairwise Distance.</p></td> |
| </tr> |
| <tr class="row-odd"><td><p><a class="reference internal" href="#mxnet.gluon.metric.PCC" title="mxnet.gluon.metric.PCC"><code class="xref py py-obj docutils literal notranslate"><span class="pre">PCC</span></code></a>([name, output_names, label_names])</p></td> |
| <td><p>PCC is a multiclass equivalent for the Matthews correlation coefficient derived from a discrete solution to the Pearson correlation coefficient.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="#mxnet.gluon.metric.PearsonCorrelation" title="mxnet.gluon.metric.PearsonCorrelation"><code class="xref py py-obj docutils literal notranslate"><span class="pre">PearsonCorrelation</span></code></a>([name, output_names, …])</p></td> |
| <td><p>Computes Pearson correlation.</p></td> |
| </tr> |
| <tr class="row-odd"><td><p><a class="reference internal" href="#mxnet.gluon.metric.Perplexity" title="mxnet.gluon.metric.Perplexity"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Perplexity</span></code></a>([eps, ignore_label, axis, …])</p></td> |
| <td><p>Computes perplexity.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="#mxnet.gluon.metric.RMSE" title="mxnet.gluon.metric.RMSE"><code class="xref py py-obj docutils literal notranslate"><span class="pre">RMSE</span></code></a>([name, output_names, label_names])</p></td> |
| <td><p>Computes Root Mean Squred Error (RMSE) loss.</p></td> |
| </tr> |
| <tr class="row-odd"><td><p><a class="reference internal" href="#mxnet.gluon.metric.TopKAccuracy" title="mxnet.gluon.metric.TopKAccuracy"><code class="xref py py-obj docutils literal notranslate"><span class="pre">TopKAccuracy</span></code></a>([top_k, name, output_names, …])</p></td> |
| <td><p>Computes top k predictions accuracy.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="#mxnet.gluon.metric.Torch" title="mxnet.gluon.metric.Torch"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Torch</span></code></a>([name, output_names, label_names])</p></td> |
| <td><p>Dummy metric for torch criterions.</p></td> |
| </tr> |
| </tbody> |
| </table> |
| <p><strong>Functions</strong></p> |
| <table class="longtable docutils align-default"> |
| <colgroup> |
| <col style="width: 10%" /> |
| <col style="width: 90%" /> |
| </colgroup> |
| <tbody> |
| <tr class="row-odd"><td><p><a class="reference internal" href="#mxnet.gluon.metric.check_label_shapes" title="mxnet.gluon.metric.check_label_shapes"><code class="xref py py-obj docutils literal notranslate"><span class="pre">check_label_shapes</span></code></a>(labels, preds[, wrap, shape])</p></td> |
| <td><p>Helper function for checking shape of label and prediction</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="#mxnet.gluon.metric.create" title="mxnet.gluon.metric.create"><code class="xref py py-obj docutils literal notranslate"><span class="pre">create</span></code></a>(metric, *args, **kwargs)</p></td> |
| <td><p>Creates evaluation metric from metric names or instances of EvalMetric or a custom metric function.</p></td> |
| </tr> |
| <tr class="row-odd"><td><p><a class="reference internal" href="#mxnet.gluon.metric.np" title="mxnet.gluon.metric.np"><code class="xref py py-obj docutils literal notranslate"><span class="pre">np</span></code></a>(numpy_feval[, name, allow_extra_outputs])</p></td> |
| <td><p>Creates a custom evaluation metric that receives its inputs as numpy arrays.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="#mxnet.gluon.metric.predict_with_threshold" title="mxnet.gluon.metric.predict_with_threshold"><code class="xref py py-obj docutils literal notranslate"><span class="pre">predict_with_threshold</span></code></a>(pred[, threshold])</p></td> |
| <td><p>Do thresholding of predictions in binary and multilabel cases.</p></td> |
| </tr> |
| </tbody> |
| </table> |
| <dl class="class"> |
| <dt id="mxnet.gluon.metric.Accuracy"> |
| <em class="property">class </em><code class="sig-name descname">Accuracy</code><span class="sig-paren">(</span><em class="sig-param">axis=1</em>, <em class="sig-param">name='accuracy'</em>, <em class="sig-param">output_names=None</em>, <em class="sig-param">label_names=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/mxnet/gluon/metric.html#Accuracy"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#mxnet.gluon.metric.Accuracy" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Bases: <a class="reference internal" href="#mxnet.gluon.metric.EvalMetric" title="mxnet.gluon.metric.EvalMetric"><code class="xref py py-class docutils literal notranslate"><span class="pre">mxnet.gluon.metric.EvalMetric</span></code></a></p> |
| <p>Computes accuracy classification score.</p> |
| <p>The accuracy score is defined as</p> |
| <div class="math notranslate nohighlight"> |
| \[\text{accuracy}(y, \hat{y}) = \frac{1}{n} \sum_{i=0}^{n-1} |
| \text{1}(\hat{y_i} == y_i)\]</div> |
| <p><strong>Methods</strong></p> |
| <table class="longtable docutils align-default"> |
| <colgroup> |
| <col style="width: 10%" /> |
| <col style="width: 90%" /> |
| </colgroup> |
| <tbody> |
| <tr class="row-odd"><td><p><a class="reference internal" href="#mxnet.gluon.metric.Accuracy.get" title="mxnet.gluon.metric.Accuracy.get"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get</span></code></a>()</p></td> |
| <td><p>Gets the current evaluation result.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="#mxnet.gluon.metric.Accuracy.get_config" title="mxnet.gluon.metric.Accuracy.get_config"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_config</span></code></a>()</p></td> |
| <td><p>Save configurations of metric.</p></td> |
| </tr> |
| <tr class="row-odd"><td><p><a class="reference internal" href="#mxnet.gluon.metric.Accuracy.get_name_value" title="mxnet.gluon.metric.Accuracy.get_name_value"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_name_value</span></code></a>()</p></td> |
| <td><p>Returns zipped name and value pairs.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="#mxnet.gluon.metric.Accuracy.reset" title="mxnet.gluon.metric.Accuracy.reset"><code class="xref py py-obj docutils literal notranslate"><span class="pre">reset</span></code></a>()</p></td> |
| <td><p>Resets the internal evaluation result to initial state.</p></td> |
| </tr> |
| <tr class="row-odd"><td><p><a class="reference internal" href="#mxnet.gluon.metric.Accuracy.update" title="mxnet.gluon.metric.Accuracy.update"><code class="xref py py-obj docutils literal notranslate"><span class="pre">update</span></code></a>(labels, preds)</p></td> |
| <td><p>Updates the internal evaluation result.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="#mxnet.gluon.metric.Accuracy.update_dict" title="mxnet.gluon.metric.Accuracy.update_dict"><code class="xref py py-obj docutils literal notranslate"><span class="pre">update_dict</span></code></a>(label, pred)</p></td> |
| <td><p>Update the internal evaluation with named label and pred</p></td> |
| </tr> |
| </tbody> |
| </table> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters</dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>axis</strong> (<em>int</em><em>, </em><em>default=1</em>) – The axis that represents classes</p></li> |
| <li><p><strong>name</strong> (<em>str</em>) – Name of this metric instance for display.</p></li> |
| <li><p><strong>output_names</strong> (<em>list of str</em><em>, or </em><em>None</em>) – Name of predictions that should be used when updating with update_dict. |
| By default include all predictions.</p></li> |
| <li><p><strong>label_names</strong> (<em>list of str</em><em>, or </em><em>None</em>) – Name of labels that should be used when updating with update_dict. |
| By default include all labels.</p></li> |
| </ul> |
| </dd> |
| </dl> |
| <p class="rubric">Examples</p> |
| <div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">predicts</span> <span class="o">=</span> <span class="p">[</span><span class="n">mx</span><span class="o">.</span><span class="n">np</span><span class="o">.</span><span class="n">array</span><span class="p">([[</span><span class="mf">0.3</span><span class="p">,</span> <span class="mf">0.7</span><span class="p">],</span> <span class="p">[</span><span class="mi">0</span><span class="p">,</span> <span class="mf">1.</span><span class="p">],</span> <span class="p">[</span><span class="mf">0.4</span><span class="p">,</span> <span class="mf">0.6</span><span class="p">]])]</span> |
| <span class="gp">>>> </span><span class="n">labels</span> <span class="o">=</span> <span class="p">[</span><span class="n">mx</span><span class="o">.</span><span class="n">np</span><span class="o">.</span><span class="n">array</span><span class="p">([</span><span class="mi">0</span><span class="p">,</span> <span class="mi">1</span><span class="p">,</span> <span class="mi">1</span><span class="p">])]</span> |
| <span class="gp">>>> </span><span class="n">acc</span> <span class="o">=</span> <span class="n">mx</span><span class="o">.</span><span class="n">gluon</span><span class="o">.</span><span class="n">metric</span><span class="o">.</span><span class="n">Accuracy</span><span class="p">()</span> |
| <span class="gp">>>> </span><span class="n">acc</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="n">preds</span> <span class="o">=</span> <span class="n">predicts</span><span class="p">,</span> <span class="n">labels</span> <span class="o">=</span> <span class="n">labels</span><span class="p">)</span> |
| <span class="gp">>>> </span><span class="n">acc</span><span class="o">.</span><span class="n">get</span><span class="p">()</span> |
| <span class="go">('accuracy', 0.6666666666666666)</span> |
| </pre></div> |
| </div> |
| <dl class="method"> |
| <dt id="mxnet.gluon.metric.Accuracy.get"> |
| <code class="sig-name descname">get</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#mxnet.gluon.metric.Accuracy.get" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Gets the current evaluation result.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Returns</dt> |
| <dd class="field-odd"><p><ul class="simple"> |
| <li><p><strong>names</strong> (<em>list of str</em>) – Name of the metrics.</p></li> |
| <li><p><strong>values</strong> (<em>list of float</em>) – Value of the evaluations.</p></li> |
| </ul> |
| </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="mxnet.gluon.metric.Accuracy.get_config"> |
| <code class="sig-name descname">get_config</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#mxnet.gluon.metric.Accuracy.get_config" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Save configurations of metric. Can be recreated |
| from configs with metric.create(<code class="docutils literal notranslate"><span class="pre">**config</span></code>)</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="mxnet.gluon.metric.Accuracy.get_name_value"> |
| <code class="sig-name descname">get_name_value</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#mxnet.gluon.metric.Accuracy.get_name_value" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Returns zipped name and value pairs.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Returns</dt> |
| <dd class="field-odd"><p>A (name, value) tuple list.</p> |
| </dd> |
| <dt class="field-even">Return type</dt> |
| <dd class="field-even"><p>list of tuples</p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="mxnet.gluon.metric.Accuracy.reset"> |
| <code class="sig-name descname">reset</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#mxnet.gluon.metric.Accuracy.reset" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Resets the internal evaluation result to initial state.</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="mxnet.gluon.metric.Accuracy.update"> |
| <code class="sig-name descname">update</code><span class="sig-paren">(</span><em class="sig-param">labels</em>, <em class="sig-param">preds</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/mxnet/gluon/metric.html#Accuracy.update"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#mxnet.gluon.metric.Accuracy.update" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Updates the internal evaluation result.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters</dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>labels</strong> (list of <cite>NDArray</cite>) – The labels of the data with class indices as values, one per sample.</p></li> |
| <li><p><strong>preds</strong> (list of <cite>NDArray</cite>) – Prediction values for samples. Each prediction value can either be the class index, |
| or a vector of likelihoods for all classes.</p></li> |
| </ul> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="mxnet.gluon.metric.Accuracy.update_dict"> |
| <code class="sig-name descname">update_dict</code><span class="sig-paren">(</span><em class="sig-param">label</em>, <em class="sig-param">pred</em><span class="sig-paren">)</span><a class="headerlink" href="#mxnet.gluon.metric.Accuracy.update_dict" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Update the internal evaluation with named label and pred</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters</dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>labels</strong> (<em>OrderedDict of str -> NDArray</em>) – name to array mapping for labels.</p></li> |
| <li><p><strong>preds</strong> (<em>OrderedDict of str -> NDArray</em>) – name to array mapping of predicted outputs.</p></li> |
| </ul> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="class"> |
| <dt id="mxnet.gluon.metric.BinaryAccuracy"> |
| <em class="property">class </em><code class="sig-name descname">BinaryAccuracy</code><span class="sig-paren">(</span><em class="sig-param">name='binary_accuracy'</em>, <em class="sig-param">output_names=None</em>, <em class="sig-param">label_names=None</em>, <em class="sig-param">threshold=0.5</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/mxnet/gluon/metric.html#BinaryAccuracy"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#mxnet.gluon.metric.BinaryAccuracy" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Bases: <a class="reference internal" href="#mxnet.gluon.metric.EvalMetric" title="mxnet.gluon.metric.EvalMetric"><code class="xref py py-class docutils literal notranslate"><span class="pre">mxnet.gluon.metric.EvalMetric</span></code></a></p> |
| <p>Computes the accuracy of a binary or multilabel classification problem.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters</dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>name</strong> (<em>str</em>) – Name of this metric instance for display.</p></li> |
| <li><p><strong>output_names</strong> (<em>list of str</em><em>, or </em><em>None</em>) – Name of predictions that should be used when updating with update_dict. |
| By default include all predictions.</p></li> |
| <li><p><strong>label_names</strong> (<em>list of str</em><em>, or </em><em>None</em>) – Name of labels that should be used when updating with update_dict. |
| By default include all labels.</p></li> |
| <li><p><strong>threshold</strong> (<em>float</em><em> or </em><em>ndarray</em><em>, </em><em>default 0.5</em>) – threshold for deciding whether the predictions are positive or negative.</p></li> |
| </ul> |
| </dd> |
| </dl> |
| <p><strong>Methods</strong></p> |
| <table class="longtable docutils align-default"> |
| <colgroup> |
| <col style="width: 10%" /> |
| <col style="width: 90%" /> |
| </colgroup> |
| <tbody> |
| <tr class="row-odd"><td><p><a class="reference internal" href="#mxnet.gluon.metric.BinaryAccuracy.get" title="mxnet.gluon.metric.BinaryAccuracy.get"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get</span></code></a>()</p></td> |
| <td><p>Gets the current evaluation result.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="#mxnet.gluon.metric.BinaryAccuracy.get_config" title="mxnet.gluon.metric.BinaryAccuracy.get_config"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_config</span></code></a>()</p></td> |
| <td><p>Save configurations of metric.</p></td> |
| </tr> |
| <tr class="row-odd"><td><p><a class="reference internal" href="#mxnet.gluon.metric.BinaryAccuracy.get_name_value" title="mxnet.gluon.metric.BinaryAccuracy.get_name_value"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_name_value</span></code></a>()</p></td> |
| <td><p>Returns zipped name and value pairs.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="#mxnet.gluon.metric.BinaryAccuracy.reset" title="mxnet.gluon.metric.BinaryAccuracy.reset"><code class="xref py py-obj docutils literal notranslate"><span class="pre">reset</span></code></a>()</p></td> |
| <td><p>Resets the internal evaluation result to initial state.</p></td> |
| </tr> |
| <tr class="row-odd"><td><p><a class="reference internal" href="#mxnet.gluon.metric.BinaryAccuracy.update" title="mxnet.gluon.metric.BinaryAccuracy.update"><code class="xref py py-obj docutils literal notranslate"><span class="pre">update</span></code></a>(labels, preds)</p></td> |
| <td><p>Updates the internal evaluation result.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="#mxnet.gluon.metric.BinaryAccuracy.update_dict" title="mxnet.gluon.metric.BinaryAccuracy.update_dict"><code class="xref py py-obj docutils literal notranslate"><span class="pre">update_dict</span></code></a>(label, pred)</p></td> |
| <td><p>Update the internal evaluation with named label and pred</p></td> |
| </tr> |
| </tbody> |
| </table> |
| <p class="rubric">Examples</p> |
| <div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">predicts</span> <span class="o">=</span> <span class="p">[</span><span class="n">mx</span><span class="o">.</span><span class="n">np</span><span class="o">.</span><span class="n">array</span><span class="p">([</span><span class="mf">0.7</span><span class="p">,</span> <span class="mi">1</span><span class="p">,</span> <span class="mf">0.55</span><span class="p">])]</span> |
| <span class="gp">>>> </span><span class="n">labels</span> <span class="o">=</span> <span class="p">[</span><span class="n">mx</span><span class="o">.</span><span class="n">np</span><span class="o">.</span><span class="n">array</span><span class="p">([</span><span class="mf">0.</span><span class="p">,</span> <span class="mf">1.</span><span class="p">,</span> <span class="mf">0.</span><span class="p">])]</span> |
| <span class="gp">>>> </span><span class="n">bacc</span> <span class="o">=</span> <span class="n">mx</span><span class="o">.</span><span class="n">gluon</span><span class="o">.</span><span class="n">metric</span><span class="o">.</span><span class="n">BinaryAccuracy</span><span class="p">(</span><span class="n">threshold</span><span class="o">=</span><span class="mf">0.6</span><span class="p">)</span> |
| <span class="gp">>>> </span><span class="n">bacc</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="n">preds</span> <span class="o">=</span> <span class="n">predicts</span><span class="p">,</span> <span class="n">labels</span> <span class="o">=</span> <span class="n">labels</span><span class="p">)</span> |
| <span class="gp">>>> </span><span class="n">bacc</span><span class="o">.</span><span class="n">get</span><span class="p">()</span> |
| <span class="go">('binary_accuracy', 0.6666666666666666)</span> |
| </pre></div> |
| </div> |
| <dl class="method"> |
| <dt id="mxnet.gluon.metric.BinaryAccuracy.get"> |
| <code class="sig-name descname">get</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#mxnet.gluon.metric.BinaryAccuracy.get" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Gets the current evaluation result.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Returns</dt> |
| <dd class="field-odd"><p><ul class="simple"> |
| <li><p><strong>names</strong> (<em>list of str</em>) – Name of the metrics.</p></li> |
| <li><p><strong>values</strong> (<em>list of float</em>) – Value of the evaluations.</p></li> |
| </ul> |
| </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="mxnet.gluon.metric.BinaryAccuracy.get_config"> |
| <code class="sig-name descname">get_config</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#mxnet.gluon.metric.BinaryAccuracy.get_config" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Save configurations of metric. Can be recreated |
| from configs with metric.create(<code class="docutils literal notranslate"><span class="pre">**config</span></code>)</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="mxnet.gluon.metric.BinaryAccuracy.get_name_value"> |
| <code class="sig-name descname">get_name_value</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#mxnet.gluon.metric.BinaryAccuracy.get_name_value" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Returns zipped name and value pairs.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Returns</dt> |
| <dd class="field-odd"><p>A (name, value) tuple list.</p> |
| </dd> |
| <dt class="field-even">Return type</dt> |
| <dd class="field-even"><p>list of tuples</p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="mxnet.gluon.metric.BinaryAccuracy.reset"> |
| <code class="sig-name descname">reset</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#mxnet.gluon.metric.BinaryAccuracy.reset" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Resets the internal evaluation result to initial state.</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="mxnet.gluon.metric.BinaryAccuracy.update"> |
| <code class="sig-name descname">update</code><span class="sig-paren">(</span><em class="sig-param">labels</em>, <em class="sig-param">preds</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/mxnet/gluon/metric.html#BinaryAccuracy.update"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#mxnet.gluon.metric.BinaryAccuracy.update" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Updates the internal evaluation result.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters</dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>labels</strong> (list of <cite>NDArray</cite>) – Each label denotes positive/negative for each class.</p></li> |
| <li><p><strong>preds</strong> (list of <cite>NDArray</cite>) – Each prediction value is a confidence value of being positive for each class.</p></li> |
| </ul> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="mxnet.gluon.metric.BinaryAccuracy.update_dict"> |
| <code class="sig-name descname">update_dict</code><span class="sig-paren">(</span><em class="sig-param">label</em>, <em class="sig-param">pred</em><span class="sig-paren">)</span><a class="headerlink" href="#mxnet.gluon.metric.BinaryAccuracy.update_dict" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Update the internal evaluation with named label and pred</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters</dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>labels</strong> (<em>OrderedDict of str -> NDArray</em>) – name to array mapping for labels.</p></li> |
| <li><p><strong>preds</strong> (<em>OrderedDict of str -> NDArray</em>) – name to array mapping of predicted outputs.</p></li> |
| </ul> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="class"> |
| <dt id="mxnet.gluon.metric.CompositeEvalMetric"> |
| <em class="property">class </em><code class="sig-name descname">CompositeEvalMetric</code><span class="sig-paren">(</span><em class="sig-param">metrics=None</em>, <em class="sig-param">name='composite'</em>, <em class="sig-param">output_names=None</em>, <em class="sig-param">label_names=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/mxnet/gluon/metric.html#CompositeEvalMetric"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#mxnet.gluon.metric.CompositeEvalMetric" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Bases: <a class="reference internal" href="#mxnet.gluon.metric.EvalMetric" title="mxnet.gluon.metric.EvalMetric"><code class="xref py py-class docutils literal notranslate"><span class="pre">mxnet.gluon.metric.EvalMetric</span></code></a></p> |
| <p>Manages multiple evaluation metrics.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters</dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>metrics</strong> (<em>list of EvalMetric</em>) – List of child metrics.</p></li> |
| <li><p><strong>name</strong> (<em>str</em>) – Name of this metric instance for display.</p></li> |
| <li><p><strong>output_names</strong> (<em>list of str</em><em>, or </em><em>None</em>) – Name of predictions that should be used when updating with update_dict. |
| By default include all predictions.</p></li> |
| <li><p><strong>label_names</strong> (<em>list of str</em><em>, or </em><em>None</em>) – Name of labels that should be used when updating with update_dict. |
| By default include all labels.</p></li> |
| </ul> |
| </dd> |
| </dl> |
| <p><strong>Methods</strong></p> |
| <table class="longtable docutils align-default"> |
| <colgroup> |
| <col style="width: 10%" /> |
| <col style="width: 90%" /> |
| </colgroup> |
| <tbody> |
| <tr class="row-odd"><td><p><a class="reference internal" href="#mxnet.gluon.metric.CompositeEvalMetric.add" title="mxnet.gluon.metric.CompositeEvalMetric.add"><code class="xref py py-obj docutils literal notranslate"><span class="pre">add</span></code></a>(metric)</p></td> |
| <td><p>Adds a child metric.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="#mxnet.gluon.metric.CompositeEvalMetric.get" title="mxnet.gluon.metric.CompositeEvalMetric.get"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get</span></code></a>()</p></td> |
| <td><p>Returns the current evaluation result.</p></td> |
| </tr> |
| <tr class="row-odd"><td><p><a class="reference internal" href="#mxnet.gluon.metric.CompositeEvalMetric.get_config" title="mxnet.gluon.metric.CompositeEvalMetric.get_config"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_config</span></code></a>()</p></td> |
| <td><p>Save configurations of metric.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="#mxnet.gluon.metric.CompositeEvalMetric.get_metric" title="mxnet.gluon.metric.CompositeEvalMetric.get_metric"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_metric</span></code></a>(index)</p></td> |
| <td><p>Returns a child metric.</p></td> |
| </tr> |
| <tr class="row-odd"><td><p><a class="reference internal" href="#mxnet.gluon.metric.CompositeEvalMetric.reset" title="mxnet.gluon.metric.CompositeEvalMetric.reset"><code class="xref py py-obj docutils literal notranslate"><span class="pre">reset</span></code></a>()</p></td> |
| <td><p>Resets the internal evaluation result to initial state.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="#mxnet.gluon.metric.CompositeEvalMetric.update" title="mxnet.gluon.metric.CompositeEvalMetric.update"><code class="xref py py-obj docutils literal notranslate"><span class="pre">update</span></code></a>(labels, preds)</p></td> |
| <td><p>Updates the internal evaluation result.</p></td> |
| </tr> |
| <tr class="row-odd"><td><p><a class="reference internal" href="#mxnet.gluon.metric.CompositeEvalMetric.update_dict" title="mxnet.gluon.metric.CompositeEvalMetric.update_dict"><code class="xref py py-obj docutils literal notranslate"><span class="pre">update_dict</span></code></a>(labels, preds)</p></td> |
| <td><p>Update the internal evaluation with named label and pred</p></td> |
| </tr> |
| </tbody> |
| </table> |
| <p class="rubric">Examples</p> |
| <div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">predicts</span> <span class="o">=</span> <span class="p">[</span><span class="n">mx</span><span class="o">.</span><span class="n">np</span><span class="o">.</span><span class="n">array</span><span class="p">([[</span><span class="mf">0.3</span><span class="p">,</span> <span class="mf">0.7</span><span class="p">],</span> <span class="p">[</span><span class="mi">0</span><span class="p">,</span> <span class="mf">1.</span><span class="p">],</span> <span class="p">[</span><span class="mf">0.4</span><span class="p">,</span> <span class="mf">0.6</span><span class="p">]])]</span> |
| <span class="gp">>>> </span><span class="n">labels</span> <span class="o">=</span> <span class="p">[</span><span class="n">mx</span><span class="o">.</span><span class="n">np</span><span class="o">.</span><span class="n">array</span><span class="p">([</span><span class="mi">0</span><span class="p">,</span> <span class="mi">1</span><span class="p">,</span> <span class="mi">1</span><span class="p">])]</span> |
| <span class="gp">>>> </span><span class="n">eval_metrics_1</span> <span class="o">=</span> <span class="n">mx</span><span class="o">.</span><span class="n">gluon</span><span class="o">.</span><span class="n">metric</span><span class="o">.</span><span class="n">Accuracy</span><span class="p">()</span> |
| <span class="gp">>>> </span><span class="n">eval_metrics_2</span> <span class="o">=</span> <span class="n">mx</span><span class="o">.</span><span class="n">gluon</span><span class="o">.</span><span class="n">metric</span><span class="o">.</span><span class="n">F1</span><span class="p">()</span> |
| <span class="gp">>>> </span><span class="n">eval_metrics</span> <span class="o">=</span> <span class="n">mx</span><span class="o">.</span><span class="n">gluon</span><span class="o">.</span><span class="n">metric</span><span class="o">.</span><span class="n">CompositeEvalMetric</span><span class="p">()</span> |
| <span class="gp">>>> </span><span class="k">for</span> <span class="n">child_metric</span> <span class="ow">in</span> <span class="p">[</span><span class="n">eval_metrics_1</span><span class="p">,</span> <span class="n">eval_metrics_2</span><span class="p">]:</span> |
| <span class="gp">>>> </span> <span class="n">eval_metrics</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="n">child_metric</span><span class="p">)</span> |
| <span class="gp">>>> </span><span class="n">eval_metrics</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="n">labels</span> <span class="o">=</span> <span class="n">labels</span><span class="p">,</span> <span class="n">preds</span> <span class="o">=</span> <span class="n">predicts</span><span class="p">)</span> |
| <span class="gp">>>> </span><span class="n">eval_metrics</span><span class="o">.</span><span class="n">get</span><span class="p">()</span> |
| <span class="go">(['accuracy', 'f1'], [0.6666666666666666, 0.8])</span> |
| </pre></div> |
| </div> |
| <dl class="method"> |
| <dt id="mxnet.gluon.metric.CompositeEvalMetric.add"> |
| <code class="sig-name descname">add</code><span class="sig-paren">(</span><em class="sig-param">metric</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/mxnet/gluon/metric.html#CompositeEvalMetric.add"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#mxnet.gluon.metric.CompositeEvalMetric.add" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Adds a child metric.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters</dt> |
| <dd class="field-odd"><p><strong>metric</strong> – A metric instance.</p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="mxnet.gluon.metric.CompositeEvalMetric.get"> |
| <code class="sig-name descname">get</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/mxnet/gluon/metric.html#CompositeEvalMetric.get"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#mxnet.gluon.metric.CompositeEvalMetric.get" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Returns the current evaluation result.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Returns</dt> |
| <dd class="field-odd"><p><ul class="simple"> |
| <li><p><strong>names</strong> (<em>list of str</em>) – Name of the metrics.</p></li> |
| <li><p><strong>values</strong> (<em>list of float</em>) – Value of the evaluations.</p></li> |
| </ul> |
| </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="mxnet.gluon.metric.CompositeEvalMetric.get_config"> |
| <code class="sig-name descname">get_config</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/mxnet/gluon/metric.html#CompositeEvalMetric.get_config"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#mxnet.gluon.metric.CompositeEvalMetric.get_config" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Save configurations of metric. Can be recreated |
| from configs with metric.create(<code class="docutils literal notranslate"><span class="pre">**config</span></code>)</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="mxnet.gluon.metric.CompositeEvalMetric.get_metric"> |
| <code class="sig-name descname">get_metric</code><span class="sig-paren">(</span><em class="sig-param">index</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/mxnet/gluon/metric.html#CompositeEvalMetric.get_metric"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#mxnet.gluon.metric.CompositeEvalMetric.get_metric" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Returns a child metric.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters</dt> |
| <dd class="field-odd"><p><strong>index</strong> (<em>int</em>) – Index of child metric in the list of metrics.</p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="mxnet.gluon.metric.CompositeEvalMetric.reset"> |
| <code class="sig-name descname">reset</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/mxnet/gluon/metric.html#CompositeEvalMetric.reset"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#mxnet.gluon.metric.CompositeEvalMetric.reset" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Resets the internal evaluation result to initial state.</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="mxnet.gluon.metric.CompositeEvalMetric.update"> |
| <code class="sig-name descname">update</code><span class="sig-paren">(</span><em class="sig-param">labels</em>, <em class="sig-param">preds</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/mxnet/gluon/metric.html#CompositeEvalMetric.update"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#mxnet.gluon.metric.CompositeEvalMetric.update" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Updates the internal evaluation result.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters</dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>labels</strong> (list of <cite>NDArray</cite>) – The labels of the data.</p></li> |
| <li><p><strong>preds</strong> (list of <cite>NDArray</cite>) – Predicted values.</p></li> |
| </ul> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="mxnet.gluon.metric.CompositeEvalMetric.update_dict"> |
| <code class="sig-name descname">update_dict</code><span class="sig-paren">(</span><em class="sig-param">labels</em>, <em class="sig-param">preds</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/mxnet/gluon/metric.html#CompositeEvalMetric.update_dict"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#mxnet.gluon.metric.CompositeEvalMetric.update_dict" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Update the internal evaluation with named label and pred</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters</dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>labels</strong> (<em>OrderedDict of str -> NDArray</em>) – name to array mapping for labels.</p></li> |
| <li><p><strong>preds</strong> (<em>OrderedDict of str -> NDArray</em>) – name to array mapping of predicted outputs.</p></li> |
| </ul> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="class"> |
| <dt id="mxnet.gluon.metric.CrossEntropy"> |
| <em class="property">class </em><code class="sig-name descname">CrossEntropy</code><span class="sig-paren">(</span><em class="sig-param">eps=1e-12</em>, <em class="sig-param">ignore_label=None</em>, <em class="sig-param">axis=-1</em>, <em class="sig-param">from_logits=False</em>, <em class="sig-param">name='cross-entropy'</em>, <em class="sig-param">output_names=None</em>, <em class="sig-param">label_names=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/mxnet/gluon/metric.html#CrossEntropy"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#mxnet.gluon.metric.CrossEntropy" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Bases: <a class="reference internal" href="#mxnet.gluon.metric.EvalMetric" title="mxnet.gluon.metric.EvalMetric"><code class="xref py py-class docutils literal notranslate"><span class="pre">mxnet.gluon.metric.EvalMetric</span></code></a></p> |
| <p>Computes Cross Entropy loss.</p> |
| <p>The cross entropy over a batch of sample size <span class="math notranslate nohighlight">\(N\)</span> is given by</p> |
| <div class="math notranslate nohighlight"> |
| \[-\sum_{n=1}^{N}\sum_{k=1}^{K}t_{nk}\log (y_{nk}),\]</div> |
| <p><strong>Methods</strong></p> |
| <table class="longtable docutils align-default"> |
| <colgroup> |
| <col style="width: 10%" /> |
| <col style="width: 90%" /> |
| </colgroup> |
| <tbody> |
| <tr class="row-odd"><td><p><a class="reference internal" href="#mxnet.gluon.metric.CrossEntropy.get" title="mxnet.gluon.metric.CrossEntropy.get"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get</span></code></a>()</p></td> |
| <td><p>Gets the current evaluation result.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="#mxnet.gluon.metric.CrossEntropy.get_config" title="mxnet.gluon.metric.CrossEntropy.get_config"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_config</span></code></a>()</p></td> |
| <td><p>Save configurations of metric.</p></td> |
| </tr> |
| <tr class="row-odd"><td><p><a class="reference internal" href="#mxnet.gluon.metric.CrossEntropy.get_name_value" title="mxnet.gluon.metric.CrossEntropy.get_name_value"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_name_value</span></code></a>()</p></td> |
| <td><p>Returns zipped name and value pairs.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="#mxnet.gluon.metric.CrossEntropy.reset" title="mxnet.gluon.metric.CrossEntropy.reset"><code class="xref py py-obj docutils literal notranslate"><span class="pre">reset</span></code></a>()</p></td> |
| <td><p>Resets the internal evaluation result to initial state.</p></td> |
| </tr> |
| <tr class="row-odd"><td><p><a class="reference internal" href="#mxnet.gluon.metric.CrossEntropy.update" title="mxnet.gluon.metric.CrossEntropy.update"><code class="xref py py-obj docutils literal notranslate"><span class="pre">update</span></code></a>(labels, preds)</p></td> |
| <td><p>Updates the internal evaluation result.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="#mxnet.gluon.metric.CrossEntropy.update_dict" title="mxnet.gluon.metric.CrossEntropy.update_dict"><code class="xref py py-obj docutils literal notranslate"><span class="pre">update_dict</span></code></a>(label, pred)</p></td> |
| <td><p>Update the internal evaluation with named label and pred</p></td> |
| </tr> |
| </tbody> |
| </table> |
| <p>where <span class="math notranslate nohighlight">\(t_{nk}=1\)</span> if and only if sample <span class="math notranslate nohighlight">\(n\)</span> belongs to class <span class="math notranslate nohighlight">\(k\)</span>. |
| <span class="math notranslate nohighlight">\(y_{nk}\)</span> denotes the probability of sample <span class="math notranslate nohighlight">\(n\)</span> belonging to |
| class <span class="math notranslate nohighlight">\(k\)</span>.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters</dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>eps</strong> (<em>float</em><em>, </em><em>default 1e-12</em>) – Use small constant for the case that predicted value is 0.</p></li> |
| <li><p><strong>ignore_label</strong> (<em>int</em><em> or </em><em>None</em><em>, </em><em>default None</em>) – Index of invalid label to ignore when |
| counting. By default, sets to -1. |
| If set to <cite>None</cite>, it will include all entries.</p></li> |
| <li><p><strong>axis</strong> (<em>int</em><em>, </em><em>default -1</em>) – The axis from prediction that was used to |
| compute softmax. By default use the last axis.</p></li> |
| <li><p><strong>from_logits</strong> (<em>boolean</em><em>, </em><em>default False</em>) – Whether <cite>pred</cite> is expected to be a logits tensor. |
| By default, we assume that <cite>pred</cite> encodes a probability distribution.</p></li> |
| <li><p><strong>name</strong> (<em>str</em>) – Name of this metric instance for display.</p></li> |
| <li><p><strong>output_names</strong> (<em>list of str</em><em>, or </em><em>None</em>) – Name of predictions that should be used when updating with update_dict. |
| By default include all predictions.</p></li> |
| <li><p><strong>label_names</strong> (<em>list of str</em><em>, or </em><em>None</em>) – Name of labels that should be used when updating with update_dict. |
| By default include all labels.</p></li> |
| </ul> |
| </dd> |
| </dl> |
| <p class="rubric">Examples</p> |
| <div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">predicts</span> <span class="o">=</span> <span class="p">[</span><span class="n">mx</span><span class="o">.</span><span class="n">np</span><span class="o">.</span><span class="n">array</span><span class="p">([[</span><span class="mf">0.3</span><span class="p">,</span> <span class="mf">0.7</span><span class="p">],</span> <span class="p">[</span><span class="mi">0</span><span class="p">,</span> <span class="mf">1.</span><span class="p">],</span> <span class="p">[</span><span class="mf">0.4</span><span class="p">,</span> <span class="mf">0.6</span><span class="p">]])]</span> |
| <span class="gp">>>> </span><span class="n">labels</span> <span class="o">=</span> <span class="p">[</span><span class="n">mx</span><span class="o">.</span><span class="n">np</span><span class="o">.</span><span class="n">array</span><span class="p">([</span><span class="mi">0</span><span class="p">,</span> <span class="mi">1</span><span class="p">,</span> <span class="mi">1</span><span class="p">])]</span> |
| <span class="gp">>>> </span><span class="n">ce</span> <span class="o">=</span> <span class="n">mx</span><span class="o">.</span><span class="n">gluon</span><span class="o">.</span><span class="n">metric</span><span class="o">.</span><span class="n">CrossEntropy</span><span class="p">()</span> |
| <span class="gp">>>> </span><span class="n">ce</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="n">labels</span><span class="p">,</span> <span class="n">predicts</span><span class="p">)</span> |
| <span class="gp">>>> </span><span class="n">ce</span><span class="o">.</span><span class="n">get</span><span class="p">()</span> |
| <span class="go">('cross-entropy', 0.57159948348999023)</span> |
| </pre></div> |
| </div> |
| <dl class="method"> |
| <dt id="mxnet.gluon.metric.CrossEntropy.get"> |
| <code class="sig-name descname">get</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#mxnet.gluon.metric.CrossEntropy.get" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Gets the current evaluation result.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Returns</dt> |
| <dd class="field-odd"><p><ul class="simple"> |
| <li><p><strong>names</strong> (<em>list of str</em>) – Name of the metrics.</p></li> |
| <li><p><strong>values</strong> (<em>list of float</em>) – Value of the evaluations.</p></li> |
| </ul> |
| </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="mxnet.gluon.metric.CrossEntropy.get_config"> |
| <code class="sig-name descname">get_config</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#mxnet.gluon.metric.CrossEntropy.get_config" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Save configurations of metric. Can be recreated |
| from configs with metric.create(<code class="docutils literal notranslate"><span class="pre">**config</span></code>)</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="mxnet.gluon.metric.CrossEntropy.get_name_value"> |
| <code class="sig-name descname">get_name_value</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#mxnet.gluon.metric.CrossEntropy.get_name_value" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Returns zipped name and value pairs.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Returns</dt> |
| <dd class="field-odd"><p>A (name, value) tuple list.</p> |
| </dd> |
| <dt class="field-even">Return type</dt> |
| <dd class="field-even"><p>list of tuples</p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="mxnet.gluon.metric.CrossEntropy.reset"> |
| <code class="sig-name descname">reset</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#mxnet.gluon.metric.CrossEntropy.reset" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Resets the internal evaluation result to initial state.</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="mxnet.gluon.metric.CrossEntropy.update"> |
| <code class="sig-name descname">update</code><span class="sig-paren">(</span><em class="sig-param">labels</em>, <em class="sig-param">preds</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/mxnet/gluon/metric.html#CrossEntropy.update"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#mxnet.gluon.metric.CrossEntropy.update" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Updates the internal evaluation result.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters</dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>labels</strong> (list of <cite>NDArray</cite>) – The labels of the data.</p></li> |
| <li><p><strong>preds</strong> (list of <cite>NDArray</cite>) – Predicted values.</p></li> |
| </ul> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="mxnet.gluon.metric.CrossEntropy.update_dict"> |
| <code class="sig-name descname">update_dict</code><span class="sig-paren">(</span><em class="sig-param">label</em>, <em class="sig-param">pred</em><span class="sig-paren">)</span><a class="headerlink" href="#mxnet.gluon.metric.CrossEntropy.update_dict" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Update the internal evaluation with named label and pred</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters</dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>labels</strong> (<em>OrderedDict of str -> NDArray</em>) – name to array mapping for labels.</p></li> |
| <li><p><strong>preds</strong> (<em>OrderedDict of str -> NDArray</em>) – name to array mapping of predicted outputs.</p></li> |
| </ul> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="class"> |
| <dt id="mxnet.gluon.metric.CustomMetric"> |
| <em class="property">class </em><code class="sig-name descname">CustomMetric</code><span class="sig-paren">(</span><em class="sig-param">feval</em>, <em class="sig-param">name=None</em>, <em class="sig-param">allow_extra_outputs=False</em>, <em class="sig-param">output_names=None</em>, <em class="sig-param">label_names=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/mxnet/gluon/metric.html#CustomMetric"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#mxnet.gluon.metric.CustomMetric" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Bases: <a class="reference internal" href="#mxnet.gluon.metric.EvalMetric" title="mxnet.gluon.metric.EvalMetric"><code class="xref py py-class docutils literal notranslate"><span class="pre">mxnet.gluon.metric.EvalMetric</span></code></a></p> |
| <p>Computes a customized evaluation metric.</p> |
| <p>The <cite>feval</cite> function can return a <cite>tuple</cite> of (sum_metric, num_inst) or return |
| an <cite>int</cite> sum_metric.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters</dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>feval</strong> (<em>callable</em><em>(</em><em>label</em><em>, </em><em>pred</em><em>)</em>) – Customized evaluation function.</p></li> |
| <li><p><strong>name</strong> (<em>str</em>) – The name of the metric. (the default is None).</p></li> |
| <li><p><strong>allow_extra_outputs</strong> (<em>bool</em><em>, </em><em>optional</em>) – If true, the prediction outputs can have extra outputs. |
| This is useful in RNN, where the states are also produced |
| in outputs for forwarding. (the default is False).</p></li> |
| <li><p><strong>name</strong> – Name of this metric instance for display.</p></li> |
| <li><p><strong>output_names</strong> (<em>list of str</em><em>, or </em><em>None</em>) – Name of predictions that should be used when updating with update_dict. |
| By default include all predictions.</p></li> |
| <li><p><strong>label_names</strong> (<em>list of str</em><em>, or </em><em>None</em>) – Name of labels that should be used when updating with update_dict. |
| By default include all labels.</p></li> |
| </ul> |
| </dd> |
| </dl> |
| <p><strong>Methods</strong></p> |
| <table class="longtable docutils align-default"> |
| <colgroup> |
| <col style="width: 10%" /> |
| <col style="width: 90%" /> |
| </colgroup> |
| <tbody> |
| <tr class="row-odd"><td><p><a class="reference internal" href="#mxnet.gluon.metric.CustomMetric.get" title="mxnet.gluon.metric.CustomMetric.get"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get</span></code></a>()</p></td> |
| <td><p>Gets the current evaluation result.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="#mxnet.gluon.metric.CustomMetric.get_config" title="mxnet.gluon.metric.CustomMetric.get_config"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_config</span></code></a>()</p></td> |
| <td><p>Save configurations of metric.</p></td> |
| </tr> |
| <tr class="row-odd"><td><p><a class="reference internal" href="#mxnet.gluon.metric.CustomMetric.get_name_value" title="mxnet.gluon.metric.CustomMetric.get_name_value"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_name_value</span></code></a>()</p></td> |
| <td><p>Returns zipped name and value pairs.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="#mxnet.gluon.metric.CustomMetric.reset" title="mxnet.gluon.metric.CustomMetric.reset"><code class="xref py py-obj docutils literal notranslate"><span class="pre">reset</span></code></a>()</p></td> |
| <td><p>Resets the internal evaluation result to initial state.</p></td> |
| </tr> |
| <tr class="row-odd"><td><p><a class="reference internal" href="#mxnet.gluon.metric.CustomMetric.update" title="mxnet.gluon.metric.CustomMetric.update"><code class="xref py py-obj docutils literal notranslate"><span class="pre">update</span></code></a>(labels, preds)</p></td> |
| <td><p>Updates the internal evaluation result.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="#mxnet.gluon.metric.CustomMetric.update_dict" title="mxnet.gluon.metric.CustomMetric.update_dict"><code class="xref py py-obj docutils literal notranslate"><span class="pre">update_dict</span></code></a>(label, pred)</p></td> |
| <td><p>Update the internal evaluation with named label and pred</p></td> |
| </tr> |
| </tbody> |
| </table> |
| <p class="rubric">Examples</p> |
| <div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">predicts</span> <span class="o">=</span> <span class="p">[</span><span class="n">mx</span><span class="o">.</span><span class="n">np</span><span class="o">.</span><span class="n">array</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">array</span><span class="p">([</span><span class="mi">3</span><span class="p">,</span> <span class="o">-</span><span class="mf">0.5</span><span class="p">,</span> <span class="mi">2</span><span class="p">,</span> <span class="mi">7</span><span class="p">])</span><span class="o">.</span><span class="n">reshape</span><span class="p">(</span><span class="mi">4</span><span class="p">,</span><span class="mi">1</span><span class="p">))]</span> |
| <span class="gp">>>> </span><span class="n">labels</span> <span class="o">=</span> <span class="p">[</span><span class="n">mx</span><span class="o">.</span><span class="n">np</span><span class="o">.</span><span class="n">array</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">array</span><span class="p">([</span><span class="mf">2.5</span><span class="p">,</span> <span class="mf">0.0</span><span class="p">,</span> <span class="mi">2</span><span class="p">,</span> <span class="mi">8</span><span class="p">])</span><span class="o">.</span><span class="n">reshape</span><span class="p">(</span><span class="mi">4</span><span class="p">,</span><span class="mi">1</span><span class="p">))]</span> |
| <span class="gp">>>> </span><span class="n">feval</span> <span class="o">=</span> <span class="k">lambda</span> <span class="n">x</span><span class="p">,</span> <span class="n">y</span> <span class="p">:</span> <span class="p">(</span><span class="n">x</span> <span class="o">+</span> <span class="n">y</span><span class="p">)</span><span class="o">.</span><span class="n">mean</span><span class="p">()</span> |
| <span class="gp">>>> </span><span class="n">eval_metrics</span> <span class="o">=</span> <span class="n">mx</span><span class="o">.</span><span class="n">gluon</span><span class="o">.</span><span class="n">metric</span><span class="o">.</span><span class="n">CustomMetric</span><span class="p">(</span><span class="n">feval</span><span class="o">=</span><span class="n">feval</span><span class="p">)</span> |
| <span class="gp">>>> </span><span class="n">eval_metrics</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="n">labels</span><span class="p">,</span> <span class="n">predicts</span><span class="p">)</span> |
| <span class="gp">>>> </span><span class="n">eval_metrics</span><span class="o">.</span><span class="n">get</span><span class="p">()</span> |
| <span class="go">('custom(<lambda>)', 6.0)</span> |
| </pre></div> |
| </div> |
| <dl class="method"> |
| <dt id="mxnet.gluon.metric.CustomMetric.get"> |
| <code class="sig-name descname">get</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#mxnet.gluon.metric.CustomMetric.get" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Gets the current evaluation result.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Returns</dt> |
| <dd class="field-odd"><p><ul class="simple"> |
| <li><p><strong>names</strong> (<em>list of str</em>) – Name of the metrics.</p></li> |
| <li><p><strong>values</strong> (<em>list of float</em>) – Value of the evaluations.</p></li> |
| </ul> |
| </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="mxnet.gluon.metric.CustomMetric.get_config"> |
| <code class="sig-name descname">get_config</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/mxnet/gluon/metric.html#CustomMetric.get_config"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#mxnet.gluon.metric.CustomMetric.get_config" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Save configurations of metric. Can be recreated |
| from configs with metric.create(<code class="docutils literal notranslate"><span class="pre">**config</span></code>)</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="mxnet.gluon.metric.CustomMetric.get_name_value"> |
| <code class="sig-name descname">get_name_value</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#mxnet.gluon.metric.CustomMetric.get_name_value" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Returns zipped name and value pairs.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Returns</dt> |
| <dd class="field-odd"><p>A (name, value) tuple list.</p> |
| </dd> |
| <dt class="field-even">Return type</dt> |
| <dd class="field-even"><p>list of tuples</p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="mxnet.gluon.metric.CustomMetric.reset"> |
| <code class="sig-name descname">reset</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#mxnet.gluon.metric.CustomMetric.reset" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Resets the internal evaluation result to initial state.</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="mxnet.gluon.metric.CustomMetric.update"> |
| <code class="sig-name descname">update</code><span class="sig-paren">(</span><em class="sig-param">labels</em>, <em class="sig-param">preds</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/mxnet/gluon/metric.html#CustomMetric.update"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#mxnet.gluon.metric.CustomMetric.update" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Updates the internal evaluation result.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters</dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>labels</strong> (list of <cite>NDArray</cite>) – The labels of the data.</p></li> |
| <li><p><strong>preds</strong> (list of <cite>NDArray</cite>) – Predicted values.</p></li> |
| </ul> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="mxnet.gluon.metric.CustomMetric.update_dict"> |
| <code class="sig-name descname">update_dict</code><span class="sig-paren">(</span><em class="sig-param">label</em>, <em class="sig-param">pred</em><span class="sig-paren">)</span><a class="headerlink" href="#mxnet.gluon.metric.CustomMetric.update_dict" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Update the internal evaluation with named label and pred</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters</dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>labels</strong> (<em>OrderedDict of str -> NDArray</em>) – name to array mapping for labels.</p></li> |
| <li><p><strong>preds</strong> (<em>OrderedDict of str -> NDArray</em>) – name to array mapping of predicted outputs.</p></li> |
| </ul> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="class"> |
| <dt id="mxnet.gluon.metric.EvalMetric"> |
| <em class="property">class </em><code class="sig-name descname">EvalMetric</code><span class="sig-paren">(</span><em class="sig-param">name</em>, <em class="sig-param">output_names=None</em>, <em class="sig-param">label_names=None</em>, <em class="sig-param">**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/mxnet/gluon/metric.html#EvalMetric"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#mxnet.gluon.metric.EvalMetric" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p> |
| <p>Base class for all evaluation metrics.</p> |
| <div class="admonition note"> |
| <p class="admonition-title">Note</p> |
| <p>This is a base class that provides common metric interfaces. |
| One should not use this class directly, but instead create new metric |
| classes that extend it.</p> |
| </div> |
| <p><strong>Methods</strong></p> |
| <table class="longtable docutils align-default"> |
| <colgroup> |
| <col style="width: 10%" /> |
| <col style="width: 90%" /> |
| </colgroup> |
| <tbody> |
| <tr class="row-odd"><td><p><a class="reference internal" href="#mxnet.gluon.metric.EvalMetric.get" title="mxnet.gluon.metric.EvalMetric.get"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get</span></code></a>()</p></td> |
| <td><p>Gets the current evaluation result.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="#mxnet.gluon.metric.EvalMetric.get_config" title="mxnet.gluon.metric.EvalMetric.get_config"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_config</span></code></a>()</p></td> |
| <td><p>Save configurations of metric.</p></td> |
| </tr> |
| <tr class="row-odd"><td><p><a class="reference internal" href="#mxnet.gluon.metric.EvalMetric.get_name_value" title="mxnet.gluon.metric.EvalMetric.get_name_value"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_name_value</span></code></a>()</p></td> |
| <td><p>Returns zipped name and value pairs.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="#mxnet.gluon.metric.EvalMetric.reset" title="mxnet.gluon.metric.EvalMetric.reset"><code class="xref py py-obj docutils literal notranslate"><span class="pre">reset</span></code></a>()</p></td> |
| <td><p>Resets the internal evaluation result to initial state.</p></td> |
| </tr> |
| <tr class="row-odd"><td><p><a class="reference internal" href="#mxnet.gluon.metric.EvalMetric.update" title="mxnet.gluon.metric.EvalMetric.update"><code class="xref py py-obj docutils literal notranslate"><span class="pre">update</span></code></a>(labels, preds)</p></td> |
| <td><p>Updates the internal evaluation result.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="#mxnet.gluon.metric.EvalMetric.update_dict" title="mxnet.gluon.metric.EvalMetric.update_dict"><code class="xref py py-obj docutils literal notranslate"><span class="pre">update_dict</span></code></a>(label, pred)</p></td> |
| <td><p>Update the internal evaluation with named label and pred</p></td> |
| </tr> |
| </tbody> |
| </table> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters</dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>name</strong> (<em>str</em>) – Name of this metric instance for display.</p></li> |
| <li><p><strong>output_names</strong> (<em>list of str</em><em>, or </em><em>None</em>) – Name of predictions that should be used when updating with update_dict. |
| By default include all predictions.</p></li> |
| <li><p><strong>label_names</strong> (<em>list of str</em><em>, or </em><em>None</em>) – Name of labels that should be used when updating with update_dict. |
| By default include all labels.</p></li> |
| </ul> |
| </dd> |
| </dl> |
| <dl class="method"> |
| <dt id="mxnet.gluon.metric.EvalMetric.get"> |
| <code class="sig-name descname">get</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/mxnet/gluon/metric.html#EvalMetric.get"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#mxnet.gluon.metric.EvalMetric.get" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Gets the current evaluation result.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Returns</dt> |
| <dd class="field-odd"><p><ul class="simple"> |
| <li><p><strong>names</strong> (<em>list of str</em>) – Name of the metrics.</p></li> |
| <li><p><strong>values</strong> (<em>list of float</em>) – Value of the evaluations.</p></li> |
| </ul> |
| </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="mxnet.gluon.metric.EvalMetric.get_config"> |
| <code class="sig-name descname">get_config</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/mxnet/gluon/metric.html#EvalMetric.get_config"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#mxnet.gluon.metric.EvalMetric.get_config" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Save configurations of metric. Can be recreated |
| from configs with metric.create(<code class="docutils literal notranslate"><span class="pre">**config</span></code>)</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="mxnet.gluon.metric.EvalMetric.get_name_value"> |
| <code class="sig-name descname">get_name_value</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/mxnet/gluon/metric.html#EvalMetric.get_name_value"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#mxnet.gluon.metric.EvalMetric.get_name_value" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Returns zipped name and value pairs.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Returns</dt> |
| <dd class="field-odd"><p>A (name, value) tuple list.</p> |
| </dd> |
| <dt class="field-even">Return type</dt> |
| <dd class="field-even"><p>list of tuples</p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="mxnet.gluon.metric.EvalMetric.reset"> |
| <code class="sig-name descname">reset</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/mxnet/gluon/metric.html#EvalMetric.reset"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#mxnet.gluon.metric.EvalMetric.reset" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Resets the internal evaluation result to initial state.</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="mxnet.gluon.metric.EvalMetric.update"> |
| <code class="sig-name descname">update</code><span class="sig-paren">(</span><em class="sig-param">labels</em>, <em class="sig-param">preds</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/mxnet/gluon/metric.html#EvalMetric.update"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#mxnet.gluon.metric.EvalMetric.update" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Updates the internal evaluation result.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters</dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>labels</strong> (list of <cite>NDArray</cite>) – The labels of the data.</p></li> |
| <li><p><strong>preds</strong> (list of <cite>NDArray</cite>) – Predicted values.</p></li> |
| </ul> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="mxnet.gluon.metric.EvalMetric.update_dict"> |
| <code class="sig-name descname">update_dict</code><span class="sig-paren">(</span><em class="sig-param">label</em>, <em class="sig-param">pred</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/mxnet/gluon/metric.html#EvalMetric.update_dict"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#mxnet.gluon.metric.EvalMetric.update_dict" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Update the internal evaluation with named label and pred</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters</dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>labels</strong> (<em>OrderedDict of str -> NDArray</em>) – name to array mapping for labels.</p></li> |
| <li><p><strong>preds</strong> (<em>OrderedDict of str -> NDArray</em>) – name to array mapping of predicted outputs.</p></li> |
| </ul> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="class"> |
| <dt id="mxnet.gluon.metric.F1"> |
| <em class="property">class </em><code class="sig-name descname">F1</code><span class="sig-paren">(</span><em class="sig-param">name='f1'</em>, <em class="sig-param">output_names=None</em>, <em class="sig-param">label_names=None</em>, <em class="sig-param">class_type='binary'</em>, <em class="sig-param">threshold=0.5</em>, <em class="sig-param">average='micro'</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/mxnet/gluon/metric.html#F1"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#mxnet.gluon.metric.F1" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Bases: <a class="reference internal" href="#mxnet.gluon.metric.EvalMetric" title="mxnet.gluon.metric.EvalMetric"><code class="xref py py-class docutils literal notranslate"><span class="pre">mxnet.gluon.metric.EvalMetric</span></code></a></p> |
| <p>Computes the F1 score of a binary classification problem.</p> |
| <p>The F1 score is equivalent to harmonic mean of the precision and recall, |
| where the best value is 1.0 and the worst value is 0.0. The formula for F1 score is:</p> |
| <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">F1</span> <span class="o">=</span> <span class="mi">2</span> <span class="o">*</span> <span class="p">(</span><span class="n">precision</span> <span class="o">*</span> <span class="n">recall</span><span class="p">)</span> <span class="o">/</span> <span class="p">(</span><span class="n">precision</span> <span class="o">+</span> <span class="n">recall</span><span class="p">)</span> |
| </pre></div> |
| </div> |
| <p><strong>Methods</strong></p> |
| <table class="longtable docutils align-default"> |
| <colgroup> |
| <col style="width: 10%" /> |
| <col style="width: 90%" /> |
| </colgroup> |
| <tbody> |
| <tr class="row-odd"><td><p><a class="reference internal" href="#mxnet.gluon.metric.F1.get" title="mxnet.gluon.metric.F1.get"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get</span></code></a>()</p></td> |
| <td><p>Gets the current evaluation result.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="#mxnet.gluon.metric.F1.get_config" title="mxnet.gluon.metric.F1.get_config"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_config</span></code></a>()</p></td> |
| <td><p>Save configurations of metric.</p></td> |
| </tr> |
| <tr class="row-odd"><td><p><a class="reference internal" href="#mxnet.gluon.metric.F1.get_name_value" title="mxnet.gluon.metric.F1.get_name_value"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_name_value</span></code></a>()</p></td> |
| <td><p>Returns zipped name and value pairs.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="#mxnet.gluon.metric.F1.reset" title="mxnet.gluon.metric.F1.reset"><code class="xref py py-obj docutils literal notranslate"><span class="pre">reset</span></code></a>()</p></td> |
| <td><p>Resets the internal evaluation result to initial state.</p></td> |
| </tr> |
| <tr class="row-odd"><td><p><a class="reference internal" href="#mxnet.gluon.metric.F1.update" title="mxnet.gluon.metric.F1.update"><code class="xref py py-obj docutils literal notranslate"><span class="pre">update</span></code></a>(labels, preds)</p></td> |
| <td><p>Updates the internal evaluation result.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="#mxnet.gluon.metric.F1.update_dict" title="mxnet.gluon.metric.F1.update_dict"><code class="xref py py-obj docutils literal notranslate"><span class="pre">update_dict</span></code></a>(label, pred)</p></td> |
| <td><p>Update the internal evaluation with named label and pred</p></td> |
| </tr> |
| </tbody> |
| </table> |
| <p>The formula for precision and recall is:</p> |
| <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">precision</span> <span class="o">=</span> <span class="n">true_positives</span> <span class="o">/</span> <span class="p">(</span><span class="n">true_positives</span> <span class="o">+</span> <span class="n">false_positives</span><span class="p">)</span> |
| <span class="n">recall</span> <span class="o">=</span> <span class="n">true_positives</span> <span class="o">/</span> <span class="p">(</span><span class="n">true_positives</span> <span class="o">+</span> <span class="n">false_negatives</span><span class="p">)</span> |
| </pre></div> |
| </div> |
| <div class="admonition note"> |
| <p class="admonition-title">Note</p> |
| <p>This F1 score only supports binary classification.</p> |
| </div> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters</dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>name</strong> (<em>str</em>) – Name of this metric instance for display.</p></li> |
| <li><p><strong>output_names</strong> (<em>list of str</em><em>, or </em><em>None</em>) – Name of predictions that should be used when updating with update_dict. |
| By default include all predictions.</p></li> |
| <li><p><strong>label_names</strong> (<em>list of str</em><em>, or </em><em>None</em>) – Name of labels that should be used when updating with update_dict. |
| By default include all labels.</p></li> |
| <li><p><strong>class_type</strong> (<em>str</em><em>, </em><em>default "binary"</em>) – “binary”: f1 for binary classification. |
| “multiclass”: f1 for multiclassification problem. |
| “multilabel”: f1 for multilabel classification.</p></li> |
| <li><p><strong>threshold</strong> (<em>float</em><em>, </em><em>default 0.5</em>) – threshold for postive confidence value.</p></li> |
| <li><p><strong>average</strong> (<em>str</em><em>, </em><em>default 'micro'</em>) – <dl class="simple"> |
| <dt>Strategy to be used for aggregating across mini-batches.</dt><dd><p>”macro”: Calculate metrics for each label and return unweighted mean of f1. |
| “micro”: Calculate metrics globally by counting the total TP, FN and FP. |
| None: Return f1 scores for each class (numpy.ndarray) .</p> |
| </dd> |
| </dl> |
| </p></li> |
| </ul> |
| </dd> |
| </dl> |
| <p class="rubric">Examples</p> |
| <div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">predicts</span> <span class="o">=</span> <span class="p">[</span><span class="n">mx</span><span class="o">.</span><span class="n">np</span><span class="o">.</span><span class="n">array</span><span class="p">([[</span><span class="mf">0.3</span><span class="p">,</span> <span class="mf">0.7</span><span class="p">],</span> <span class="p">[</span><span class="mf">0.</span><span class="p">,</span> <span class="mf">1.</span><span class="p">],</span> <span class="p">[</span><span class="mf">0.4</span><span class="p">,</span> <span class="mf">0.6</span><span class="p">]])]</span> |
| <span class="gp">>>> </span><span class="n">labels</span> <span class="o">=</span> <span class="p">[</span><span class="n">mx</span><span class="o">.</span><span class="n">np</span><span class="o">.</span><span class="n">array</span><span class="p">([</span><span class="mf">0.</span><span class="p">,</span> <span class="mf">1.</span><span class="p">,</span> <span class="mf">1.</span><span class="p">])]</span> |
| <span class="gp">>>> </span><span class="n">f1</span> <span class="o">=</span> <span class="n">mx</span><span class="o">.</span><span class="n">gluon</span><span class="o">.</span><span class="n">metric</span><span class="o">.</span><span class="n">F1</span><span class="p">()</span> |
| <span class="gp">>>> </span><span class="n">f1</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="n">preds</span> <span class="o">=</span> <span class="n">predicts</span><span class="p">,</span> <span class="n">labels</span> <span class="o">=</span> <span class="n">labels</span><span class="p">)</span> |
| <span class="gp">>>> </span><span class="n">f1</span><span class="o">.</span><span class="n">get</span><span class="p">()</span> |
| <span class="go">('f1', 0.8)</span> |
| </pre></div> |
| </div> |
| <dl class="method"> |
| <dt id="mxnet.gluon.metric.F1.get"> |
| <code class="sig-name descname">get</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#mxnet.gluon.metric.F1.get" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Gets the current evaluation result.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Returns</dt> |
| <dd class="field-odd"><p><ul class="simple"> |
| <li><p><strong>names</strong> (<em>list of str</em>) – Name of the metrics.</p></li> |
| <li><p><strong>values</strong> (<em>list of float</em>) – Value of the evaluations.</p></li> |
| </ul> |
| </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="mxnet.gluon.metric.F1.get_config"> |
| <code class="sig-name descname">get_config</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#mxnet.gluon.metric.F1.get_config" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Save configurations of metric. Can be recreated |
| from configs with metric.create(<code class="docutils literal notranslate"><span class="pre">**config</span></code>)</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="mxnet.gluon.metric.F1.get_name_value"> |
| <code class="sig-name descname">get_name_value</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#mxnet.gluon.metric.F1.get_name_value" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Returns zipped name and value pairs.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Returns</dt> |
| <dd class="field-odd"><p>A (name, value) tuple list.</p> |
| </dd> |
| <dt class="field-even">Return type</dt> |
| <dd class="field-even"><p>list of tuples</p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="mxnet.gluon.metric.F1.reset"> |
| <code class="sig-name descname">reset</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/mxnet/gluon/metric.html#F1.reset"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#mxnet.gluon.metric.F1.reset" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Resets the internal evaluation result to initial state.</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="mxnet.gluon.metric.F1.update"> |
| <code class="sig-name descname">update</code><span class="sig-paren">(</span><em class="sig-param">labels</em>, <em class="sig-param">preds</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/mxnet/gluon/metric.html#F1.update"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#mxnet.gluon.metric.F1.update" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Updates the internal evaluation result.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters</dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>labels</strong> (list of <cite>NDArray</cite>) – The labels of the data.</p></li> |
| <li><p><strong>preds</strong> (list of <cite>NDArray</cite>) – Predicted values.</p></li> |
| </ul> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="mxnet.gluon.metric.F1.update_dict"> |
| <code class="sig-name descname">update_dict</code><span class="sig-paren">(</span><em class="sig-param">label</em>, <em class="sig-param">pred</em><span class="sig-paren">)</span><a class="headerlink" href="#mxnet.gluon.metric.F1.update_dict" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Update the internal evaluation with named label and pred</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters</dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>labels</strong> (<em>OrderedDict of str -> NDArray</em>) – name to array mapping for labels.</p></li> |
| <li><p><strong>preds</strong> (<em>OrderedDict of str -> NDArray</em>) – name to array mapping of predicted outputs.</p></li> |
| </ul> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="class"> |
| <dt id="mxnet.gluon.metric.Fbeta"> |
| <em class="property">class </em><code class="sig-name descname">Fbeta</code><span class="sig-paren">(</span><em class="sig-param">name='fbeta'</em>, <em class="sig-param">output_names=None</em>, <em class="sig-param">label_names=None</em>, <em class="sig-param">class_type='binary'</em>, <em class="sig-param">beta=1</em>, <em class="sig-param">threshold=0.5</em>, <em class="sig-param">average='micro'</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/mxnet/gluon/metric.html#Fbeta"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#mxnet.gluon.metric.Fbeta" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Bases: <a class="reference internal" href="#mxnet.gluon.metric.F1" title="mxnet.gluon.metric.F1"><code class="xref py py-class docutils literal notranslate"><span class="pre">mxnet.gluon.metric.F1</span></code></a></p> |
| <p>Computes the Fbeta score of a binary classification problem.</p> |
| <p>The Fbeta score is equivalent to harmonic mean of the precision and recall, |
| where the best value is 1.0 and the worst value is 0.0. The formula for Fbeta score is:</p> |
| <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">Fbeta</span> <span class="o">=</span> <span class="p">(</span><span class="mi">1</span> <span class="o">+</span> <span class="n">beta</span> <span class="o">**</span> <span class="mi">2</span><span class="p">)</span> <span class="o">*</span> <span class="p">(</span><span class="n">precision</span> <span class="o">*</span> <span class="n">recall</span><span class="p">)</span> <span class="o">/</span> <span class="p">(</span><span class="n">beta</span> <span class="o">**</span> <span class="mi">2</span> <span class="o">*</span> <span class="n">precision</span> <span class="o">+</span> <span class="n">recall</span><span class="p">)</span> |
| </pre></div> |
| </div> |
| <p><strong>Methods</strong></p> |
| <table class="longtable docutils align-default"> |
| <colgroup> |
| <col style="width: 10%" /> |
| <col style="width: 90%" /> |
| </colgroup> |
| <tbody> |
| <tr class="row-odd"><td><p><a class="reference internal" href="#mxnet.gluon.metric.Fbeta.get" title="mxnet.gluon.metric.Fbeta.get"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get</span></code></a>()</p></td> |
| <td><p>Gets the current evaluation result.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="#mxnet.gluon.metric.Fbeta.get_config" title="mxnet.gluon.metric.Fbeta.get_config"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_config</span></code></a>()</p></td> |
| <td><p>Save configurations of metric.</p></td> |
| </tr> |
| <tr class="row-odd"><td><p><a class="reference internal" href="#mxnet.gluon.metric.Fbeta.get_name_value" title="mxnet.gluon.metric.Fbeta.get_name_value"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_name_value</span></code></a>()</p></td> |
| <td><p>Returns zipped name and value pairs.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="#mxnet.gluon.metric.Fbeta.reset" title="mxnet.gluon.metric.Fbeta.reset"><code class="xref py py-obj docutils literal notranslate"><span class="pre">reset</span></code></a>()</p></td> |
| <td><p>Resets the internal evaluation result to initial state.</p></td> |
| </tr> |
| <tr class="row-odd"><td><p><a class="reference internal" href="#mxnet.gluon.metric.Fbeta.update" title="mxnet.gluon.metric.Fbeta.update"><code class="xref py py-obj docutils literal notranslate"><span class="pre">update</span></code></a>(labels, preds)</p></td> |
| <td><p>Updates the internal evaluation result.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="#mxnet.gluon.metric.Fbeta.update_dict" title="mxnet.gluon.metric.Fbeta.update_dict"><code class="xref py py-obj docutils literal notranslate"><span class="pre">update_dict</span></code></a>(label, pred)</p></td> |
| <td><p>Update the internal evaluation with named label and pred</p></td> |
| </tr> |
| </tbody> |
| </table> |
| <p>The formula for precision and recall is:</p> |
| <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">precision</span> <span class="o">=</span> <span class="n">true_positives</span> <span class="o">/</span> <span class="p">(</span><span class="n">true_positives</span> <span class="o">+</span> <span class="n">false_positives</span><span class="p">)</span> |
| <span class="n">recall</span> <span class="o">=</span> <span class="n">true_positives</span> <span class="o">/</span> <span class="p">(</span><span class="n">true_positives</span> <span class="o">+</span> <span class="n">false_negatives</span><span class="p">)</span> |
| </pre></div> |
| </div> |
| <div class="admonition note"> |
| <p class="admonition-title">Note</p> |
| <p>This Fbeta score only supports binary classification.</p> |
| </div> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters</dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>name</strong> (<em>str</em>) – Name of this metric instance for display.</p></li> |
| <li><p><strong>output_names</strong> (<em>list of str</em><em>, or </em><em>None</em>) – Name of predictions that should be used when updating with update_dict. |
| By default include all predictions.</p></li> |
| <li><p><strong>label_names</strong> (<em>list of str</em><em>, or </em><em>None</em>) – Name of labels that should be used when updating with update_dict. |
| By default include all labels.</p></li> |
| <li><p><strong>class_type</strong> (<em>str</em><em>, </em><em>default "binary"</em>) – “binary”: f1 for binary classification. |
| “multiclass”: f1 for multiclassification problem. |
| “multilabel”: f1 for multilabel classification.</p></li> |
| <li><p><strong>beta</strong> (<em>float</em><em>, </em><em>default 1</em>) – weight of precision in harmonic mean.</p></li> |
| <li><p><strong>threshold</strong> (<em>float</em><em>, </em><em>default 0.5</em>) – threshold for postive confidence value.</p></li> |
| <li><p><strong>average</strong> (<em>str</em><em>, </em><em>default 'micro'</em>) – <dl class="simple"> |
| <dt>Strategy to be used for aggregating across mini-batches.</dt><dd><p>”macro”: Calculate metrics for each label and return unweighted mean of f1. |
| “micro”: Calculate metrics globally by counting the total TP, FN and FP. |
| None: Return f1 scores for each class.</p> |
| </dd> |
| </dl> |
| </p></li> |
| </ul> |
| </dd> |
| </dl> |
| <p class="rubric">Examples</p> |
| <div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">predicts</span> <span class="o">=</span> <span class="p">[</span><span class="n">mx</span><span class="o">.</span><span class="n">np</span><span class="o">.</span><span class="n">array</span><span class="p">([[</span><span class="mf">0.3</span><span class="p">,</span> <span class="mf">0.7</span><span class="p">],</span> <span class="p">[</span><span class="mf">0.</span><span class="p">,</span> <span class="mf">1.</span><span class="p">],</span> <span class="p">[</span><span class="mf">0.4</span><span class="p">,</span> <span class="mf">0.6</span><span class="p">]])]</span> |
| <span class="gp">>>> </span><span class="n">labels</span> <span class="o">=</span> <span class="p">[</span><span class="n">mx</span><span class="o">.</span><span class="n">np</span><span class="o">.</span><span class="n">array</span><span class="p">([</span><span class="mf">0.</span><span class="p">,</span> <span class="mf">1.</span><span class="p">,</span> <span class="mf">1.</span><span class="p">])]</span> |
| <span class="gp">>>> </span><span class="n">fbeta</span> <span class="o">=</span> <span class="n">mx</span><span class="o">.</span><span class="n">gluon</span><span class="o">.</span><span class="n">metric</span><span class="o">.</span><span class="n">Fbeta</span><span class="p">(</span><span class="n">beta</span><span class="o">=</span><span class="mi">2</span><span class="p">)</span> |
| <span class="gp">>>> </span><span class="n">fbeta</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="n">preds</span> <span class="o">=</span> <span class="n">predicts</span><span class="p">,</span> <span class="n">labels</span> <span class="o">=</span> <span class="n">labels</span><span class="p">)</span> |
| <span class="gp">>>> </span><span class="n">fbeta</span><span class="o">.</span><span class="n">get</span><span class="p">()</span> |
| <span class="go">('fbeta', 0.9090909090909091)</span> |
| </pre></div> |
| </div> |
| <dl class="method"> |
| <dt id="mxnet.gluon.metric.Fbeta.get"> |
| <code class="sig-name descname">get</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#mxnet.gluon.metric.Fbeta.get" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Gets the current evaluation result.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Returns</dt> |
| <dd class="field-odd"><p><ul class="simple"> |
| <li><p><strong>names</strong> (<em>list of str</em>) – Name of the metrics.</p></li> |
| <li><p><strong>values</strong> (<em>list of float</em>) – Value of the evaluations.</p></li> |
| </ul> |
| </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="mxnet.gluon.metric.Fbeta.get_config"> |
| <code class="sig-name descname">get_config</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#mxnet.gluon.metric.Fbeta.get_config" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Save configurations of metric. Can be recreated |
| from configs with metric.create(<code class="docutils literal notranslate"><span class="pre">**config</span></code>)</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="mxnet.gluon.metric.Fbeta.get_name_value"> |
| <code class="sig-name descname">get_name_value</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#mxnet.gluon.metric.Fbeta.get_name_value" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Returns zipped name and value pairs.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Returns</dt> |
| <dd class="field-odd"><p>A (name, value) tuple list.</p> |
| </dd> |
| <dt class="field-even">Return type</dt> |
| <dd class="field-even"><p>list of tuples</p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="mxnet.gluon.metric.Fbeta.reset"> |
| <code class="sig-name descname">reset</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#mxnet.gluon.metric.Fbeta.reset" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Resets the internal evaluation result to initial state.</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="mxnet.gluon.metric.Fbeta.update"> |
| <code class="sig-name descname">update</code><span class="sig-paren">(</span><em class="sig-param">labels</em>, <em class="sig-param">preds</em><span class="sig-paren">)</span><a class="headerlink" href="#mxnet.gluon.metric.Fbeta.update" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Updates the internal evaluation result.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters</dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>labels</strong> (list of <cite>NDArray</cite>) – The labels of the data.</p></li> |
| <li><p><strong>preds</strong> (list of <cite>NDArray</cite>) – Predicted values.</p></li> |
| </ul> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="mxnet.gluon.metric.Fbeta.update_dict"> |
| <code class="sig-name descname">update_dict</code><span class="sig-paren">(</span><em class="sig-param">label</em>, <em class="sig-param">pred</em><span class="sig-paren">)</span><a class="headerlink" href="#mxnet.gluon.metric.Fbeta.update_dict" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Update the internal evaluation with named label and pred</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters</dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>labels</strong> (<em>OrderedDict of str -> NDArray</em>) – name to array mapping for labels.</p></li> |
| <li><p><strong>preds</strong> (<em>OrderedDict of str -> NDArray</em>) – name to array mapping of predicted outputs.</p></li> |
| </ul> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="class"> |
| <dt id="mxnet.gluon.metric.Loss"> |
| <em class="property">class </em><code class="sig-name descname">Loss</code><span class="sig-paren">(</span><em class="sig-param">name='loss'</em>, <em class="sig-param">output_names=None</em>, <em class="sig-param">label_names=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/mxnet/gluon/metric.html#Loss"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#mxnet.gluon.metric.Loss" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Bases: <a class="reference internal" href="#mxnet.gluon.metric.EvalMetric" title="mxnet.gluon.metric.EvalMetric"><code class="xref py py-class docutils literal notranslate"><span class="pre">mxnet.gluon.metric.EvalMetric</span></code></a></p> |
| <p>Dummy metric for directly printing loss.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters</dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>name</strong> (<em>str</em>) – Name of this metric instance for display.</p></li> |
| <li><p><strong>output_names</strong> (<em>list of str</em><em>, or </em><em>None</em>) – Name of predictions that should be used when updating with update_dict. |
| By default include all predictions.</p></li> |
| <li><p><strong>label_names</strong> (<em>list of str</em><em>, or </em><em>None</em>) – Name of labels that should be used when updating with update_dict. |
| By default include all labels.</p></li> |
| </ul> |
| </dd> |
| </dl> |
| <p><strong>Methods</strong></p> |
| <table class="longtable docutils align-default"> |
| <colgroup> |
| <col style="width: 10%" /> |
| <col style="width: 90%" /> |
| </colgroup> |
| <tbody> |
| <tr class="row-odd"><td><p><a class="reference internal" href="#mxnet.gluon.metric.Loss.get" title="mxnet.gluon.metric.Loss.get"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get</span></code></a>()</p></td> |
| <td><p>Gets the current evaluation result.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="#mxnet.gluon.metric.Loss.get_config" title="mxnet.gluon.metric.Loss.get_config"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_config</span></code></a>()</p></td> |
| <td><p>Save configurations of metric.</p></td> |
| </tr> |
| <tr class="row-odd"><td><p><a class="reference internal" href="#mxnet.gluon.metric.Loss.get_name_value" title="mxnet.gluon.metric.Loss.get_name_value"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_name_value</span></code></a>()</p></td> |
| <td><p>Returns zipped name and value pairs.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="#mxnet.gluon.metric.Loss.reset" title="mxnet.gluon.metric.Loss.reset"><code class="xref py py-obj docutils literal notranslate"><span class="pre">reset</span></code></a>()</p></td> |
| <td><p>Resets the internal evaluation result to initial state.</p></td> |
| </tr> |
| <tr class="row-odd"><td><p><a class="reference internal" href="#mxnet.gluon.metric.Loss.update" title="mxnet.gluon.metric.Loss.update"><code class="xref py py-obj docutils literal notranslate"><span class="pre">update</span></code></a>(_, preds)</p></td> |
| <td><p>Updates the internal evaluation result.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="#mxnet.gluon.metric.Loss.update_dict" title="mxnet.gluon.metric.Loss.update_dict"><code class="xref py py-obj docutils literal notranslate"><span class="pre">update_dict</span></code></a>(label, pred)</p></td> |
| <td><p>Update the internal evaluation with named label and pred</p></td> |
| </tr> |
| </tbody> |
| </table> |
| <dl class="method"> |
| <dt id="mxnet.gluon.metric.Loss.get"> |
| <code class="sig-name descname">get</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#mxnet.gluon.metric.Loss.get" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Gets the current evaluation result.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Returns</dt> |
| <dd class="field-odd"><p><ul class="simple"> |
| <li><p><strong>names</strong> (<em>list of str</em>) – Name of the metrics.</p></li> |
| <li><p><strong>values</strong> (<em>list of float</em>) – Value of the evaluations.</p></li> |
| </ul> |
| </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="mxnet.gluon.metric.Loss.get_config"> |
| <code class="sig-name descname">get_config</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#mxnet.gluon.metric.Loss.get_config" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Save configurations of metric. Can be recreated |
| from configs with metric.create(<code class="docutils literal notranslate"><span class="pre">**config</span></code>)</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="mxnet.gluon.metric.Loss.get_name_value"> |
| <code class="sig-name descname">get_name_value</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#mxnet.gluon.metric.Loss.get_name_value" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Returns zipped name and value pairs.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Returns</dt> |
| <dd class="field-odd"><p>A (name, value) tuple list.</p> |
| </dd> |
| <dt class="field-even">Return type</dt> |
| <dd class="field-even"><p>list of tuples</p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="mxnet.gluon.metric.Loss.reset"> |
| <code class="sig-name descname">reset</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#mxnet.gluon.metric.Loss.reset" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Resets the internal evaluation result to initial state.</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="mxnet.gluon.metric.Loss.update"> |
| <code class="sig-name descname">update</code><span class="sig-paren">(</span><em class="sig-param">_</em>, <em class="sig-param">preds</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/mxnet/gluon/metric.html#Loss.update"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#mxnet.gluon.metric.Loss.update" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Updates the internal evaluation result.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters</dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>labels</strong> (list of <cite>NDArray</cite>) – The labels of the data.</p></li> |
| <li><p><strong>preds</strong> (list of <cite>NDArray</cite>) – Predicted values.</p></li> |
| </ul> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="mxnet.gluon.metric.Loss.update_dict"> |
| <code class="sig-name descname">update_dict</code><span class="sig-paren">(</span><em class="sig-param">label</em>, <em class="sig-param">pred</em><span class="sig-paren">)</span><a class="headerlink" href="#mxnet.gluon.metric.Loss.update_dict" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Update the internal evaluation with named label and pred</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters</dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>labels</strong> (<em>OrderedDict of str -> NDArray</em>) – name to array mapping for labels.</p></li> |
| <li><p><strong>preds</strong> (<em>OrderedDict of str -> NDArray</em>) – name to array mapping of predicted outputs.</p></li> |
| </ul> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="class"> |
| <dt id="mxnet.gluon.metric.MAE"> |
| <em class="property">class </em><code class="sig-name descname">MAE</code><span class="sig-paren">(</span><em class="sig-param">name='mae'</em>, <em class="sig-param">output_names=None</em>, <em class="sig-param">label_names=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/mxnet/gluon/metric.html#MAE"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#mxnet.gluon.metric.MAE" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Bases: <a class="reference internal" href="#mxnet.gluon.metric.EvalMetric" title="mxnet.gluon.metric.EvalMetric"><code class="xref py py-class docutils literal notranslate"><span class="pre">mxnet.gluon.metric.EvalMetric</span></code></a></p> |
| <p>Computes Mean Absolute Error (MAE) loss.</p> |
| <p>The mean absolute error is given by</p> |
| <div class="math notranslate nohighlight"> |
| \[\frac{\sum_i^n |y_i - \hat{y}_i|}{n}\]</div> |
| <p><strong>Methods</strong></p> |
| <table class="longtable docutils align-default"> |
| <colgroup> |
| <col style="width: 10%" /> |
| <col style="width: 90%" /> |
| </colgroup> |
| <tbody> |
| <tr class="row-odd"><td><p><a class="reference internal" href="#mxnet.gluon.metric.MAE.get" title="mxnet.gluon.metric.MAE.get"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get</span></code></a>()</p></td> |
| <td><p>Gets the current evaluation result.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="#mxnet.gluon.metric.MAE.get_config" title="mxnet.gluon.metric.MAE.get_config"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_config</span></code></a>()</p></td> |
| <td><p>Save configurations of metric.</p></td> |
| </tr> |
| <tr class="row-odd"><td><p><a class="reference internal" href="#mxnet.gluon.metric.MAE.get_name_value" title="mxnet.gluon.metric.MAE.get_name_value"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_name_value</span></code></a>()</p></td> |
| <td><p>Returns zipped name and value pairs.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="#mxnet.gluon.metric.MAE.reset" title="mxnet.gluon.metric.MAE.reset"><code class="xref py py-obj docutils literal notranslate"><span class="pre">reset</span></code></a>()</p></td> |
| <td><p>Resets the internal evaluation result to initial state.</p></td> |
| </tr> |
| <tr class="row-odd"><td><p><a class="reference internal" href="#mxnet.gluon.metric.MAE.update" title="mxnet.gluon.metric.MAE.update"><code class="xref py py-obj docutils literal notranslate"><span class="pre">update</span></code></a>(labels, preds)</p></td> |
| <td><p>Updates the internal evaluation result.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="#mxnet.gluon.metric.MAE.update_dict" title="mxnet.gluon.metric.MAE.update_dict"><code class="xref py py-obj docutils literal notranslate"><span class="pre">update_dict</span></code></a>(label, pred)</p></td> |
| <td><p>Update the internal evaluation with named label and pred</p></td> |
| </tr> |
| </tbody> |
| </table> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters</dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>name</strong> (<em>str</em>) – Name of this metric instance for display.</p></li> |
| <li><p><strong>output_names</strong> (<em>list of str</em><em>, or </em><em>None</em>) – Name of predictions that should be used when updating with update_dict. |
| By default include all predictions.</p></li> |
| <li><p><strong>label_names</strong> (<em>list of str</em><em>, or </em><em>None</em>) – Name of labels that should be used when updating with update_dict. |
| By default include all labels.</p></li> |
| </ul> |
| </dd> |
| </dl> |
| <p class="rubric">Examples</p> |
| <div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">predicts</span> <span class="o">=</span> <span class="p">[</span><span class="n">mx</span><span class="o">.</span><span class="n">np</span><span class="o">.</span><span class="n">array</span><span class="p">([</span><span class="mi">3</span><span class="p">,</span> <span class="o">-</span><span class="mf">0.5</span><span class="p">,</span> <span class="mi">2</span><span class="p">,</span> <span class="mi">7</span><span class="p">])]</span> |
| <span class="gp">>>> </span><span class="n">labels</span> <span class="o">=</span> <span class="p">[</span><span class="n">mx</span><span class="o">.</span><span class="n">np</span><span class="o">.</span><span class="n">array</span><span class="p">([</span><span class="mf">2.5</span><span class="p">,</span> <span class="mf">0.0</span><span class="p">,</span> <span class="mi">2</span><span class="p">,</span> <span class="mi">8</span><span class="p">])]</span> |
| <span class="gp">>>> </span><span class="n">mean_absolute_error</span> <span class="o">=</span> <span class="n">mx</span><span class="o">.</span><span class="n">gluon</span><span class="o">.</span><span class="n">metric</span><span class="o">.</span><span class="n">MAE</span><span class="p">()</span> |
| <span class="gp">>>> </span><span class="n">mean_absolute_error</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="n">labels</span> <span class="o">=</span> <span class="n">labels</span><span class="p">,</span> <span class="n">preds</span> <span class="o">=</span> <span class="n">predicts</span><span class="p">)</span> |
| <span class="gp">>>> </span><span class="n">mean_absolute_error</span><span class="o">.</span><span class="n">get</span><span class="p">()</span> |
| <span class="go">('mae', 0.5)</span> |
| </pre></div> |
| </div> |
| <dl class="method"> |
| <dt id="mxnet.gluon.metric.MAE.get"> |
| <code class="sig-name descname">get</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#mxnet.gluon.metric.MAE.get" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Gets the current evaluation result.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Returns</dt> |
| <dd class="field-odd"><p><ul class="simple"> |
| <li><p><strong>names</strong> (<em>list of str</em>) – Name of the metrics.</p></li> |
| <li><p><strong>values</strong> (<em>list of float</em>) – Value of the evaluations.</p></li> |
| </ul> |
| </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="mxnet.gluon.metric.MAE.get_config"> |
| <code class="sig-name descname">get_config</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#mxnet.gluon.metric.MAE.get_config" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Save configurations of metric. Can be recreated |
| from configs with metric.create(<code class="docutils literal notranslate"><span class="pre">**config</span></code>)</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="mxnet.gluon.metric.MAE.get_name_value"> |
| <code class="sig-name descname">get_name_value</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#mxnet.gluon.metric.MAE.get_name_value" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Returns zipped name and value pairs.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Returns</dt> |
| <dd class="field-odd"><p>A (name, value) tuple list.</p> |
| </dd> |
| <dt class="field-even">Return type</dt> |
| <dd class="field-even"><p>list of tuples</p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="mxnet.gluon.metric.MAE.reset"> |
| <code class="sig-name descname">reset</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#mxnet.gluon.metric.MAE.reset" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Resets the internal evaluation result to initial state.</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="mxnet.gluon.metric.MAE.update"> |
| <code class="sig-name descname">update</code><span class="sig-paren">(</span><em class="sig-param">labels</em>, <em class="sig-param">preds</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/mxnet/gluon/metric.html#MAE.update"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#mxnet.gluon.metric.MAE.update" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Updates the internal evaluation result.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters</dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>labels</strong> (list of <cite>NDArray</cite>) – The labels of the data.</p></li> |
| <li><p><strong>preds</strong> (list of <cite>NDArray</cite>) – Predicted values.</p></li> |
| </ul> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="mxnet.gluon.metric.MAE.update_dict"> |
| <code class="sig-name descname">update_dict</code><span class="sig-paren">(</span><em class="sig-param">label</em>, <em class="sig-param">pred</em><span class="sig-paren">)</span><a class="headerlink" href="#mxnet.gluon.metric.MAE.update_dict" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Update the internal evaluation with named label and pred</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters</dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>labels</strong> (<em>OrderedDict of str -> NDArray</em>) – name to array mapping for labels.</p></li> |
| <li><p><strong>preds</strong> (<em>OrderedDict of str -> NDArray</em>) – name to array mapping of predicted outputs.</p></li> |
| </ul> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="class"> |
| <dt id="mxnet.gluon.metric.MCC"> |
| <em class="property">class </em><code class="sig-name descname">MCC</code><span class="sig-paren">(</span><em class="sig-param">name='mcc'</em>, <em class="sig-param">output_names=None</em>, <em class="sig-param">label_names=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/mxnet/gluon/metric.html#MCC"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#mxnet.gluon.metric.MCC" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Bases: <a class="reference internal" href="#mxnet.gluon.metric.EvalMetric" title="mxnet.gluon.metric.EvalMetric"><code class="xref py py-class docutils literal notranslate"><span class="pre">mxnet.gluon.metric.EvalMetric</span></code></a></p> |
| <p>Computes the Matthews Correlation Coefficient of a binary classification problem.</p> |
| <p>While slower to compute than F1 the MCC can give insight that F1 or Accuracy cannot. |
| For instance, if the network always predicts the same result |
| then the MCC will immeadiately show this. The MCC is also symetric with respect |
| to positive and negative categorization, however, there needs to be both |
| positive and negative examples in the labels or it will always return 0. |
| MCC of 0 is uncorrelated, 1 is completely correlated, and -1 is negatively correlated.</p> |
| <div class="math notranslate nohighlight"> |
| \[\text{MCC} = \frac{ TP \times TN - FP \times FN } |
| {\sqrt{ (TP + FP) ( TP + FN ) ( TN + FP ) ( TN + FN ) } }\]</div> |
| <p><strong>Methods</strong></p> |
| <table class="longtable docutils align-default"> |
| <colgroup> |
| <col style="width: 10%" /> |
| <col style="width: 90%" /> |
| </colgroup> |
| <tbody> |
| <tr class="row-odd"><td><p><a class="reference internal" href="#mxnet.gluon.metric.MCC.get" title="mxnet.gluon.metric.MCC.get"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get</span></code></a>()</p></td> |
| <td><p>Gets the current evaluation result.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="#mxnet.gluon.metric.MCC.get_config" title="mxnet.gluon.metric.MCC.get_config"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_config</span></code></a>()</p></td> |
| <td><p>Save configurations of metric.</p></td> |
| </tr> |
| <tr class="row-odd"><td><p><a class="reference internal" href="#mxnet.gluon.metric.MCC.get_name_value" title="mxnet.gluon.metric.MCC.get_name_value"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_name_value</span></code></a>()</p></td> |
| <td><p>Returns zipped name and value pairs.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="#mxnet.gluon.metric.MCC.reset" title="mxnet.gluon.metric.MCC.reset"><code class="xref py py-obj docutils literal notranslate"><span class="pre">reset</span></code></a>()</p></td> |
| <td><p>Resets the internal evaluation result to initial state.</p></td> |
| </tr> |
| <tr class="row-odd"><td><p><a class="reference internal" href="#mxnet.gluon.metric.MCC.update" title="mxnet.gluon.metric.MCC.update"><code class="xref py py-obj docutils literal notranslate"><span class="pre">update</span></code></a>(labels, preds)</p></td> |
| <td><p>Updates the internal evaluation result.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="#mxnet.gluon.metric.MCC.update_dict" title="mxnet.gluon.metric.MCC.update_dict"><code class="xref py py-obj docutils literal notranslate"><span class="pre">update_dict</span></code></a>(label, pred)</p></td> |
| <td><p>Update the internal evaluation with named label and pred</p></td> |
| </tr> |
| </tbody> |
| </table> |
| <p>where 0 terms in the denominator are replaced by 1.</p> |
| <div class="admonition note"> |
| <p class="admonition-title">Note</p> |
| <p>This version of MCC only supports binary classification. See PCC.</p> |
| </div> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters</dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>name</strong> (<em>str</em>) – Name of this metric instance for display.</p></li> |
| <li><p><strong>output_names</strong> (<em>list of str</em><em>, or </em><em>None</em>) – Name of predictions that should be used when updating with update_dict. |
| By default include all predictions.</p></li> |
| <li><p><strong>label_names</strong> (<em>list of str</em><em>, or </em><em>None</em>) – Name of labels that should be used when updating with update_dict. |
| By default include all labels.</p></li> |
| </ul> |
| </dd> |
| </dl> |
| <p class="rubric">Examples</p> |
| <div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="c1"># In this example the network almost always predicts positive</span> |
| <span class="gp">>>> </span><span class="n">false_positives</span> <span class="o">=</span> <span class="mi">1000</span> |
| <span class="gp">>>> </span><span class="n">false_negatives</span> <span class="o">=</span> <span class="mi">1</span> |
| <span class="gp">>>> </span><span class="n">true_positives</span> <span class="o">=</span> <span class="mi">10000</span> |
| <span class="gp">>>> </span><span class="n">true_negatives</span> <span class="o">=</span> <span class="mi">1</span> |
| <span class="gp">>>> </span><span class="n">predicts</span> <span class="o">=</span> <span class="p">[</span><span class="n">mx</span><span class="o">.</span><span class="n">np</span><span class="o">.</span><span class="n">array</span><span class="p">(</span> |
| <span class="go"> [[.3, .7]]*false_positives +</span> |
| <span class="go"> [[.7, .3]]*true_negatives +</span> |
| <span class="go"> [[.7, .3]]*false_negatives +</span> |
| <span class="go"> [[.3, .7]]*true_positives</span> |
| <span class="go">)]</span> |
| <span class="gp">>>> </span><span class="n">labels</span> <span class="o">=</span> <span class="p">[</span><span class="n">mx</span><span class="o">.</span><span class="n">np</span><span class="o">.</span><span class="n">array</span><span class="p">(</span> |
| <span class="go"> [0.]*(false_positives + true_negatives) +</span> |
| <span class="go"> [1.]*(false_negatives + true_positives)</span> |
| <span class="go">)]</span> |
| <span class="gp">>>> </span><span class="n">f1</span> <span class="o">=</span> <span class="n">mx</span><span class="o">.</span><span class="n">gluon</span><span class="o">.</span><span class="n">metric</span><span class="o">.</span><span class="n">F1</span><span class="p">()</span> |
| <span class="gp">>>> </span><span class="n">f1</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="n">preds</span> <span class="o">=</span> <span class="n">predicts</span><span class="p">,</span> <span class="n">labels</span> <span class="o">=</span> <span class="n">labels</span><span class="p">)</span> |
| <span class="gp">>>> </span><span class="n">mcc</span> <span class="o">=</span> <span class="n">mx</span><span class="o">.</span><span class="n">gluon</span><span class="o">.</span><span class="n">metric</span><span class="o">.</span><span class="n">MCC</span><span class="p">()</span> |
| <span class="gp">>>> </span><span class="n">mcc</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="n">preds</span> <span class="o">=</span> <span class="n">predicts</span><span class="p">,</span> <span class="n">labels</span> <span class="o">=</span> <span class="n">labels</span><span class="p">)</span> |
| <span class="gp">>>> </span><span class="n">f1</span><span class="o">.</span><span class="n">get</span><span class="p">()</span> |
| <span class="go">('f1', 0.95233560306652054)</span> |
| <span class="gp">>>> </span><span class="n">mcc</span><span class="o">.</span><span class="n">get</span><span class="p">()</span> |
| <span class="go">('mcc', 0.01917751877733392)</span> |
| </pre></div> |
| </div> |
| <dl class="method"> |
| <dt id="mxnet.gluon.metric.MCC.get"> |
| <code class="sig-name descname">get</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#mxnet.gluon.metric.MCC.get" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Gets the current evaluation result.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Returns</dt> |
| <dd class="field-odd"><p><ul class="simple"> |
| <li><p><strong>names</strong> (<em>list of str</em>) – Name of the metrics.</p></li> |
| <li><p><strong>values</strong> (<em>list of float</em>) – Value of the evaluations.</p></li> |
| </ul> |
| </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="mxnet.gluon.metric.MCC.get_config"> |
| <code class="sig-name descname">get_config</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#mxnet.gluon.metric.MCC.get_config" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Save configurations of metric. Can be recreated |
| from configs with metric.create(<code class="docutils literal notranslate"><span class="pre">**config</span></code>)</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="mxnet.gluon.metric.MCC.get_name_value"> |
| <code class="sig-name descname">get_name_value</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#mxnet.gluon.metric.MCC.get_name_value" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Returns zipped name and value pairs.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Returns</dt> |
| <dd class="field-odd"><p>A (name, value) tuple list.</p> |
| </dd> |
| <dt class="field-even">Return type</dt> |
| <dd class="field-even"><p>list of tuples</p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="mxnet.gluon.metric.MCC.reset"> |
| <code class="sig-name descname">reset</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/mxnet/gluon/metric.html#MCC.reset"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#mxnet.gluon.metric.MCC.reset" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Resets the internal evaluation result to initial state.</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="mxnet.gluon.metric.MCC.update"> |
| <code class="sig-name descname">update</code><span class="sig-paren">(</span><em class="sig-param">labels</em>, <em class="sig-param">preds</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/mxnet/gluon/metric.html#MCC.update"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#mxnet.gluon.metric.MCC.update" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Updates the internal evaluation result.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters</dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>labels</strong> (list of <cite>NDArray</cite>) – The labels of the data.</p></li> |
| <li><p><strong>preds</strong> (list of <cite>NDArray</cite>) – Predicted values.</p></li> |
| </ul> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="mxnet.gluon.metric.MCC.update_dict"> |
| <code class="sig-name descname">update_dict</code><span class="sig-paren">(</span><em class="sig-param">label</em>, <em class="sig-param">pred</em><span class="sig-paren">)</span><a class="headerlink" href="#mxnet.gluon.metric.MCC.update_dict" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Update the internal evaluation with named label and pred</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters</dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>labels</strong> (<em>OrderedDict of str -> NDArray</em>) – name to array mapping for labels.</p></li> |
| <li><p><strong>preds</strong> (<em>OrderedDict of str -> NDArray</em>) – name to array mapping of predicted outputs.</p></li> |
| </ul> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="class"> |
| <dt id="mxnet.gluon.metric.MSE"> |
| <em class="property">class </em><code class="sig-name descname">MSE</code><span class="sig-paren">(</span><em class="sig-param">name='mse'</em>, <em class="sig-param">output_names=None</em>, <em class="sig-param">label_names=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/mxnet/gluon/metric.html#MSE"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#mxnet.gluon.metric.MSE" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Bases: <a class="reference internal" href="#mxnet.gluon.metric.EvalMetric" title="mxnet.gluon.metric.EvalMetric"><code class="xref py py-class docutils literal notranslate"><span class="pre">mxnet.gluon.metric.EvalMetric</span></code></a></p> |
| <p>Computes Mean Squared Error (MSE) loss.</p> |
| <p>The mean squared error is given by</p> |
| <div class="math notranslate nohighlight"> |
| \[\frac{\sum_i^n (y_i - \hat{y}_i)^2}{n}\]</div> |
| <p><strong>Methods</strong></p> |
| <table class="longtable docutils align-default"> |
| <colgroup> |
| <col style="width: 10%" /> |
| <col style="width: 90%" /> |
| </colgroup> |
| <tbody> |
| <tr class="row-odd"><td><p><a class="reference internal" href="#mxnet.gluon.metric.MSE.get" title="mxnet.gluon.metric.MSE.get"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get</span></code></a>()</p></td> |
| <td><p>Gets the current evaluation result.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="#mxnet.gluon.metric.MSE.get_config" title="mxnet.gluon.metric.MSE.get_config"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_config</span></code></a>()</p></td> |
| <td><p>Save configurations of metric.</p></td> |
| </tr> |
| <tr class="row-odd"><td><p><a class="reference internal" href="#mxnet.gluon.metric.MSE.get_name_value" title="mxnet.gluon.metric.MSE.get_name_value"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_name_value</span></code></a>()</p></td> |
| <td><p>Returns zipped name and value pairs.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="#mxnet.gluon.metric.MSE.reset" title="mxnet.gluon.metric.MSE.reset"><code class="xref py py-obj docutils literal notranslate"><span class="pre">reset</span></code></a>()</p></td> |
| <td><p>Resets the internal evaluation result to initial state.</p></td> |
| </tr> |
| <tr class="row-odd"><td><p><a class="reference internal" href="#mxnet.gluon.metric.MSE.update" title="mxnet.gluon.metric.MSE.update"><code class="xref py py-obj docutils literal notranslate"><span class="pre">update</span></code></a>(labels, preds)</p></td> |
| <td><p>Updates the internal evaluation result.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="#mxnet.gluon.metric.MSE.update_dict" title="mxnet.gluon.metric.MSE.update_dict"><code class="xref py py-obj docutils literal notranslate"><span class="pre">update_dict</span></code></a>(label, pred)</p></td> |
| <td><p>Update the internal evaluation with named label and pred</p></td> |
| </tr> |
| </tbody> |
| </table> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters</dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>name</strong> (<em>str</em>) – Name of this metric instance for display.</p></li> |
| <li><p><strong>output_names</strong> (<em>list of str</em><em>, or </em><em>None</em>) – Name of predictions that should be used when updating with update_dict. |
| By default include all predictions.</p></li> |
| <li><p><strong>label_names</strong> (<em>list of str</em><em>, or </em><em>None</em>) – Name of labels that should be used when updating with update_dict. |
| By default include all labels.</p></li> |
| </ul> |
| </dd> |
| </dl> |
| <p class="rubric">Examples</p> |
| <div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">predicts</span> <span class="o">=</span> <span class="p">[</span><span class="n">mx</span><span class="o">.</span><span class="n">np</span><span class="o">.</span><span class="n">array</span><span class="p">([</span><span class="mi">3</span><span class="p">,</span> <span class="o">-</span><span class="mf">0.5</span><span class="p">,</span> <span class="mi">2</span><span class="p">,</span> <span class="mi">7</span><span class="p">])]</span> |
| <span class="gp">>>> </span><span class="n">labels</span> <span class="o">=</span> <span class="p">[</span><span class="n">mx</span><span class="o">.</span><span class="n">np</span><span class="o">.</span><span class="n">array</span><span class="p">([</span><span class="mf">2.5</span><span class="p">,</span> <span class="mf">0.0</span><span class="p">,</span> <span class="mi">2</span><span class="p">,</span> <span class="mi">8</span><span class="p">])]</span> |
| <span class="gp">>>> </span><span class="n">mean_squared_error</span> <span class="o">=</span> <span class="n">mx</span><span class="o">.</span><span class="n">gluon</span><span class="o">.</span><span class="n">metric</span><span class="o">.</span><span class="n">MSE</span><span class="p">()</span> |
| <span class="gp">>>> </span><span class="n">mean_squared_error</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="n">labels</span> <span class="o">=</span> <span class="n">labels</span><span class="p">,</span> <span class="n">preds</span> <span class="o">=</span> <span class="n">predicts</span><span class="p">)</span> |
| <span class="gp">>>> </span><span class="n">mean_squared_error</span><span class="o">.</span><span class="n">get</span><span class="p">()</span> |
| <span class="go">('mse', 0.375)</span> |
| </pre></div> |
| </div> |
| <dl class="method"> |
| <dt id="mxnet.gluon.metric.MSE.get"> |
| <code class="sig-name descname">get</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#mxnet.gluon.metric.MSE.get" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Gets the current evaluation result.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Returns</dt> |
| <dd class="field-odd"><p><ul class="simple"> |
| <li><p><strong>names</strong> (<em>list of str</em>) – Name of the metrics.</p></li> |
| <li><p><strong>values</strong> (<em>list of float</em>) – Value of the evaluations.</p></li> |
| </ul> |
| </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="mxnet.gluon.metric.MSE.get_config"> |
| <code class="sig-name descname">get_config</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#mxnet.gluon.metric.MSE.get_config" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Save configurations of metric. Can be recreated |
| from configs with metric.create(<code class="docutils literal notranslate"><span class="pre">**config</span></code>)</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="mxnet.gluon.metric.MSE.get_name_value"> |
| <code class="sig-name descname">get_name_value</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#mxnet.gluon.metric.MSE.get_name_value" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Returns zipped name and value pairs.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Returns</dt> |
| <dd class="field-odd"><p>A (name, value) tuple list.</p> |
| </dd> |
| <dt class="field-even">Return type</dt> |
| <dd class="field-even"><p>list of tuples</p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="mxnet.gluon.metric.MSE.reset"> |
| <code class="sig-name descname">reset</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#mxnet.gluon.metric.MSE.reset" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Resets the internal evaluation result to initial state.</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="mxnet.gluon.metric.MSE.update"> |
| <code class="sig-name descname">update</code><span class="sig-paren">(</span><em class="sig-param">labels</em>, <em class="sig-param">preds</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/mxnet/gluon/metric.html#MSE.update"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#mxnet.gluon.metric.MSE.update" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Updates the internal evaluation result.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters</dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>labels</strong> (list of <cite>NDArray</cite>) – The labels of the data.</p></li> |
| <li><p><strong>preds</strong> (list of <cite>NDArray</cite>) – Predicted values.</p></li> |
| </ul> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="mxnet.gluon.metric.MSE.update_dict"> |
| <code class="sig-name descname">update_dict</code><span class="sig-paren">(</span><em class="sig-param">label</em>, <em class="sig-param">pred</em><span class="sig-paren">)</span><a class="headerlink" href="#mxnet.gluon.metric.MSE.update_dict" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Update the internal evaluation with named label and pred</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters</dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>labels</strong> (<em>OrderedDict of str -> NDArray</em>) – name to array mapping for labels.</p></li> |
| <li><p><strong>preds</strong> (<em>OrderedDict of str -> NDArray</em>) – name to array mapping of predicted outputs.</p></li> |
| </ul> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="class"> |
| <dt id="mxnet.gluon.metric.MeanCosineSimilarity"> |
| <em class="property">class </em><code class="sig-name descname">MeanCosineSimilarity</code><span class="sig-paren">(</span><em class="sig-param">name='cos_sim'</em>, <em class="sig-param">output_names=None</em>, <em class="sig-param">label_names=None</em>, <em class="sig-param">eps=1e-08</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/mxnet/gluon/metric.html#MeanCosineSimilarity"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#mxnet.gluon.metric.MeanCosineSimilarity" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Bases: <a class="reference internal" href="#mxnet.gluon.metric.EvalMetric" title="mxnet.gluon.metric.EvalMetric"><code class="xref py py-class docutils literal notranslate"><span class="pre">mxnet.gluon.metric.EvalMetric</span></code></a></p> |
| <p>Computes Mean Cosine Similarity.</p> |
| <p>The mean cosine similarity is given by</p> |
| <div class="math notranslate nohighlight"> |
| \[cos_sim(label, pred) = \frac{{label}.{pred}}{max(||label||.||pred||, eps)}\]</div> |
| <p><strong>Methods</strong></p> |
| <table class="longtable docutils align-default"> |
| <colgroup> |
| <col style="width: 10%" /> |
| <col style="width: 90%" /> |
| </colgroup> |
| <tbody> |
| <tr class="row-odd"><td><p><a class="reference internal" href="#mxnet.gluon.metric.MeanCosineSimilarity.get" title="mxnet.gluon.metric.MeanCosineSimilarity.get"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get</span></code></a>()</p></td> |
| <td><p>Gets the current evaluation result.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="#mxnet.gluon.metric.MeanCosineSimilarity.get_config" title="mxnet.gluon.metric.MeanCosineSimilarity.get_config"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_config</span></code></a>()</p></td> |
| <td><p>Save configurations of metric.</p></td> |
| </tr> |
| <tr class="row-odd"><td><p><a class="reference internal" href="#mxnet.gluon.metric.MeanCosineSimilarity.get_name_value" title="mxnet.gluon.metric.MeanCosineSimilarity.get_name_value"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_name_value</span></code></a>()</p></td> |
| <td><p>Returns zipped name and value pairs.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="#mxnet.gluon.metric.MeanCosineSimilarity.reset" title="mxnet.gluon.metric.MeanCosineSimilarity.reset"><code class="xref py py-obj docutils literal notranslate"><span class="pre">reset</span></code></a>()</p></td> |
| <td><p>Resets the internal evaluation result to initial state.</p></td> |
| </tr> |
| <tr class="row-odd"><td><p><a class="reference internal" href="#mxnet.gluon.metric.MeanCosineSimilarity.update" title="mxnet.gluon.metric.MeanCosineSimilarity.update"><code class="xref py py-obj docutils literal notranslate"><span class="pre">update</span></code></a>(labels, preds)</p></td> |
| <td><p>Updates the internal evaluation result.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="#mxnet.gluon.metric.MeanCosineSimilarity.update_dict" title="mxnet.gluon.metric.MeanCosineSimilarity.update_dict"><code class="xref py py-obj docutils literal notranslate"><span class="pre">update_dict</span></code></a>(label, pred)</p></td> |
| <td><p>Update the internal evaluation with named label and pred</p></td> |
| </tr> |
| </tbody> |
| </table> |
| <p>Calculation happens on the last dimension of label and pred.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters</dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>name</strong> (<em>str</em>) – Name of this metric instance for display.</p></li> |
| <li><p><strong>output_names</strong> (<em>list of str</em><em>, or </em><em>None</em>) – Name of predictions that should be used when updating with update_dict. |
| By default include all predictions.</p></li> |
| <li><p><strong>label_names</strong> (<em>list of str</em><em>, or </em><em>None</em>) – Name of labels that should be used when updating with update_dict. |
| By default include all labels.</p></li> |
| <li><p><strong>eps</strong> (<em>float</em><em>, </em><em>default 1e-8</em>) – small vale to avoid division by zero.</p></li> |
| </ul> |
| </dd> |
| </dl> |
| <p class="rubric">Examples</p> |
| <div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">predicts</span> <span class="o">=</span> <span class="p">[</span><span class="n">mx</span><span class="o">.</span><span class="n">np</span><span class="o">.</span><span class="n">array</span><span class="p">([[</span><span class="mf">1.</span><span class="p">,</span> <span class="mf">0.</span><span class="p">],</span> <span class="p">[</span><span class="mf">1.</span><span class="p">,</span> <span class="mf">1.</span><span class="p">]])]</span> |
| <span class="gp">>>> </span><span class="n">labels</span> <span class="o">=</span> <span class="p">[</span><span class="n">mx</span><span class="o">.</span><span class="n">np</span><span class="o">.</span><span class="n">array</span><span class="p">([[</span><span class="mf">3.</span><span class="p">,</span> <span class="mf">4.</span><span class="p">],</span> <span class="p">[</span><span class="mf">2.</span><span class="p">,</span> <span class="mf">2.</span><span class="p">]])]</span> |
| <span class="gp">>>> </span><span class="n">mcs</span> <span class="o">=</span> <span class="n">mx</span><span class="o">.</span><span class="n">gluon</span><span class="o">.</span><span class="n">metric</span><span class="o">.</span><span class="n">MeanCosineSimilarity</span><span class="p">()</span> |
| <span class="gp">>>> </span><span class="n">mcs</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="n">labels</span> <span class="o">=</span> <span class="n">labels</span><span class="p">,</span> <span class="n">preds</span> <span class="o">=</span> <span class="n">predicts</span><span class="p">)</span> |
| <span class="gp">>>> </span><span class="n">mcs</span><span class="o">.</span><span class="n">get</span><span class="p">()</span> |
| <span class="go">('cos_sim', 0.8)</span> |
| </pre></div> |
| </div> |
| <dl class="method"> |
| <dt id="mxnet.gluon.metric.MeanCosineSimilarity.get"> |
| <code class="sig-name descname">get</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#mxnet.gluon.metric.MeanCosineSimilarity.get" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Gets the current evaluation result.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Returns</dt> |
| <dd class="field-odd"><p><ul class="simple"> |
| <li><p><strong>names</strong> (<em>list of str</em>) – Name of the metrics.</p></li> |
| <li><p><strong>values</strong> (<em>list of float</em>) – Value of the evaluations.</p></li> |
| </ul> |
| </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="mxnet.gluon.metric.MeanCosineSimilarity.get_config"> |
| <code class="sig-name descname">get_config</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#mxnet.gluon.metric.MeanCosineSimilarity.get_config" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Save configurations of metric. Can be recreated |
| from configs with metric.create(<code class="docutils literal notranslate"><span class="pre">**config</span></code>)</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="mxnet.gluon.metric.MeanCosineSimilarity.get_name_value"> |
| <code class="sig-name descname">get_name_value</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#mxnet.gluon.metric.MeanCosineSimilarity.get_name_value" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Returns zipped name and value pairs.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Returns</dt> |
| <dd class="field-odd"><p>A (name, value) tuple list.</p> |
| </dd> |
| <dt class="field-even">Return type</dt> |
| <dd class="field-even"><p>list of tuples</p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="mxnet.gluon.metric.MeanCosineSimilarity.reset"> |
| <code class="sig-name descname">reset</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#mxnet.gluon.metric.MeanCosineSimilarity.reset" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Resets the internal evaluation result to initial state.</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="mxnet.gluon.metric.MeanCosineSimilarity.update"> |
| <code class="sig-name descname">update</code><span class="sig-paren">(</span><em class="sig-param">labels</em>, <em class="sig-param">preds</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/mxnet/gluon/metric.html#MeanCosineSimilarity.update"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#mxnet.gluon.metric.MeanCosineSimilarity.update" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Updates the internal evaluation result.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters</dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>labels</strong> (list of <cite>NDArray</cite>) – The labels of the data.</p></li> |
| <li><p><strong>preds</strong> (list of <cite>NDArray</cite>) – Predicted values.</p></li> |
| </ul> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="mxnet.gluon.metric.MeanCosineSimilarity.update_dict"> |
| <code class="sig-name descname">update_dict</code><span class="sig-paren">(</span><em class="sig-param">label</em>, <em class="sig-param">pred</em><span class="sig-paren">)</span><a class="headerlink" href="#mxnet.gluon.metric.MeanCosineSimilarity.update_dict" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Update the internal evaluation with named label and pred</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters</dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>labels</strong> (<em>OrderedDict of str -> NDArray</em>) – name to array mapping for labels.</p></li> |
| <li><p><strong>preds</strong> (<em>OrderedDict of str -> NDArray</em>) – name to array mapping of predicted outputs.</p></li> |
| </ul> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="class"> |
| <dt id="mxnet.gluon.metric.MeanPairwiseDistance"> |
| <em class="property">class </em><code class="sig-name descname">MeanPairwiseDistance</code><span class="sig-paren">(</span><em class="sig-param">name='mpd'</em>, <em class="sig-param">output_names=None</em>, <em class="sig-param">label_names=None</em>, <em class="sig-param">p=2</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/mxnet/gluon/metric.html#MeanPairwiseDistance"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#mxnet.gluon.metric.MeanPairwiseDistance" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Bases: <a class="reference internal" href="#mxnet.gluon.metric.EvalMetric" title="mxnet.gluon.metric.EvalMetric"><code class="xref py py-class docutils literal notranslate"><span class="pre">mxnet.gluon.metric.EvalMetric</span></code></a></p> |
| <p>Computes Mean Pairwise Distance.</p> |
| <p>The mean pairwise distance is given by</p> |
| <div class="math notranslate nohighlight"> |
| \[\sqrt{\frac{(\sum_i^n (y_i - \hat{y}_i)^p)^\frac{1}{p}}{n}}\]</div> |
| <p><strong>Methods</strong></p> |
| <table class="longtable docutils align-default"> |
| <colgroup> |
| <col style="width: 10%" /> |
| <col style="width: 90%" /> |
| </colgroup> |
| <tbody> |
| <tr class="row-odd"><td><p><a class="reference internal" href="#mxnet.gluon.metric.MeanPairwiseDistance.get" title="mxnet.gluon.metric.MeanPairwiseDistance.get"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get</span></code></a>()</p></td> |
| <td><p>Gets the current evaluation result.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="#mxnet.gluon.metric.MeanPairwiseDistance.get_config" title="mxnet.gluon.metric.MeanPairwiseDistance.get_config"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_config</span></code></a>()</p></td> |
| <td><p>Save configurations of metric.</p></td> |
| </tr> |
| <tr class="row-odd"><td><p><a class="reference internal" href="#mxnet.gluon.metric.MeanPairwiseDistance.get_name_value" title="mxnet.gluon.metric.MeanPairwiseDistance.get_name_value"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_name_value</span></code></a>()</p></td> |
| <td><p>Returns zipped name and value pairs.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="#mxnet.gluon.metric.MeanPairwiseDistance.reset" title="mxnet.gluon.metric.MeanPairwiseDistance.reset"><code class="xref py py-obj docutils literal notranslate"><span class="pre">reset</span></code></a>()</p></td> |
| <td><p>Resets the internal evaluation result to initial state.</p></td> |
| </tr> |
| <tr class="row-odd"><td><p><a class="reference internal" href="#mxnet.gluon.metric.MeanPairwiseDistance.update" title="mxnet.gluon.metric.MeanPairwiseDistance.update"><code class="xref py py-obj docutils literal notranslate"><span class="pre">update</span></code></a>(labels, preds)</p></td> |
| <td><p>Updates the internal evaluation result.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="#mxnet.gluon.metric.MeanPairwiseDistance.update_dict" title="mxnet.gluon.metric.MeanPairwiseDistance.update_dict"><code class="xref py py-obj docutils literal notranslate"><span class="pre">update_dict</span></code></a>(label, pred)</p></td> |
| <td><p>Update the internal evaluation with named label and pred</p></td> |
| </tr> |
| </tbody> |
| </table> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters</dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>name</strong> (<em>str</em>) – Name of this metric instance for display.</p></li> |
| <li><p><strong>output_names</strong> (<em>list of str</em><em>, or </em><em>None</em>) – Name of predictions that should be used when updating with update_dict. |
| By default include all predictions.</p></li> |
| <li><p><strong>label_names</strong> (<em>list of str</em><em>, or </em><em>None</em>) – Name of labels that should be used when updating with update_dict. |
| By default include all labels.</p></li> |
| <li><p><strong>p</strong> (<em>float</em><em>, </em><em>default 2</em>) – calculating distance using the p-norm</p></li> |
| </ul> |
| </dd> |
| </dl> |
| <p class="rubric">Examples</p> |
| <div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">predicts</span> <span class="o">=</span> <span class="p">[</span><span class="n">mx</span><span class="o">.</span><span class="n">np</span><span class="o">.</span><span class="n">array</span><span class="p">([[</span><span class="mf">1.</span><span class="p">,</span> <span class="mf">2.</span><span class="p">],</span> <span class="p">[</span><span class="mf">3.</span><span class="p">,</span> <span class="mf">4.</span><span class="p">]])]</span> |
| <span class="gp">>>> </span><span class="n">labels</span> <span class="o">=</span> <span class="p">[</span><span class="n">mx</span><span class="o">.</span><span class="n">np</span><span class="o">.</span><span class="n">array</span><span class="p">([[</span><span class="mf">1.</span><span class="p">,</span> <span class="mf">0.</span><span class="p">],</span> <span class="p">[</span><span class="mf">4.</span><span class="p">,</span> <span class="mf">2.</span><span class="p">]])]</span> |
| <span class="gp">>>> </span><span class="n">mpd</span> <span class="o">=</span> <span class="n">mx</span><span class="o">.</span><span class="n">gluon</span><span class="o">.</span><span class="n">metric</span><span class="o">.</span><span class="n">MeanPairwiseDistance</span><span class="p">()</span> |
| <span class="gp">>>> </span><span class="n">mpd</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="n">labels</span> <span class="o">=</span> <span class="n">labels</span><span class="p">,</span> <span class="n">preds</span> <span class="o">=</span> <span class="n">predicts</span><span class="p">)</span> |
| <span class="gp">>>> </span><span class="n">mpd</span><span class="o">.</span><span class="n">get</span><span class="p">()</span> |
| <span class="go">('mpd', 2.1180338859558105)</span> |
| </pre></div> |
| </div> |
| <dl class="method"> |
| <dt id="mxnet.gluon.metric.MeanPairwiseDistance.get"> |
| <code class="sig-name descname">get</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#mxnet.gluon.metric.MeanPairwiseDistance.get" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Gets the current evaluation result.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Returns</dt> |
| <dd class="field-odd"><p><ul class="simple"> |
| <li><p><strong>names</strong> (<em>list of str</em>) – Name of the metrics.</p></li> |
| <li><p><strong>values</strong> (<em>list of float</em>) – Value of the evaluations.</p></li> |
| </ul> |
| </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="mxnet.gluon.metric.MeanPairwiseDistance.get_config"> |
| <code class="sig-name descname">get_config</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#mxnet.gluon.metric.MeanPairwiseDistance.get_config" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Save configurations of metric. Can be recreated |
| from configs with metric.create(<code class="docutils literal notranslate"><span class="pre">**config</span></code>)</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="mxnet.gluon.metric.MeanPairwiseDistance.get_name_value"> |
| <code class="sig-name descname">get_name_value</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#mxnet.gluon.metric.MeanPairwiseDistance.get_name_value" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Returns zipped name and value pairs.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Returns</dt> |
| <dd class="field-odd"><p>A (name, value) tuple list.</p> |
| </dd> |
| <dt class="field-even">Return type</dt> |
| <dd class="field-even"><p>list of tuples</p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="mxnet.gluon.metric.MeanPairwiseDistance.reset"> |
| <code class="sig-name descname">reset</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#mxnet.gluon.metric.MeanPairwiseDistance.reset" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Resets the internal evaluation result to initial state.</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="mxnet.gluon.metric.MeanPairwiseDistance.update"> |
| <code class="sig-name descname">update</code><span class="sig-paren">(</span><em class="sig-param">labels</em>, <em class="sig-param">preds</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/mxnet/gluon/metric.html#MeanPairwiseDistance.update"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#mxnet.gluon.metric.MeanPairwiseDistance.update" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Updates the internal evaluation result.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters</dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>labels</strong> (list of <cite>NDArray</cite>) – The labels of the data.</p></li> |
| <li><p><strong>preds</strong> (list of <cite>NDArray</cite>) – Predicted values.</p></li> |
| </ul> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="mxnet.gluon.metric.MeanPairwiseDistance.update_dict"> |
| <code class="sig-name descname">update_dict</code><span class="sig-paren">(</span><em class="sig-param">label</em>, <em class="sig-param">pred</em><span class="sig-paren">)</span><a class="headerlink" href="#mxnet.gluon.metric.MeanPairwiseDistance.update_dict" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Update the internal evaluation with named label and pred</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters</dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>labels</strong> (<em>OrderedDict of str -> NDArray</em>) – name to array mapping for labels.</p></li> |
| <li><p><strong>preds</strong> (<em>OrderedDict of str -> NDArray</em>) – name to array mapping of predicted outputs.</p></li> |
| </ul> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="class"> |
| <dt id="mxnet.gluon.metric.PCC"> |
| <em class="property">class </em><code class="sig-name descname">PCC</code><span class="sig-paren">(</span><em class="sig-param">name='pcc'</em>, <em class="sig-param">output_names=None</em>, <em class="sig-param">label_names=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/mxnet/gluon/metric.html#PCC"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#mxnet.gluon.metric.PCC" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Bases: <a class="reference internal" href="#mxnet.gluon.metric.EvalMetric" title="mxnet.gluon.metric.EvalMetric"><code class="xref py py-class docutils literal notranslate"><span class="pre">mxnet.gluon.metric.EvalMetric</span></code></a></p> |
| <p>PCC is a multiclass equivalent for the Matthews correlation coefficient derived |
| from a discrete solution to the Pearson correlation coefficient.</p> |
| <div class="math notranslate nohighlight"> |
| \[\text{PCC} = \frac {\sum _{k}\sum _{l}\sum _{m}C_{kk}C_{lm}-C_{kl}C_{mk}} |
| {{\sqrt {\sum _{k}(\sum _{l}C_{kl})(\sum _{k'|k'\neq k}\sum _{l'}C_{k'l'})}} |
| {\sqrt {\sum _{k}(\sum _{l}C_{lk})(\sum _{k'|k'\neq k}\sum _{l'}C_{l'k'})}}}\]</div> |
| <p><strong>Methods</strong></p> |
| <table class="longtable docutils align-default"> |
| <colgroup> |
| <col style="width: 10%" /> |
| <col style="width: 90%" /> |
| </colgroup> |
| <tbody> |
| <tr class="row-odd"><td><p><a class="reference internal" href="#mxnet.gluon.metric.PCC.get" title="mxnet.gluon.metric.PCC.get"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get</span></code></a>()</p></td> |
| <td><p>Gets the current evaluation result.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="#mxnet.gluon.metric.PCC.get_config" title="mxnet.gluon.metric.PCC.get_config"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_config</span></code></a>()</p></td> |
| <td><p>Save configurations of metric.</p></td> |
| </tr> |
| <tr class="row-odd"><td><p><a class="reference internal" href="#mxnet.gluon.metric.PCC.get_name_value" title="mxnet.gluon.metric.PCC.get_name_value"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_name_value</span></code></a>()</p></td> |
| <td><p>Returns zipped name and value pairs.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="#mxnet.gluon.metric.PCC.reset" title="mxnet.gluon.metric.PCC.reset"><code class="xref py py-obj docutils literal notranslate"><span class="pre">reset</span></code></a>()</p></td> |
| <td><p>Resets the internal evaluation result to initial state.</p></td> |
| </tr> |
| <tr class="row-odd"><td><p><a class="reference internal" href="#mxnet.gluon.metric.PCC.update" title="mxnet.gluon.metric.PCC.update"><code class="xref py py-obj docutils literal notranslate"><span class="pre">update</span></code></a>(labels, preds)</p></td> |
| <td><p>Updates the internal evaluation result.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="#mxnet.gluon.metric.PCC.update_dict" title="mxnet.gluon.metric.PCC.update_dict"><code class="xref py py-obj docutils literal notranslate"><span class="pre">update_dict</span></code></a>(label, pred)</p></td> |
| <td><p>Update the internal evaluation with named label and pred</p></td> |
| </tr> |
| </tbody> |
| </table> |
| <p><strong>Attributes</strong></p> |
| <table class="longtable docutils align-default"> |
| <colgroup> |
| <col style="width: 10%" /> |
| <col style="width: 90%" /> |
| </colgroup> |
| <tbody> |
| <tr class="row-odd"><td><p><a class="reference internal" href="#mxnet.gluon.metric.PCC.sum_metric" title="mxnet.gluon.metric.PCC.sum_metric"><code class="xref py py-obj docutils literal notranslate"><span class="pre">sum_metric</span></code></a></p></td> |
| <td><p>Return an attribute of instance, which is of type owner.</p></td> |
| </tr> |
| </tbody> |
| </table> |
| <p>defined in terms of a K x K confusion matrix C.</p> |
| <p>When there are more than two labels the PCC will no longer range between -1 and +1. |
| Instead the minimum value will be between -1 and 0 depending on the true distribution. |
| The maximum value is always +1.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters</dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>name</strong> (<em>str</em>) – Name of this metric instance for display.</p></li> |
| <li><p><strong>output_names</strong> (<em>list of str</em><em>, or </em><em>None</em>) – Name of predictions that should be used when updating with update_dict. |
| By default include all predictions.</p></li> |
| <li><p><strong>label_names</strong> (<em>list of str</em><em>, or </em><em>None</em>) – Name of labels that should be used when updating with update_dict. |
| By default include all labels.</p></li> |
| </ul> |
| </dd> |
| </dl> |
| <p class="rubric">Examples</p> |
| <div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="c1"># In this example the network almost always predicts positive</span> |
| <span class="gp">>>> </span><span class="n">false_positives</span> <span class="o">=</span> <span class="mi">1000</span> |
| <span class="gp">>>> </span><span class="n">false_negatives</span> <span class="o">=</span> <span class="mi">1</span> |
| <span class="gp">>>> </span><span class="n">true_positives</span> <span class="o">=</span> <span class="mi">10000</span> |
| <span class="gp">>>> </span><span class="n">true_negatives</span> <span class="o">=</span> <span class="mi">1</span> |
| <span class="gp">>>> </span><span class="n">predicts</span> <span class="o">=</span> <span class="p">[</span><span class="n">mx</span><span class="o">.</span><span class="n">np</span><span class="o">.</span><span class="n">array</span><span class="p">(</span> |
| <span class="go"> [[.3, .7]]*false_positives +</span> |
| <span class="go"> [[.7, .3]]*true_negatives +</span> |
| <span class="go"> [[.7, .3]]*false_negatives +</span> |
| <span class="go"> [[.3, .7]]*true_positives</span> |
| <span class="go">)]</span> |
| <span class="gp">>>> </span><span class="n">labels</span> <span class="o">=</span> <span class="p">[</span><span class="n">mx</span><span class="o">.</span><span class="n">np</span><span class="o">.</span><span class="n">array</span><span class="p">(</span> |
| <span class="go"> [0]*(false_positives + true_negatives) +</span> |
| <span class="go"> [1]*(false_negatives + true_positives)</span> |
| <span class="go">)]</span> |
| <span class="gp">>>> </span><span class="n">f1</span> <span class="o">=</span> <span class="n">mx</span><span class="o">.</span><span class="n">gluon</span><span class="o">.</span><span class="n">metric</span><span class="o">.</span><span class="n">F1</span><span class="p">()</span> |
| <span class="gp">>>> </span><span class="n">f1</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="n">preds</span> <span class="o">=</span> <span class="n">predicts</span><span class="p">,</span> <span class="n">labels</span> <span class="o">=</span> <span class="n">labels</span><span class="p">)</span> |
| <span class="gp">>>> </span><span class="n">pcc</span> <span class="o">=</span> <span class="n">mx</span><span class="o">.</span><span class="n">gluon</span><span class="o">.</span><span class="n">metric</span><span class="o">.</span><span class="n">PCC</span><span class="p">()</span> |
| <span class="gp">>>> </span><span class="n">pcc</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="n">preds</span> <span class="o">=</span> <span class="n">predicts</span><span class="p">,</span> <span class="n">labels</span> <span class="o">=</span> <span class="n">labels</span><span class="p">)</span> |
| <span class="gp">>>> </span><span class="n">f1</span><span class="o">.</span><span class="n">get</span><span class="p">()</span> |
| <span class="go">('f1', 0.95233560306652054)</span> |
| <span class="gp">>>> </span><span class="n">pcc</span><span class="o">.</span><span class="n">get</span><span class="p">()</span> |
| <span class="go">('pcc', 0.01917751877733392)</span> |
| </pre></div> |
| </div> |
| <dl class="method"> |
| <dt id="mxnet.gluon.metric.PCC.get"> |
| <code class="sig-name descname">get</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#mxnet.gluon.metric.PCC.get" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Gets the current evaluation result.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Returns</dt> |
| <dd class="field-odd"><p><ul class="simple"> |
| <li><p><strong>names</strong> (<em>list of str</em>) – Name of the metrics.</p></li> |
| <li><p><strong>values</strong> (<em>list of float</em>) – Value of the evaluations.</p></li> |
| </ul> |
| </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="mxnet.gluon.metric.PCC.get_config"> |
| <code class="sig-name descname">get_config</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#mxnet.gluon.metric.PCC.get_config" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Save configurations of metric. Can be recreated |
| from configs with metric.create(<code class="docutils literal notranslate"><span class="pre">**config</span></code>)</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="mxnet.gluon.metric.PCC.get_name_value"> |
| <code class="sig-name descname">get_name_value</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#mxnet.gluon.metric.PCC.get_name_value" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Returns zipped name and value pairs.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Returns</dt> |
| <dd class="field-odd"><p>A (name, value) tuple list.</p> |
| </dd> |
| <dt class="field-even">Return type</dt> |
| <dd class="field-even"><p>list of tuples</p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="mxnet.gluon.metric.PCC.reset"> |
| <code class="sig-name descname">reset</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/mxnet/gluon/metric.html#PCC.reset"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#mxnet.gluon.metric.PCC.reset" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Resets the internal evaluation result to initial state.</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="mxnet.gluon.metric.PCC.sum_metric"> |
| <em class="property">property </em><code class="sig-name descname">sum_metric</code><a class="headerlink" href="#mxnet.gluon.metric.PCC.sum_metric" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Return an attribute of instance, which is of type owner.</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="mxnet.gluon.metric.PCC.update"> |
| <code class="sig-name descname">update</code><span class="sig-paren">(</span><em class="sig-param">labels</em>, <em class="sig-param">preds</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/mxnet/gluon/metric.html#PCC.update"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#mxnet.gluon.metric.PCC.update" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Updates the internal evaluation result.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters</dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>labels</strong> (list of <cite>NDArray</cite>) – The labels of the data.</p></li> |
| <li><p><strong>preds</strong> (list of <cite>NDArray</cite>) – Predicted values.</p></li> |
| </ul> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="mxnet.gluon.metric.PCC.update_dict"> |
| <code class="sig-name descname">update_dict</code><span class="sig-paren">(</span><em class="sig-param">label</em>, <em class="sig-param">pred</em><span class="sig-paren">)</span><a class="headerlink" href="#mxnet.gluon.metric.PCC.update_dict" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Update the internal evaluation with named label and pred</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters</dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>labels</strong> (<em>OrderedDict of str -> NDArray</em>) – name to array mapping for labels.</p></li> |
| <li><p><strong>preds</strong> (<em>OrderedDict of str -> NDArray</em>) – name to array mapping of predicted outputs.</p></li> |
| </ul> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="class"> |
| <dt id="mxnet.gluon.metric.PearsonCorrelation"> |
| <em class="property">class </em><code class="sig-name descname">PearsonCorrelation</code><span class="sig-paren">(</span><em class="sig-param">name='pearsonr'</em>, <em class="sig-param">output_names=None</em>, <em class="sig-param">label_names=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/mxnet/gluon/metric.html#PearsonCorrelation"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#mxnet.gluon.metric.PearsonCorrelation" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Bases: <a class="reference internal" href="#mxnet.gluon.metric.EvalMetric" title="mxnet.gluon.metric.EvalMetric"><code class="xref py py-class docutils literal notranslate"><span class="pre">mxnet.gluon.metric.EvalMetric</span></code></a></p> |
| <p>Computes Pearson correlation.</p> |
| <p>The pearson correlation is given by</p> |
| <div class="math notranslate nohighlight"> |
| \[\frac{cov(y, \hat{y})}{\sigma{y}\sigma{\hat{y}}}\]</div> |
| <p><strong>Methods</strong></p> |
| <table class="longtable docutils align-default"> |
| <colgroup> |
| <col style="width: 10%" /> |
| <col style="width: 90%" /> |
| </colgroup> |
| <tbody> |
| <tr class="row-odd"><td><p><a class="reference internal" href="#mxnet.gluon.metric.PearsonCorrelation.get" title="mxnet.gluon.metric.PearsonCorrelation.get"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get</span></code></a>()</p></td> |
| <td><p>Gets the current evaluation result.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="#mxnet.gluon.metric.PearsonCorrelation.get_config" title="mxnet.gluon.metric.PearsonCorrelation.get_config"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_config</span></code></a>()</p></td> |
| <td><p>Save configurations of metric.</p></td> |
| </tr> |
| <tr class="row-odd"><td><p><a class="reference internal" href="#mxnet.gluon.metric.PearsonCorrelation.get_name_value" title="mxnet.gluon.metric.PearsonCorrelation.get_name_value"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_name_value</span></code></a>()</p></td> |
| <td><p>Returns zipped name and value pairs.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="#mxnet.gluon.metric.PearsonCorrelation.reset" title="mxnet.gluon.metric.PearsonCorrelation.reset"><code class="xref py py-obj docutils literal notranslate"><span class="pre">reset</span></code></a>()</p></td> |
| <td><p>Resets the internal evaluation result to initial state.</p></td> |
| </tr> |
| <tr class="row-odd"><td><p><a class="reference internal" href="#mxnet.gluon.metric.PearsonCorrelation.update" title="mxnet.gluon.metric.PearsonCorrelation.update"><code class="xref py py-obj docutils literal notranslate"><span class="pre">update</span></code></a>(labels, preds)</p></td> |
| <td><p>Updates the internal evaluation result.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="#mxnet.gluon.metric.PearsonCorrelation.update_dict" title="mxnet.gluon.metric.PearsonCorrelation.update_dict"><code class="xref py py-obj docutils literal notranslate"><span class="pre">update_dict</span></code></a>(label, pred)</p></td> |
| <td><p>Update the internal evaluation with named label and pred</p></td> |
| </tr> |
| </tbody> |
| </table> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters</dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>name</strong> (<em>str</em>) – Name of this metric instance for display.</p></li> |
| <li><p><strong>output_names</strong> (<em>list of str</em><em>, or </em><em>None</em>) – Name of predictions that should be used when updating with update_dict. |
| By default include all predictions.</p></li> |
| <li><p><strong>label_names</strong> (<em>list of str</em><em>, or </em><em>None</em>) – Name of labels that should be used when updating with update_dict. |
| By default include all labels.</p></li> |
| </ul> |
| </dd> |
| </dl> |
| <p class="rubric">Examples</p> |
| <div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">predicts</span> <span class="o">=</span> <span class="p">[</span><span class="n">mx</span><span class="o">.</span><span class="n">np</span><span class="o">.</span><span class="n">array</span><span class="p">([[</span><span class="mf">0.3</span><span class="p">,</span> <span class="mf">0.7</span><span class="p">],</span> <span class="p">[</span><span class="mi">0</span><span class="p">,</span> <span class="mf">1.</span><span class="p">],</span> <span class="p">[</span><span class="mf">0.4</span><span class="p">,</span> <span class="mf">0.6</span><span class="p">]])]</span> |
| <span class="gp">>>> </span><span class="n">labels</span> <span class="o">=</span> <span class="p">[</span><span class="n">mx</span><span class="o">.</span><span class="n">np</span><span class="o">.</span><span class="n">array</span><span class="p">([[</span><span class="mi">1</span><span class="p">,</span> <span class="mi">0</span><span class="p">],</span> <span class="p">[</span><span class="mi">0</span><span class="p">,</span> <span class="mi">1</span><span class="p">],</span> <span class="p">[</span><span class="mi">0</span><span class="p">,</span> <span class="mi">1</span><span class="p">]])]</span> |
| <span class="gp">>>> </span><span class="n">pr</span> <span class="o">=</span> <span class="n">mx</span><span class="o">.</span><span class="n">gluon</span><span class="o">.</span><span class="n">metric</span><span class="o">.</span><span class="n">PearsonCorrelation</span><span class="p">()</span> |
| <span class="gp">>>> </span><span class="n">pr</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="n">labels</span><span class="p">,</span> <span class="n">predicts</span><span class="p">)</span> |
| <span class="gp">>>> </span><span class="n">pr</span><span class="o">.</span><span class="n">get</span><span class="p">()</span> |
| <span class="go">('pearsonr', 0.42163704544016178)</span> |
| </pre></div> |
| </div> |
| <dl class="method"> |
| <dt id="mxnet.gluon.metric.PearsonCorrelation.get"> |
| <code class="sig-name descname">get</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/mxnet/gluon/metric.html#PearsonCorrelation.get"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#mxnet.gluon.metric.PearsonCorrelation.get" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Gets the current evaluation result.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Returns</dt> |
| <dd class="field-odd"><p><ul class="simple"> |
| <li><p><strong>names</strong> (<em>list of str</em>) – Name of the metrics.</p></li> |
| <li><p><strong>values</strong> (<em>list of float</em>) – Value of the evaluations.</p></li> |
| </ul> |
| </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="mxnet.gluon.metric.PearsonCorrelation.get_config"> |
| <code class="sig-name descname">get_config</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#mxnet.gluon.metric.PearsonCorrelation.get_config" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Save configurations of metric. Can be recreated |
| from configs with metric.create(<code class="docutils literal notranslate"><span class="pre">**config</span></code>)</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="mxnet.gluon.metric.PearsonCorrelation.get_name_value"> |
| <code class="sig-name descname">get_name_value</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#mxnet.gluon.metric.PearsonCorrelation.get_name_value" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Returns zipped name and value pairs.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Returns</dt> |
| <dd class="field-odd"><p>A (name, value) tuple list.</p> |
| </dd> |
| <dt class="field-even">Return type</dt> |
| <dd class="field-even"><p>list of tuples</p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="mxnet.gluon.metric.PearsonCorrelation.reset"> |
| <code class="sig-name descname">reset</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/mxnet/gluon/metric.html#PearsonCorrelation.reset"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#mxnet.gluon.metric.PearsonCorrelation.reset" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Resets the internal evaluation result to initial state.</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="mxnet.gluon.metric.PearsonCorrelation.update"> |
| <code class="sig-name descname">update</code><span class="sig-paren">(</span><em class="sig-param">labels</em>, <em class="sig-param">preds</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/mxnet/gluon/metric.html#PearsonCorrelation.update"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#mxnet.gluon.metric.PearsonCorrelation.update" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Updates the internal evaluation result.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters</dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>labels</strong> (list of <cite>NDArray</cite>) – The labels of the data.</p></li> |
| <li><p><strong>preds</strong> (list of <cite>NDArray</cite>) – Predicted values.</p></li> |
| </ul> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="mxnet.gluon.metric.PearsonCorrelation.update_dict"> |
| <code class="sig-name descname">update_dict</code><span class="sig-paren">(</span><em class="sig-param">label</em>, <em class="sig-param">pred</em><span class="sig-paren">)</span><a class="headerlink" href="#mxnet.gluon.metric.PearsonCorrelation.update_dict" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Update the internal evaluation with named label and pred</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters</dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>labels</strong> (<em>OrderedDict of str -> NDArray</em>) – name to array mapping for labels.</p></li> |
| <li><p><strong>preds</strong> (<em>OrderedDict of str -> NDArray</em>) – name to array mapping of predicted outputs.</p></li> |
| </ul> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="class"> |
| <dt id="mxnet.gluon.metric.Perplexity"> |
| <em class="property">class </em><code class="sig-name descname">Perplexity</code><span class="sig-paren">(</span><em class="sig-param">eps=1e-12</em>, <em class="sig-param">ignore_label=None</em>, <em class="sig-param">axis=-1</em>, <em class="sig-param">from_logits=False</em>, <em class="sig-param">name='perplexity'</em>, <em class="sig-param">output_names=None</em>, <em class="sig-param">label_names=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/mxnet/gluon/metric.html#Perplexity"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#mxnet.gluon.metric.Perplexity" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Bases: <a class="reference internal" href="#mxnet.gluon.metric.CrossEntropy" title="mxnet.gluon.metric.CrossEntropy"><code class="xref py py-class docutils literal notranslate"><span class="pre">mxnet.gluon.metric.CrossEntropy</span></code></a></p> |
| <p>Computes perplexity.</p> |
| <p>Perplexity is a measurement of how well a probability distribution |
| or model predicts a sample. A low perplexity indicates the model |
| is good at predicting the sample.</p> |
| <p>The perplexity of a model q is defined as</p> |
| <div class="math notranslate nohighlight"> |
| \[b^{\big(-\frac{1}{N} \sum_{i=1}^N \log_b q(x_i) \big)} |
| = \exp \big(-\frac{1}{N} \sum_{i=1}^N \log q(x_i)\big)\]</div> |
| <p><strong>Methods</strong></p> |
| <table class="longtable docutils align-default"> |
| <colgroup> |
| <col style="width: 10%" /> |
| <col style="width: 90%" /> |
| </colgroup> |
| <tbody> |
| <tr class="row-odd"><td><p><a class="reference internal" href="#mxnet.gluon.metric.Perplexity.get" title="mxnet.gluon.metric.Perplexity.get"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get</span></code></a>()</p></td> |
| <td><p>Gets the current evaluation result.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="#mxnet.gluon.metric.Perplexity.get_config" title="mxnet.gluon.metric.Perplexity.get_config"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_config</span></code></a>()</p></td> |
| <td><p>Save configurations of metric.</p></td> |
| </tr> |
| <tr class="row-odd"><td><p><a class="reference internal" href="#mxnet.gluon.metric.Perplexity.get_name_value" title="mxnet.gluon.metric.Perplexity.get_name_value"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_name_value</span></code></a>()</p></td> |
| <td><p>Returns zipped name and value pairs.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="#mxnet.gluon.metric.Perplexity.reset" title="mxnet.gluon.metric.Perplexity.reset"><code class="xref py py-obj docutils literal notranslate"><span class="pre">reset</span></code></a>()</p></td> |
| <td><p>Resets the internal evaluation result to initial state.</p></td> |
| </tr> |
| <tr class="row-odd"><td><p><a class="reference internal" href="#mxnet.gluon.metric.Perplexity.update" title="mxnet.gluon.metric.Perplexity.update"><code class="xref py py-obj docutils literal notranslate"><span class="pre">update</span></code></a>(labels, preds)</p></td> |
| <td><p>Updates the internal evaluation result.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="#mxnet.gluon.metric.Perplexity.update_dict" title="mxnet.gluon.metric.Perplexity.update_dict"><code class="xref py py-obj docutils literal notranslate"><span class="pre">update_dict</span></code></a>(label, pred)</p></td> |
| <td><p>Update the internal evaluation with named label and pred</p></td> |
| </tr> |
| </tbody> |
| </table> |
| <p>where we let <cite>b = e</cite>.</p> |
| <p><span class="math notranslate nohighlight">\(q(x_i)\)</span> is the predicted value of its ground truth |
| label on sample <span class="math notranslate nohighlight">\(x_i\)</span>.</p> |
| <p>For example, we have three samples <span class="math notranslate nohighlight">\(x_1, x_2, x_3\)</span> and their labels |
| are <span class="math notranslate nohighlight">\([0, 1, 1]\)</span>. |
| Suppose our model predicts <span class="math notranslate nohighlight">\(q(x_1) = p(y_1 = 0 | x_1) = 0.3\)</span> |
| and <span class="math notranslate nohighlight">\(q(x_2) = 1.0\)</span>, |
| <span class="math notranslate nohighlight">\(q(x_3) = 0.6\)</span>. The perplexity of model q is |
| <span class="math notranslate nohighlight">\(exp\big(-(\log 0.3 + \log 1.0 + \log 0.6) / 3\big) = 1.77109762852\)</span>.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters</dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>eps</strong> (<em>float</em><em>, </em><em>default 1e-12</em>) – Use small constant for the case that predicted value is 0.</p></li> |
| <li><p><strong>ignore_label</strong> (<em>int</em><em> or </em><em>None</em><em>, </em><em>default None</em>) – Index of invalid label to ignore when |
| counting. By default, sets to -1. |
| If set to <cite>None</cite>, it will include all entries.</p></li> |
| <li><p><strong>axis</strong> (<em>int</em><em> (</em><em>default -1</em><em>)</em>) – The axis from prediction that was used to |
| compute softmax. By default use the last axis.</p></li> |
| <li><p><strong>name</strong> (<em>str</em>) – Name of this metric instance for display.</p></li> |
| <li><p><strong>output_names</strong> (<em>list of str</em><em>, or </em><em>None</em>) – Name of predictions that should be used when updating with update_dict. |
| By default include all predictions.</p></li> |
| <li><p><strong>label_names</strong> (<em>list of str</em><em>, or </em><em>None</em>) – Name of labels that should be used when updating with update_dict. |
| By default include all labels.</p></li> |
| </ul> |
| </dd> |
| </dl> |
| <p class="rubric">Examples</p> |
| <div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">predicts</span> <span class="o">=</span> <span class="p">[</span><span class="n">mx</span><span class="o">.</span><span class="n">np</span><span class="o">.</span><span class="n">array</span><span class="p">([[</span><span class="mf">0.3</span><span class="p">,</span> <span class="mf">0.7</span><span class="p">],</span> <span class="p">[</span><span class="mi">0</span><span class="p">,</span> <span class="mf">1.</span><span class="p">],</span> <span class="p">[</span><span class="mf">0.4</span><span class="p">,</span> <span class="mf">0.6</span><span class="p">]])]</span> |
| <span class="gp">>>> </span><span class="n">labels</span> <span class="o">=</span> <span class="p">[</span><span class="n">mx</span><span class="o">.</span><span class="n">np</span><span class="o">.</span><span class="n">array</span><span class="p">([</span><span class="mi">0</span><span class="p">,</span> <span class="mi">1</span><span class="p">,</span> <span class="mi">1</span><span class="p">])]</span> |
| <span class="gp">>>> </span><span class="n">perp</span> <span class="o">=</span> <span class="n">mx</span><span class="o">.</span><span class="n">gluon</span><span class="o">.</span><span class="n">metric</span><span class="o">.</span><span class="n">Perplexity</span><span class="p">(</span><span class="n">ignore_label</span><span class="o">=</span><span class="kc">None</span><span class="p">)</span> |
| <span class="gp">>>> </span><span class="n">perp</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="n">labels</span><span class="p">,</span> <span class="n">predicts</span><span class="p">)</span> |
| <span class="gp">>>> </span><span class="n">perp</span><span class="o">.</span><span class="n">get</span><span class="p">()</span> |
| <span class="go">('Perplexity', 1.7710976285155853)</span> |
| </pre></div> |
| </div> |
| <dl class="method"> |
| <dt id="mxnet.gluon.metric.Perplexity.get"> |
| <code class="sig-name descname">get</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/mxnet/gluon/metric.html#Perplexity.get"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#mxnet.gluon.metric.Perplexity.get" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Gets the current evaluation result.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Returns</dt> |
| <dd class="field-odd"><p><ul class="simple"> |
| <li><p><strong>names</strong> (<em>list of str</em>) – Name of the metrics.</p></li> |
| <li><p><strong>values</strong> (<em>list of float</em>) – Value of the evaluations.</p></li> |
| </ul> |
| </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="mxnet.gluon.metric.Perplexity.get_config"> |
| <code class="sig-name descname">get_config</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#mxnet.gluon.metric.Perplexity.get_config" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Save configurations of metric. Can be recreated |
| from configs with metric.create(<code class="docutils literal notranslate"><span class="pre">**config</span></code>)</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="mxnet.gluon.metric.Perplexity.get_name_value"> |
| <code class="sig-name descname">get_name_value</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#mxnet.gluon.metric.Perplexity.get_name_value" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Returns zipped name and value pairs.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Returns</dt> |
| <dd class="field-odd"><p>A (name, value) tuple list.</p> |
| </dd> |
| <dt class="field-even">Return type</dt> |
| <dd class="field-even"><p>list of tuples</p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="mxnet.gluon.metric.Perplexity.reset"> |
| <code class="sig-name descname">reset</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#mxnet.gluon.metric.Perplexity.reset" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Resets the internal evaluation result to initial state.</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="mxnet.gluon.metric.Perplexity.update"> |
| <code class="sig-name descname">update</code><span class="sig-paren">(</span><em class="sig-param">labels</em>, <em class="sig-param">preds</em><span class="sig-paren">)</span><a class="headerlink" href="#mxnet.gluon.metric.Perplexity.update" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Updates the internal evaluation result.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters</dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>labels</strong> (list of <cite>NDArray</cite>) – The labels of the data.</p></li> |
| <li><p><strong>preds</strong> (list of <cite>NDArray</cite>) – Predicted values.</p></li> |
| </ul> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="mxnet.gluon.metric.Perplexity.update_dict"> |
| <code class="sig-name descname">update_dict</code><span class="sig-paren">(</span><em class="sig-param">label</em>, <em class="sig-param">pred</em><span class="sig-paren">)</span><a class="headerlink" href="#mxnet.gluon.metric.Perplexity.update_dict" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Update the internal evaluation with named label and pred</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters</dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>labels</strong> (<em>OrderedDict of str -> NDArray</em>) – name to array mapping for labels.</p></li> |
| <li><p><strong>preds</strong> (<em>OrderedDict of str -> NDArray</em>) – name to array mapping of predicted outputs.</p></li> |
| </ul> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="class"> |
| <dt id="mxnet.gluon.metric.RMSE"> |
| <em class="property">class </em><code class="sig-name descname">RMSE</code><span class="sig-paren">(</span><em class="sig-param">name='rmse'</em>, <em class="sig-param">output_names=None</em>, <em class="sig-param">label_names=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/mxnet/gluon/metric.html#RMSE"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#mxnet.gluon.metric.RMSE" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Bases: <a class="reference internal" href="#mxnet.gluon.metric.MSE" title="mxnet.gluon.metric.MSE"><code class="xref py py-class docutils literal notranslate"><span class="pre">mxnet.gluon.metric.MSE</span></code></a></p> |
| <p>Computes Root Mean Squred Error (RMSE) loss.</p> |
| <p>The root mean squared error is given by</p> |
| <div class="math notranslate nohighlight"> |
| \[\sqrt{\frac{\sum_i^n (y_i - \hat{y}_i)^2}{n}}\]</div> |
| <p><strong>Methods</strong></p> |
| <table class="longtable docutils align-default"> |
| <colgroup> |
| <col style="width: 10%" /> |
| <col style="width: 90%" /> |
| </colgroup> |
| <tbody> |
| <tr class="row-odd"><td><p><a class="reference internal" href="#mxnet.gluon.metric.RMSE.get" title="mxnet.gluon.metric.RMSE.get"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get</span></code></a>()</p></td> |
| <td><p>Gets the current evaluation result.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="#mxnet.gluon.metric.RMSE.get_config" title="mxnet.gluon.metric.RMSE.get_config"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_config</span></code></a>()</p></td> |
| <td><p>Save configurations of metric.</p></td> |
| </tr> |
| <tr class="row-odd"><td><p><a class="reference internal" href="#mxnet.gluon.metric.RMSE.get_name_value" title="mxnet.gluon.metric.RMSE.get_name_value"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_name_value</span></code></a>()</p></td> |
| <td><p>Returns zipped name and value pairs.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="#mxnet.gluon.metric.RMSE.reset" title="mxnet.gluon.metric.RMSE.reset"><code class="xref py py-obj docutils literal notranslate"><span class="pre">reset</span></code></a>()</p></td> |
| <td><p>Resets the internal evaluation result to initial state.</p></td> |
| </tr> |
| <tr class="row-odd"><td><p><a class="reference internal" href="#mxnet.gluon.metric.RMSE.update" title="mxnet.gluon.metric.RMSE.update"><code class="xref py py-obj docutils literal notranslate"><span class="pre">update</span></code></a>(labels, preds)</p></td> |
| <td><p>Updates the internal evaluation result.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="#mxnet.gluon.metric.RMSE.update_dict" title="mxnet.gluon.metric.RMSE.update_dict"><code class="xref py py-obj docutils literal notranslate"><span class="pre">update_dict</span></code></a>(label, pred)</p></td> |
| <td><p>Update the internal evaluation with named label and pred</p></td> |
| </tr> |
| </tbody> |
| </table> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters</dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>name</strong> (<em>str</em>) – Name of this metric instance for display.</p></li> |
| <li><p><strong>output_names</strong> (<em>list of str</em><em>, or </em><em>None</em>) – Name of predictions that should be used when updating with update_dict. |
| By default include all predictions.</p></li> |
| <li><p><strong>label_names</strong> (<em>list of str</em><em>, or </em><em>None</em>) – Name of labels that should be used when updating with update_dict. |
| By default include all labels.</p></li> |
| </ul> |
| </dd> |
| </dl> |
| <p class="rubric">Examples</p> |
| <div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">predicts</span> <span class="o">=</span> <span class="p">[</span><span class="n">mx</span><span class="o">.</span><span class="n">np</span><span class="o">.</span><span class="n">array</span><span class="p">([</span><span class="mi">3</span><span class="p">,</span> <span class="o">-</span><span class="mf">0.5</span><span class="p">,</span> <span class="mi">2</span><span class="p">,</span> <span class="mi">7</span><span class="p">])]</span> |
| <span class="gp">>>> </span><span class="n">labels</span> <span class="o">=</span> <span class="p">[</span><span class="n">mx</span><span class="o">.</span><span class="n">np</span><span class="o">.</span><span class="n">array</span><span class="p">([</span><span class="mf">2.5</span><span class="p">,</span> <span class="mf">0.0</span><span class="p">,</span> <span class="mi">2</span><span class="p">,</span> <span class="mi">8</span><span class="p">])]</span> |
| <span class="gp">>>> </span><span class="n">root_mean_squared_error</span> <span class="o">=</span> <span class="n">mx</span><span class="o">.</span><span class="n">gluon</span><span class="o">.</span><span class="n">metric</span><span class="o">.</span><span class="n">RMSE</span><span class="p">()</span> |
| <span class="gp">>>> </span><span class="n">root_mean_squared_error</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="n">labels</span> <span class="o">=</span> <span class="n">labels</span><span class="p">,</span> <span class="n">preds</span> <span class="o">=</span> <span class="n">predicts</span><span class="p">)</span> |
| <span class="gp">>>> </span><span class="n">root_mean_squared_error</span><span class="o">.</span><span class="n">get</span><span class="p">()</span> |
| <span class="go">('rmse', 0.612372457981)</span> |
| </pre></div> |
| </div> |
| <dl class="method"> |
| <dt id="mxnet.gluon.metric.RMSE.get"> |
| <code class="sig-name descname">get</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/mxnet/gluon/metric.html#RMSE.get"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#mxnet.gluon.metric.RMSE.get" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Gets the current evaluation result.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Returns</dt> |
| <dd class="field-odd"><p><ul class="simple"> |
| <li><p><strong>names</strong> (<em>list of str</em>) – Name of the metrics.</p></li> |
| <li><p><strong>values</strong> (<em>list of float</em>) – Value of the evaluations.</p></li> |
| </ul> |
| </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="mxnet.gluon.metric.RMSE.get_config"> |
| <code class="sig-name descname">get_config</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#mxnet.gluon.metric.RMSE.get_config" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Save configurations of metric. Can be recreated |
| from configs with metric.create(<code class="docutils literal notranslate"><span class="pre">**config</span></code>)</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="mxnet.gluon.metric.RMSE.get_name_value"> |
| <code class="sig-name descname">get_name_value</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#mxnet.gluon.metric.RMSE.get_name_value" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Returns zipped name and value pairs.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Returns</dt> |
| <dd class="field-odd"><p>A (name, value) tuple list.</p> |
| </dd> |
| <dt class="field-even">Return type</dt> |
| <dd class="field-even"><p>list of tuples</p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="mxnet.gluon.metric.RMSE.reset"> |
| <code class="sig-name descname">reset</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#mxnet.gluon.metric.RMSE.reset" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Resets the internal evaluation result to initial state.</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="mxnet.gluon.metric.RMSE.update"> |
| <code class="sig-name descname">update</code><span class="sig-paren">(</span><em class="sig-param">labels</em>, <em class="sig-param">preds</em><span class="sig-paren">)</span><a class="headerlink" href="#mxnet.gluon.metric.RMSE.update" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Updates the internal evaluation result.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters</dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>labels</strong> (list of <cite>NDArray</cite>) – The labels of the data.</p></li> |
| <li><p><strong>preds</strong> (list of <cite>NDArray</cite>) – Predicted values.</p></li> |
| </ul> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="mxnet.gluon.metric.RMSE.update_dict"> |
| <code class="sig-name descname">update_dict</code><span class="sig-paren">(</span><em class="sig-param">label</em>, <em class="sig-param">pred</em><span class="sig-paren">)</span><a class="headerlink" href="#mxnet.gluon.metric.RMSE.update_dict" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Update the internal evaluation with named label and pred</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters</dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>labels</strong> (<em>OrderedDict of str -> NDArray</em>) – name to array mapping for labels.</p></li> |
| <li><p><strong>preds</strong> (<em>OrderedDict of str -> NDArray</em>) – name to array mapping of predicted outputs.</p></li> |
| </ul> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="class"> |
| <dt id="mxnet.gluon.metric.TopKAccuracy"> |
| <em class="property">class </em><code class="sig-name descname">TopKAccuracy</code><span class="sig-paren">(</span><em class="sig-param">top_k=1</em>, <em class="sig-param">name='top_k_accuracy'</em>, <em class="sig-param">output_names=None</em>, <em class="sig-param">label_names=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/mxnet/gluon/metric.html#TopKAccuracy"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#mxnet.gluon.metric.TopKAccuracy" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Bases: <a class="reference internal" href="#mxnet.gluon.metric.EvalMetric" title="mxnet.gluon.metric.EvalMetric"><code class="xref py py-class docutils literal notranslate"><span class="pre">mxnet.gluon.metric.EvalMetric</span></code></a></p> |
| <p>Computes top k predictions accuracy.</p> |
| <p><cite>TopKAccuracy</cite> differs from Accuracy in that it considers the prediction |
| to be <code class="docutils literal notranslate"><span class="pre">True</span></code> as long as the ground truth label is in the top K |
| predicated labels.</p> |
| <p>If <cite>top_k</cite> = <code class="docutils literal notranslate"><span class="pre">1</span></code>, then <cite>TopKAccuracy</cite> is identical to <cite>Accuracy</cite>.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters</dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>top_k</strong> (<em>int</em>) – Whether targets are in top k predictions.</p></li> |
| <li><p><strong>name</strong> (<em>str</em>) – Name of this metric instance for display.</p></li> |
| <li><p><strong>output_names</strong> (<em>list of str</em><em>, or </em><em>None</em>) – Name of predictions that should be used when updating with update_dict. |
| By default include all predictions.</p></li> |
| <li><p><strong>label_names</strong> (<em>list of str</em><em>, or </em><em>None</em>) – Name of labels that should be used when updating with update_dict. |
| By default include all labels.</p></li> |
| </ul> |
| </dd> |
| </dl> |
| <p><strong>Methods</strong></p> |
| <table class="longtable docutils align-default"> |
| <colgroup> |
| <col style="width: 10%" /> |
| <col style="width: 90%" /> |
| </colgroup> |
| <tbody> |
| <tr class="row-odd"><td><p><a class="reference internal" href="#mxnet.gluon.metric.TopKAccuracy.get" title="mxnet.gluon.metric.TopKAccuracy.get"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get</span></code></a>()</p></td> |
| <td><p>Gets the current evaluation result.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="#mxnet.gluon.metric.TopKAccuracy.get_config" title="mxnet.gluon.metric.TopKAccuracy.get_config"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_config</span></code></a>()</p></td> |
| <td><p>Save configurations of metric.</p></td> |
| </tr> |
| <tr class="row-odd"><td><p><a class="reference internal" href="#mxnet.gluon.metric.TopKAccuracy.get_name_value" title="mxnet.gluon.metric.TopKAccuracy.get_name_value"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_name_value</span></code></a>()</p></td> |
| <td><p>Returns zipped name and value pairs.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="#mxnet.gluon.metric.TopKAccuracy.reset" title="mxnet.gluon.metric.TopKAccuracy.reset"><code class="xref py py-obj docutils literal notranslate"><span class="pre">reset</span></code></a>()</p></td> |
| <td><p>Resets the internal evaluation result to initial state.</p></td> |
| </tr> |
| <tr class="row-odd"><td><p><a class="reference internal" href="#mxnet.gluon.metric.TopKAccuracy.update" title="mxnet.gluon.metric.TopKAccuracy.update"><code class="xref py py-obj docutils literal notranslate"><span class="pre">update</span></code></a>(labels, preds)</p></td> |
| <td><p>Updates the internal evaluation result.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="#mxnet.gluon.metric.TopKAccuracy.update_dict" title="mxnet.gluon.metric.TopKAccuracy.update_dict"><code class="xref py py-obj docutils literal notranslate"><span class="pre">update_dict</span></code></a>(label, pred)</p></td> |
| <td><p>Update the internal evaluation with named label and pred</p></td> |
| </tr> |
| </tbody> |
| </table> |
| <p class="rubric">Examples</p> |
| <div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">np</span><span class="o">.</span><span class="n">random</span><span class="o">.</span><span class="n">seed</span><span class="p">(</span><span class="mi">999</span><span class="p">)</span> |
| <span class="gp">>>> </span><span class="n">top_k</span> <span class="o">=</span> <span class="mi">3</span> |
| <span class="gp">>>> </span><span class="n">labels</span> <span class="o">=</span> <span class="p">[</span><span class="n">mx</span><span class="o">.</span><span class="n">np</span><span class="o">.</span><span class="n">array</span><span class="p">([</span><span class="mi">2</span><span class="p">,</span> <span class="mi">6</span><span class="p">,</span> <span class="mi">9</span><span class="p">,</span> <span class="mi">2</span><span class="p">,</span> <span class="mi">3</span><span class="p">,</span> <span class="mi">4</span><span class="p">,</span> <span class="mi">7</span><span class="p">,</span> <span class="mi">8</span><span class="p">,</span> <span class="mi">9</span><span class="p">,</span> <span class="mi">6</span><span class="p">])]</span> |
| <span class="gp">>>> </span><span class="n">predicts</span> <span class="o">=</span> <span class="p">[</span><span class="n">mx</span><span class="o">.</span><span class="n">np</span><span class="o">.</span><span class="n">array</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">random</span><span class="o">.</span><span class="n">rand</span><span class="p">(</span><span class="mi">10</span><span class="p">,</span> <span class="mi">10</span><span class="p">))]</span> |
| <span class="gp">>>> </span><span class="n">acc</span> <span class="o">=</span> <span class="n">mx</span><span class="o">.</span><span class="n">gluon</span><span class="o">.</span><span class="n">metric</span><span class="o">.</span><span class="n">TopKAccuracy</span><span class="p">(</span><span class="n">top_k</span><span class="o">=</span><span class="n">top_k</span><span class="p">)</span> |
| <span class="gp">>>> </span><span class="n">acc</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="n">labels</span><span class="p">,</span> <span class="n">predicts</span><span class="p">)</span> |
| <span class="gp">>>> </span><span class="n">acc</span><span class="o">.</span><span class="n">get</span><span class="p">()</span> |
| <span class="go">('top_k_accuracy', 0.3)</span> |
| </pre></div> |
| </div> |
| <dl class="method"> |
| <dt id="mxnet.gluon.metric.TopKAccuracy.get"> |
| <code class="sig-name descname">get</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#mxnet.gluon.metric.TopKAccuracy.get" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Gets the current evaluation result.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Returns</dt> |
| <dd class="field-odd"><p><ul class="simple"> |
| <li><p><strong>names</strong> (<em>list of str</em>) – Name of the metrics.</p></li> |
| <li><p><strong>values</strong> (<em>list of float</em>) – Value of the evaluations.</p></li> |
| </ul> |
| </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="mxnet.gluon.metric.TopKAccuracy.get_config"> |
| <code class="sig-name descname">get_config</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#mxnet.gluon.metric.TopKAccuracy.get_config" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Save configurations of metric. Can be recreated |
| from configs with metric.create(<code class="docutils literal notranslate"><span class="pre">**config</span></code>)</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="mxnet.gluon.metric.TopKAccuracy.get_name_value"> |
| <code class="sig-name descname">get_name_value</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#mxnet.gluon.metric.TopKAccuracy.get_name_value" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Returns zipped name and value pairs.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Returns</dt> |
| <dd class="field-odd"><p>A (name, value) tuple list.</p> |
| </dd> |
| <dt class="field-even">Return type</dt> |
| <dd class="field-even"><p>list of tuples</p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="mxnet.gluon.metric.TopKAccuracy.reset"> |
| <code class="sig-name descname">reset</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#mxnet.gluon.metric.TopKAccuracy.reset" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Resets the internal evaluation result to initial state.</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="mxnet.gluon.metric.TopKAccuracy.update"> |
| <code class="sig-name descname">update</code><span class="sig-paren">(</span><em class="sig-param">labels</em>, <em class="sig-param">preds</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/mxnet/gluon/metric.html#TopKAccuracy.update"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#mxnet.gluon.metric.TopKAccuracy.update" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Updates the internal evaluation result.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters</dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>labels</strong> (list of <cite>NDArray</cite>) – The labels of the data.</p></li> |
| <li><p><strong>preds</strong> (list of <cite>NDArray</cite>) – Predicted values.</p></li> |
| </ul> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="mxnet.gluon.metric.TopKAccuracy.update_dict"> |
| <code class="sig-name descname">update_dict</code><span class="sig-paren">(</span><em class="sig-param">label</em>, <em class="sig-param">pred</em><span class="sig-paren">)</span><a class="headerlink" href="#mxnet.gluon.metric.TopKAccuracy.update_dict" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Update the internal evaluation with named label and pred</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters</dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>labels</strong> (<em>OrderedDict of str -> NDArray</em>) – name to array mapping for labels.</p></li> |
| <li><p><strong>preds</strong> (<em>OrderedDict of str -> NDArray</em>) – name to array mapping of predicted outputs.</p></li> |
| </ul> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="class"> |
| <dt id="mxnet.gluon.metric.Torch"> |
| <em class="property">class </em><code class="sig-name descname">Torch</code><span class="sig-paren">(</span><em class="sig-param">name='torch'</em>, <em class="sig-param">output_names=None</em>, <em class="sig-param">label_names=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/mxnet/gluon/metric.html#Torch"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#mxnet.gluon.metric.Torch" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Bases: <a class="reference internal" href="#mxnet.gluon.metric.Loss" title="mxnet.gluon.metric.Loss"><code class="xref py py-class docutils literal notranslate"><span class="pre">mxnet.gluon.metric.Loss</span></code></a></p> |
| <p>Dummy metric for torch criterions.</p> |
| </dd></dl> |
| |
| <dl class="function"> |
| <dt id="mxnet.gluon.metric.check_label_shapes"> |
| <code class="sig-name descname">check_label_shapes</code><span class="sig-paren">(</span><em class="sig-param">labels</em>, <em class="sig-param">preds</em>, <em class="sig-param">wrap=False</em>, <em class="sig-param">shape=False</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/mxnet/gluon/metric.html#check_label_shapes"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#mxnet.gluon.metric.check_label_shapes" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Helper function for checking shape of label and prediction</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters</dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>labels</strong> (list of <cite>NDArray</cite>) – The labels of the data.</p></li> |
| <li><p><strong>preds</strong> (list of <cite>NDArray</cite>) – Predicted values.</p></li> |
| <li><p><strong>wrap</strong> (<em>boolean</em>) – If True, wrap labels/preds in a list if they are single NDArray</p></li> |
| <li><p><strong>shape</strong> (<em>boolean</em>) – If True, check the shape of labels and preds; |
| Otherwise only check their length.</p></li> |
| </ul> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="function"> |
| <dt id="mxnet.gluon.metric.create"> |
| <code class="sig-name descname">create</code><span class="sig-paren">(</span><em class="sig-param">metric</em>, <em class="sig-param">*args</em>, <em class="sig-param">**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/mxnet/gluon/metric.html#create"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#mxnet.gluon.metric.create" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Creates evaluation metric from metric names or instances of EvalMetric |
| or a custom metric function.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters</dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>metric</strong> (<em>str</em><em> or </em><em>callable</em>) – <p>Specifies the metric to create. |
| This argument must be one of the below:</p> |
| <ul> |
| <li><p>Name of a metric.</p></li> |
| <li><p>An instance of <cite>EvalMetric</cite>.</p></li> |
| <li><p>A list, each element of which is a metric or a metric name.</p></li> |
| <li><p>An evaluation function that computes custom metric for a given batch of |
| labels and predictions.</p></li> |
| </ul> |
| </p></li> |
| <li><p><strong>*args</strong> (<em>list</em>) – Additional arguments to metric constructor. |
| Only used when metric is str.</p></li> |
| <li><p><strong>**kwargs</strong> (<em>dict</em>) – Additional arguments to metric constructor. |
| Only used when metric is str</p></li> |
| </ul> |
| </dd> |
| </dl> |
| <p class="rubric">Examples</p> |
| <div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="k">def</span> <span class="nf">custom_metric</span><span class="p">(</span><span class="n">label</span><span class="p">,</span> <span class="n">pred</span><span class="p">):</span> |
| <span class="gp">... </span> <span class="k">return</span> <span class="n">np</span><span class="o">.</span><span class="n">mean</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">abs</span><span class="p">(</span><span class="n">label</span> <span class="o">-</span> <span class="n">pred</span><span class="p">))</span> |
| <span class="gp">...</span> |
| <span class="gp">>>> </span><span class="n">metric1</span> <span class="o">=</span> <span class="n">mx</span><span class="o">.</span><span class="n">gluon</span><span class="o">.</span><span class="n">metric</span><span class="o">.</span><span class="n">create</span><span class="p">(</span><span class="s1">'acc'</span><span class="p">)</span> |
| <span class="gp">>>> </span><span class="n">metric2</span> <span class="o">=</span> <span class="n">mx</span><span class="o">.</span><span class="n">gluon</span><span class="o">.</span><span class="n">metric</span><span class="o">.</span><span class="n">create</span><span class="p">(</span><span class="n">custom_metric</span><span class="p">)</span> |
| <span class="gp">>>> </span><span class="n">metric3</span> <span class="o">=</span> <span class="n">mx</span><span class="o">.</span><span class="n">gluon</span><span class="o">.</span><span class="n">metric</span><span class="o">.</span><span class="n">create</span><span class="p">([</span><span class="n">metric1</span><span class="p">,</span> <span class="n">metric2</span><span class="p">,</span> <span class="s1">'rmse'</span><span class="p">])</span> |
| </pre></div> |
| </div> |
| </dd></dl> |
| |
| <dl class="function"> |
| <dt id="mxnet.gluon.metric.np"> |
| <code class="sig-name descname">np</code><span class="sig-paren">(</span><em class="sig-param">numpy_feval</em>, <em class="sig-param">name=None</em>, <em class="sig-param">allow_extra_outputs=False</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/mxnet/gluon/metric.html#np"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#mxnet.gluon.metric.np" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Creates a custom evaluation metric that receives its inputs as numpy arrays.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters</dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>numpy_feval</strong> (<em>callable</em><em>(</em><em>label</em><em>, </em><em>pred</em><em>)</em>) – Custom evaluation function that receives labels and predictions for a minibatch |
| as numpy arrays and returns the corresponding custom metric as a floating point number.</p></li> |
| <li><p><strong>name</strong> (<em>str</em><em>, </em><em>optional</em>) – Name of the custom metric.</p></li> |
| <li><p><strong>allow_extra_outputs</strong> (<em>bool</em><em>, </em><em>optional</em>) – Whether prediction output is allowed to have extra outputs. This is useful in cases |
| like RNN where states are also part of output which can then be fed back to the RNN |
| in the next step. By default, extra outputs are not allowed.</p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns</dt> |
| <dd class="field-even"><p>Custom metric corresponding to the provided labels and predictions.</p> |
| </dd> |
| <dt class="field-odd">Return type</dt> |
| <dd class="field-odd"><p>float</p> |
| </dd> |
| </dl> |
| <p class="rubric">Example</p> |
| <div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="k">def</span> <span class="nf">custom_metric</span><span class="p">(</span><span class="n">label</span><span class="p">,</span> <span class="n">pred</span><span class="p">):</span> |
| <span class="gp">... </span> <span class="k">return</span> <span class="n">np</span><span class="o">.</span><span class="n">mean</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">abs</span><span class="p">(</span><span class="n">label</span><span class="o">-</span><span class="n">pred</span><span class="p">))</span> |
| <span class="gp">...</span> |
| <span class="gp">>>> </span><span class="n">metric</span> <span class="o">=</span> <span class="n">mx</span><span class="o">.</span><span class="n">gluon</span><span class="o">.</span><span class="n">metric</span><span class="o">.</span><span class="n">np</span><span class="p">(</span><span class="n">custom_metric</span><span class="p">)</span> |
| </pre></div> |
| </div> |
| </dd></dl> |
| |
| <dl class="function"> |
| <dt id="mxnet.gluon.metric.predict_with_threshold"> |
| <code class="sig-name descname">predict_with_threshold</code><span class="sig-paren">(</span><em class="sig-param">pred</em>, <em class="sig-param">threshold=0.5</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/mxnet/gluon/metric.html#predict_with_threshold"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#mxnet.gluon.metric.predict_with_threshold" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Do thresholding of predictions in binary and multilabel cases.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters</dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>preds</strong> (<em>float</em><em> or </em><em>ndarray</em>) – predictions in shape of (batch_size, …) or (batch_size, …, num_categories)</p></li> |
| <li><p><strong>preds</strong> – threshold（s) in shape of float or (num_categories)</p></li> |
| </ul> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| </div> |
| |
| |
| <hr class="feedback-hr-top" /> |
| <div class="feedback-container"> |
| <div class="feedback-question">Did this page help you?</div> |
| <div class="feedback-answer-container"> |
| <div class="feedback-answer yes-link" data-response="yes">Yes</div> |
| <div class="feedback-answer no-link" data-response="no">No</div> |
| </div> |
| <div class="feedback-thank-you">Thanks for your feedback!</div> |
| </div> |
| <hr class="feedback-hr-bottom" /> |
| </div> |
| <div class="side-doc-outline"> |
| <div class="side-doc-outline--content"> |
| </div> |
| </div> |
| |
| <div class="clearer"></div> |
| </div><div class="pagenation"> |
| <a id="button-prev" href="../loss/index.html" class="mdl-button mdl-js-button mdl-js-ripple-effect mdl-button--colored" role="botton" accesskey="P"> |
| <i class="pagenation-arrow-L fas fa-arrow-left fa-lg"></i> |
| <div class="pagenation-text"> |
| <span class="pagenation-direction">Previous</span> |
| <div>gluon.loss</div> |
| </div> |
| </a> |
| <a id="button-next" href="../model_zoo/index.html" class="mdl-button mdl-js-button mdl-js-ripple-effect mdl-button--colored" role="botton" accesskey="N"> |
| <i class="pagenation-arrow-R fas fa-arrow-right fa-lg"></i> |
| <div class="pagenation-text"> |
| <span class="pagenation-direction">Next</span> |
| <div>gluon.model_zoo.vision</div> |
| </div> |
| </a> |
| </div> |
| <footer class="site-footer h-card"> |
| <div class="wrapper"> |
| <div class="row"> |
| <div class="col-4"> |
| <h4 class="footer-category-title">Resources</h4> |
| <ul class="contact-list"> |
| <li><a href="https://lists.apache.org/list.html?dev@mxnet.apache.org">Mailing list</a> <a class="u-email" href="mailto:dev-subscribe@mxnet.apache.org">(subscribe)</a></li> |
| <li><a href="https://discuss.mxnet.io">MXNet Discuss forum</a></li> |
| <li><a href="https://github.com/apache/mxnet/issues">Github Issues</a></li> |
| <li><a href="https://github.com/apache/mxnet/projects">Projects</a></li> |
| <li><a href="https://cwiki.apache.org/confluence/display/MXNET/Apache+MXNet+Home">Developer Wiki</a></li> |
| <li><a href="/community">Contribute To MXNet</a></li> |
| </ul> |
| </div> |
| |
| <div class="col-4"><ul class="social-media-list"><li><a href="https://github.com/apache/mxnet"><svg class="svg-icon"><use xlink:href="../../../_static/minima-social-icons.svg#github"></use></svg> <span class="username">apache/mxnet</span></a></li><li><a href="https://www.twitter.com/apachemxnet"><svg class="svg-icon"><use xlink:href="../../../_static/minima-social-icons.svg#twitter"></use></svg> <span class="username">apachemxnet</span></a></li><li><a href="https://youtube.com/apachemxnet"><svg class="svg-icon"><use xlink:href="../../../_static/minima-social-icons.svg#youtube"></use></svg> <span class="username">apachemxnet</span></a></li></ul> |
| </div> |
| |
| <div class="col-4 footer-text"> |
| <p>A flexible and efficient library for deep learning.</p> |
| </div> |
| </div> |
| </div> |
| </footer> |
| |
| <footer class="site-footer2"> |
| <div class="wrapper"> |
| <div class="row"> |
| <div class="col-3"> |
| <img src="../../../_static/apache_incubator_logo.png" class="footer-logo col-2"> |
| </div> |
| <div class="footer-bottom-warning col-9"> |
| <p>Apache MXNet is an effort undergoing incubation at <a href="http://www.apache.org/">The Apache Software Foundation</a> (ASF), <span style="font-weight:bold">sponsored by the <i>Apache Incubator</i></span>. Incubation is required |
| of all newly accepted projects until a further review indicates that the infrastructure, |
| communications, and decision making process have stabilized in a manner consistent with other |
| successful ASF projects. While incubation status is not necessarily a reflection of the completeness |
| or stability of the code, it does indicate that the project has yet to be fully endorsed by the ASF. |
| </p><p>"Copyright © 2017-2018, The Apache Software Foundation Apache MXNet, MXNet, Apache, the Apache |
| feather, and the Apache MXNet project logo are either registered trademarks or trademarks of the |
| Apache Software Foundation."</p> |
| </div> |
| </div> |
| </div> |
| </footer> |
| |
| </body> |
| </html> |
