blob: 004d6c3c5a8ee8bf8fcdef3c2df18be19c5fac3f [file] [log] [blame]
<!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>mxnet.test_utils &#8212; 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" />
</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">Module code</a><i class="material-icons">navigate_next</i>
<a class="mdl-navigation__link is-active">mxnet.test_utils</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/_modules/mxnet/test_utils" 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>
<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"><a class="reference internal" href="../../api/index.html">Python API</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../../api/np/index.html">mxnet.np</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../../api/np/arrays.html">Array objects</a><ul>
<li class="toctree-l4"><a class="reference internal" href="../../api/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="../../api/np/arrays.indexing.html">Indexing</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="../../api/np/routines.html">Routines</a><ul>
<li class="toctree-l4"><a class="reference internal" href="../../api/np/routines.array-creation.html">Array creation routines</a><ul>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.eye.html">mxnet.np.eye</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.empty.html">mxnet.np.empty</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.full.html">mxnet.np.full</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.identity.html">mxnet.np.identity</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.ones.html">mxnet.np.ones</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.ones_like.html">mxnet.np.ones_like</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.zeros.html">mxnet.np.zeros</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.zeros_like.html">mxnet.np.zeros_like</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.array.html">mxnet.np.array</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.copy.html">mxnet.np.copy</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.arange.html">mxnet.np.arange</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.linspace.html">mxnet.np.linspace</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.logspace.html">mxnet.np.logspace</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.meshgrid.html">mxnet.np.meshgrid</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.tril.html">mxnet.np.tril</a></li>
</ul>
</li>
<li class="toctree-l4"><a class="reference internal" href="../../api/np/routines.array-manipulation.html">Array manipulation routines</a><ul>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.reshape.html">mxnet.np.reshape</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.ravel.html">mxnet.np.ravel</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.ndarray.flatten.html">mxnet.np.ndarray.flatten</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.swapaxes.html">mxnet.np.swapaxes</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.ndarray.T.html">mxnet.np.ndarray.T</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.transpose.html">mxnet.np.transpose</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.moveaxis.html">mxnet.np.moveaxis</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.rollaxis.html">mxnet.np.rollaxis</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.expand_dims.html">mxnet.np.expand_dims</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.squeeze.html">mxnet.np.squeeze</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.broadcast_to.html">mxnet.np.broadcast_to</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.broadcast_arrays.html">mxnet.np.broadcast_arrays</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.atleast_1d.html">mxnet.np.atleast_1d</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.atleast_2d.html">mxnet.np.atleast_2d</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.atleast_3d.html">mxnet.np.atleast_3d</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.concatenate.html">mxnet.np.concatenate</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.stack.html">mxnet.np.stack</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.dstack.html">mxnet.np.dstack</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.vstack.html">mxnet.np.vstack</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.column_stack.html">mxnet.np.column_stack</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.hstack.html">mxnet.np.hstack</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.split.html">mxnet.np.split</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.hsplit.html">mxnet.np.hsplit</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.vsplit.html">mxnet.np.vsplit</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.array_split.html">mxnet.np.array_split</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.dsplit.html">mxnet.np.dsplit</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.tile.html">mxnet.np.tile</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.repeat.html">mxnet.np.repeat</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.unique.html">mxnet.np.unique</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.delete.html">mxnet.np.delete</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.insert.html">mxnet.np.insert</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.append.html">mxnet.np.append</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.resize.html">mxnet.np.resize</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.trim_zeros.html">mxnet.np.trim_zeros</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.reshape.html">mxnet.np.reshape</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.flip.html">mxnet.np.flip</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.roll.html">mxnet.np.roll</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.rot90.html">mxnet.np.rot90</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.fliplr.html">mxnet.np.fliplr</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.flipud.html">mxnet.np.flipud</a></li>
</ul>
</li>
<li class="toctree-l4"><a class="reference internal" href="../../api/np/routines.io.html">Input and output</a><ul>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.genfromtxt.html">mxnet.np.genfromtxt</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.ndarray.tolist.html">mxnet.np.ndarray.tolist</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.set_printoptions.html">mxnet.np.set_printoptions</a></li>
</ul>
</li>
<li class="toctree-l4"><a class="reference internal" href="../../api/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="../../api/np/generated/mxnet.np.dot.html">mxnet.np.dot</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.vdot.html">mxnet.np.vdot</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.inner.html">mxnet.np.inner</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.outer.html">mxnet.np.outer</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.tensordot.html">mxnet.np.tensordot</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.einsum.html">mxnet.np.einsum</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.linalg.multi_dot.html">mxnet.np.linalg.multi_dot</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.matmul.html">mxnet.np.matmul</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.linalg.matrix_power.html">mxnet.np.linalg.matrix_power</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.kron.html">mxnet.np.kron</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.linalg.svd.html">mxnet.np.linalg.svd</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.linalg.cholesky.html">mxnet.np.linalg.cholesky</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.linalg.qr.html">mxnet.np.linalg.qr</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.linalg.eig.html">mxnet.np.linalg.eig</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.linalg.eigh.html">mxnet.np.linalg.eigh</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.linalg.eigvals.html">mxnet.np.linalg.eigvals</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.linalg.eigvalsh.html">mxnet.np.linalg.eigvalsh</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.linalg.norm.html">mxnet.np.linalg.norm</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.trace.html">mxnet.np.trace</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.linalg.cond.html">mxnet.np.linalg.cond</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.linalg.det.html">mxnet.np.linalg.det</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.linalg.matrix_rank.html">mxnet.np.linalg.matrix_rank</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.linalg.slogdet.html">mxnet.np.linalg.slogdet</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.linalg.solve.html">mxnet.np.linalg.solve</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.linalg.tensorsolve.html">mxnet.np.linalg.tensorsolve</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.linalg.lstsq.html">mxnet.np.linalg.lstsq</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.linalg.inv.html">mxnet.np.linalg.inv</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.linalg.pinv.html">mxnet.np.linalg.pinv</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.linalg.tensorinv.html">mxnet.np.linalg.tensorinv</a></li>
</ul>
</li>
<li class="toctree-l4"><a class="reference internal" href="../../api/np/routines.math.html">Mathematical functions</a><ul>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.sin.html">mxnet.np.sin</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.cos.html">mxnet.np.cos</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.tan.html">mxnet.np.tan</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.arcsin.html">mxnet.np.arcsin</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.arccos.html">mxnet.np.arccos</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.arctan.html">mxnet.np.arctan</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.degrees.html">mxnet.np.degrees</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.radians.html">mxnet.np.radians</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.hypot.html">mxnet.np.hypot</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.arctan2.html">mxnet.np.arctan2</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.deg2rad.html">mxnet.np.deg2rad</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.rad2deg.html">mxnet.np.rad2deg</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.unwrap.html">mxnet.np.unwrap</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.sinh.html">mxnet.np.sinh</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.cosh.html">mxnet.np.cosh</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.tanh.html">mxnet.np.tanh</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.arcsinh.html">mxnet.np.arcsinh</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.arccosh.html">mxnet.np.arccosh</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.arctanh.html">mxnet.np.arctanh</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.rint.html">mxnet.np.rint</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.fix.html">mxnet.np.fix</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.floor.html">mxnet.np.floor</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.ceil.html">mxnet.np.ceil</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.trunc.html">mxnet.np.trunc</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.around.html">mxnet.np.around</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.round_.html">mxnet.np.round_</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.sum.html">mxnet.np.sum</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.prod.html">mxnet.np.prod</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.cumsum.html">mxnet.np.cumsum</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.nanprod.html">mxnet.np.nanprod</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.nansum.html">mxnet.np.nansum</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.cumprod.html">mxnet.np.cumprod</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.nancumprod.html">mxnet.np.nancumprod</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.nancumsum.html">mxnet.np.nancumsum</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.diff.html">mxnet.np.diff</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.ediff1d.html">mxnet.np.ediff1d</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.cross.html">mxnet.np.cross</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.trapz.html">mxnet.np.trapz</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.exp.html">mxnet.np.exp</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.expm1.html">mxnet.np.expm1</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.log.html">mxnet.np.log</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.log10.html">mxnet.np.log10</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.log2.html">mxnet.np.log2</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.log1p.html">mxnet.np.log1p</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.logaddexp.html">mxnet.np.logaddexp</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.i0.html">mxnet.np.i0</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.ldexp.html">mxnet.np.ldexp</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.signbit.html">mxnet.np.signbit</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.copysign.html">mxnet.np.copysign</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.frexp.html">mxnet.np.frexp</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.spacing.html">mxnet.np.spacing</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.lcm.html">mxnet.np.lcm</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.gcd.html">mxnet.np.gcd</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.add.html">mxnet.np.add</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.reciprocal.html">mxnet.np.reciprocal</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.negative.html">mxnet.np.negative</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.divide.html">mxnet.np.divide</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.power.html">mxnet.np.power</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.subtract.html">mxnet.np.subtract</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.mod.html">mxnet.np.mod</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.multiply.html">mxnet.np.multiply</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.true_divide.html">mxnet.np.true_divide</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.remainder.html">mxnet.np.remainder</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.positive.html">mxnet.np.positive</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.float_power.html">mxnet.np.float_power</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.fmod.html">mxnet.np.fmod</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.modf.html">mxnet.np.modf</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.divmod.html">mxnet.np.divmod</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.floor_divide.html">mxnet.np.floor_divide</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.clip.html">mxnet.np.clip</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.sqrt.html">mxnet.np.sqrt</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.cbrt.html">mxnet.np.cbrt</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.square.html">mxnet.np.square</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.absolute.html">mxnet.np.absolute</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.sign.html">mxnet.np.sign</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.maximum.html">mxnet.np.maximum</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.minimum.html">mxnet.np.minimum</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.fabs.html">mxnet.np.fabs</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.heaviside.html">mxnet.np.heaviside</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.fmax.html">mxnet.np.fmax</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.fmin.html">mxnet.np.fmin</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.nan_to_num.html">mxnet.np.nan_to_num</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.interp.html">mxnet.np.interp</a></li>
</ul>
</li>
<li class="toctree-l4"><a class="reference internal" href="../../api/np/random/index.html">np.random</a><ul>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/random/generated/mxnet.np.random.choice.html">mxnet.np.random.choice</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/random/generated/mxnet.np.random.shuffle.html">mxnet.np.random.shuffle</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/random/generated/mxnet.np.random.normal.html">mxnet.np.random.normal</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/random/generated/mxnet.np.random.uniform.html">mxnet.np.random.uniform</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/random/generated/mxnet.np.random.rand.html">mxnet.np.random.rand</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/random/generated/mxnet.np.random.randint.html">mxnet.np.random.randint</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/random/generated/mxnet.np.random.beta.html">mxnet.np.random.beta</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/random/generated/mxnet.np.random.chisquare.html">mxnet.np.random.chisquare</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/random/generated/mxnet.np.random.exponential.html">mxnet.np.random.exponential</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/random/generated/mxnet.np.random.f.html">mxnet.np.random.f</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/random/generated/mxnet.np.random.gamma.html">mxnet.np.random.gamma</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/random/generated/mxnet.np.random.gumbel.html">mxnet.np.random.gumbel</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/random/generated/mxnet.np.random.laplace.html">mxnet.np.random.laplace</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/random/generated/mxnet.np.random.logistic.html">mxnet.np.random.logistic</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/random/generated/mxnet.np.random.lognormal.html">mxnet.np.random.lognormal</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/random/generated/mxnet.np.random.multinomial.html">mxnet.np.random.multinomial</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/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="../../api/np/random/generated/mxnet.np.random.pareto.html">mxnet.np.random.pareto</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/random/generated/mxnet.np.random.power.html">mxnet.np.random.power</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/random/generated/mxnet.np.random.rayleigh.html">mxnet.np.random.rayleigh</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/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="../../api/np/routines.sort.html">Sorting, searching, and counting</a><ul>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.ndarray.sort.html">mxnet.np.ndarray.sort</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.sort.html">mxnet.np.sort</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.lexsort.html">mxnet.np.lexsort</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.argsort.html">mxnet.np.argsort</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.msort.html">mxnet.np.msort</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.partition.html">mxnet.np.partition</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.argpartition.html">mxnet.np.argpartition</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.argmax.html">mxnet.np.argmax</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.argmin.html">mxnet.np.argmin</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.nanargmax.html">mxnet.np.nanargmax</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.nanargmin.html">mxnet.np.nanargmin</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.argwhere.html">mxnet.np.argwhere</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.nonzero.html">mxnet.np.nonzero</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.flatnonzero.html">mxnet.np.flatnonzero</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.where.html">mxnet.np.where</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.searchsorted.html">mxnet.np.searchsorted</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.extract.html">mxnet.np.extract</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.count_nonzero.html">mxnet.np.count_nonzero</a></li>
</ul>
</li>
<li class="toctree-l4"><a class="reference internal" href="../../api/np/routines.statistics.html">Statistics</a><ul>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.min.html">mxnet.np.min</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.max.html">mxnet.np.max</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.amin.html">mxnet.np.amin</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.amax.html">mxnet.np.amax</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.nanmin.html">mxnet.np.nanmin</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.nanmax.html">mxnet.np.nanmax</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.ptp.html">mxnet.np.ptp</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.percentile.html">mxnet.np.percentile</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.nanpercentile.html">mxnet.np.nanpercentile</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.quantile.html">mxnet.np.quantile</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.nanquantile.html">mxnet.np.nanquantile</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.mean.html">mxnet.np.mean</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.std.html">mxnet.np.std</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.var.html">mxnet.np.var</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.median.html">mxnet.np.median</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.average.html">mxnet.np.average</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.nanmedian.html">mxnet.np.nanmedian</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.nanstd.html">mxnet.np.nanstd</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.nanvar.html">mxnet.np.nanvar</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.corrcoef.html">mxnet.np.corrcoef</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.correlate.html">mxnet.np.correlate</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.cov.html">mxnet.np.cov</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.histogram.html">mxnet.np.histogram</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.histogram2d.html">mxnet.np.histogram2d</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.histogramdd.html">mxnet.np.histogramdd</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.bincount.html">mxnet.np.bincount</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.histogram_bin_edges.html">mxnet.np.histogram_bin_edges</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/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="../../api/npx/index.html">NPX: NumPy Neural Network Extension</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../../api/npx/generated/mxnet.npx.set_np.html">mxnet.npx.set_np</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../api/npx/generated/mxnet.npx.reset_np.html">mxnet.npx.reset_np</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../api/npx/generated/mxnet.npx.cpu.html">mxnet.npx.cpu</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../api/npx/generated/mxnet.npx.cpu_pinned.html">mxnet.npx.cpu_pinned</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../api/npx/generated/mxnet.npx.gpu.html">mxnet.npx.gpu</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../api/npx/generated/mxnet.npx.gpu_memory_info.html">mxnet.npx.gpu_memory_info</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../api/npx/generated/mxnet.npx.current_device.html">mxnet.npx.current_device</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../api/npx/generated/mxnet.npx.num_gpus.html">mxnet.npx.num_gpus</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../api/npx/generated/mxnet.npx.activation.html">mxnet.npx.activation</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../api/npx/generated/mxnet.npx.batch_norm.html">mxnet.npx.batch_norm</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../api/npx/generated/mxnet.npx.convolution.html">mxnet.npx.convolution</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../api/npx/generated/mxnet.npx.dropout.html">mxnet.npx.dropout</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../api/npx/generated/mxnet.npx.embedding.html">mxnet.npx.embedding</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../api/npx/generated/mxnet.npx.fully_connected.html">mxnet.npx.fully_connected</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../api/npx/generated/mxnet.npx.layer_norm.html">mxnet.npx.layer_norm</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../api/npx/generated/mxnet.npx.pooling.html">mxnet.npx.pooling</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../api/npx/generated/mxnet.npx.rnn.html">mxnet.npx.rnn</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../api/npx/generated/mxnet.npx.leaky_relu.html">mxnet.npx.leaky_relu</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../api/npx/generated/mxnet.npx.multibox_detection.html">mxnet.npx.multibox_detection</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../api/npx/generated/mxnet.npx.multibox_prior.html">mxnet.npx.multibox_prior</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../api/npx/generated/mxnet.npx.multibox_target.html">mxnet.npx.multibox_target</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../api/npx/generated/mxnet.npx.roi_pooling.html">mxnet.npx.roi_pooling</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../api/npx/generated/mxnet.npx.sigmoid.html">mxnet.npx.sigmoid</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../api/npx/generated/mxnet.npx.relu.html">mxnet.npx.relu</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../api/npx/generated/mxnet.npx.smooth_l1.html">mxnet.npx.smooth_l1</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../api/npx/generated/mxnet.npx.softmax.html">mxnet.npx.softmax</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../api/npx/generated/mxnet.npx.log_softmax.html">mxnet.npx.log_softmax</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../api/npx/generated/mxnet.npx.topk.html">mxnet.npx.topk</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../api/npx/generated/mxnet.npx.waitall.html">mxnet.npx.waitall</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../api/npx/generated/mxnet.npx.load.html">mxnet.npx.load</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../api/npx/generated/mxnet.npx.save.html">mxnet.npx.save</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../api/npx/generated/mxnet.npx.one_hot.html">mxnet.npx.one_hot</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../api/npx/generated/mxnet.npx.pick.html">mxnet.npx.pick</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../api/npx/generated/mxnet.npx.reshape_like.html">mxnet.npx.reshape_like</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../api/npx/generated/mxnet.npx.batch_flatten.html">mxnet.npx.batch_flatten</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../api/npx/generated/mxnet.npx.batch_dot.html">mxnet.npx.batch_dot</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../api/npx/generated/mxnet.npx.gamma.html">mxnet.npx.gamma</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../api/npx/generated/mxnet.npx.sequence_mask.html">mxnet.npx.sequence_mask</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../../api/gluon/index.html">mxnet.gluon</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../../api/gluon/block.html">gluon.Block</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../api/gluon/hybrid_block.html">gluon.HybridBlock</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../api/gluon/symbol_block.html">gluon.SymbolBlock</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../api/gluon/constant.html">gluon.Constant</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../api/gluon/parameter.html">gluon.Parameter</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../api/gluon/trainer.html">gluon.Trainer</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../api/gluon/contrib/index.html">gluon.contrib</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../api/gluon/data/index.html">gluon.data</a><ul>
<li class="toctree-l4"><a class="reference internal" href="../../api/gluon/data/vision/index.html">data.vision</a><ul>
<li class="toctree-l5"><a class="reference internal" href="../../api/gluon/data/vision/datasets/index.html">vision.datasets</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/gluon/data/vision/transforms/index.html">vision.transforms</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="../../api/gluon/loss/index.html">gluon.loss</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../api/gluon/metric/index.html">gluon.metric</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../api/gluon/model_zoo/index.html">gluon.model_zoo.vision</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../api/gluon/nn/index.html">gluon.nn</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../api/gluon/rnn/index.html">gluon.rnn</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../api/gluon/utils/index.html">gluon.utils</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../../api/autograd/index.html">mxnet.autograd</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../api/initializer/index.html">mxnet.initializer</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../api/optimizer/index.html">mxnet.optimizer</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../api/lr_scheduler/index.html">mxnet.lr_scheduler</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../api/kvstore/index.html">KVStore: Communication for Distributed Training</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../api/kvstore/index.html#horovod">Horovod</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../../api/kvstore/generated/mxnet.kvstore.Horovod.html">mxnet.kvstore.Horovod</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../../api/kvstore/index.html#byteps">BytePS</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../../api/kvstore/generated/mxnet.kvstore.BytePS.html">mxnet.kvstore.BytePS</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../../api/kvstore/index.html#kvstore-interface">KVStore Interface</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../../api/kvstore/generated/mxnet.kvstore.KVStore.html">mxnet.kvstore.KVStore</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../api/kvstore/generated/mxnet.kvstore.KVStoreBase.html">mxnet.kvstore.KVStoreBase</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../api/kvstore/generated/mxnet.kvstore.KVStoreServer.html">mxnet.kvstore.KVStoreServer</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../../api/contrib/index.html">mxnet.contrib</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../../api/contrib/io/index.html">contrib.io</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../api/contrib/ndarray/index.html">contrib.ndarray</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../api/contrib/onnx/index.html">contrib.onnx</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../api/contrib/quantization/index.html">contrib.quantization</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../api/contrib/symbol/index.html">contrib.symbol</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../api/contrib/tensorboard/index.html">contrib.tensorboard</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../api/contrib/tensorrt/index.html">contrib.tensorrt</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../api/contrib/text/index.html">contrib.text</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../../api/legacy/index.html">Legacy</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../../api/legacy/callback/index.html">mxnet.callback</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../api/legacy/image/index.html">mxnet.image</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../api/legacy/io/index.html">mxnet.io</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../api/legacy/ndarray/index.html">mxnet.ndarray</a><ul>
<li class="toctree-l4"><a class="reference internal" href="../../api/legacy/ndarray/ndarray.html">ndarray</a></li>
<li class="toctree-l4"><a class="reference internal" href="../../api/legacy/ndarray/contrib/index.html">ndarray.contrib</a></li>
<li class="toctree-l4"><a class="reference internal" href="../../api/legacy/ndarray/image/index.html">ndarray.image</a></li>
<li class="toctree-l4"><a class="reference internal" href="../../api/legacy/ndarray/linalg/index.html">ndarray.linalg</a></li>
<li class="toctree-l4"><a class="reference internal" href="../../api/legacy/ndarray/op/index.html">ndarray.op</a></li>
<li class="toctree-l4"><a class="reference internal" href="../../api/legacy/ndarray/random/index.html">ndarray.random</a></li>
<li class="toctree-l4"><a class="reference internal" href="../../api/legacy/ndarray/register/index.html">ndarray.register</a></li>
<li class="toctree-l4"><a class="reference internal" href="../../api/legacy/ndarray/sparse/index.html">ndarray.sparse</a></li>
<li class="toctree-l4"><a class="reference internal" href="../../api/legacy/ndarray/utils/index.html">ndarray.utils</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="../../api/legacy/recordio/index.html">mxnet.recordio</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../api/legacy/symbol/index.html">mxnet.symbol</a><ul>
<li class="toctree-l4"><a class="reference internal" href="../../api/legacy/symbol/symbol.html">symbol</a></li>
<li class="toctree-l4"><a class="reference internal" href="../../api/legacy/symbol/contrib/index.html">symbol.contrib</a></li>
<li class="toctree-l4"><a class="reference internal" href="../../api/legacy/symbol/image/index.html">symbol.image</a></li>
<li class="toctree-l4"><a class="reference internal" href="../../api/legacy/symbol/linalg/index.html">symbol.linalg</a></li>
<li class="toctree-l4"><a class="reference internal" href="../../api/legacy/symbol/op/index.html">symbol.op</a></li>
<li class="toctree-l4"><a class="reference internal" href="../../api/legacy/symbol/random/index.html">symbol.random</a></li>
<li class="toctree-l4"><a class="reference internal" href="../../api/legacy/symbol/register/index.html">symbol.register</a></li>
<li class="toctree-l4"><a class="reference internal" href="../../api/legacy/symbol/sparse/index.html">symbol.sparse</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="../../api/legacy/visualization/index.html">mxnet.visualization</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../../api/device/index.html">mxnet.device</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../api/engine/index.html">mxnet.engine</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../api/executor/index.html">mxnet.executor</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../api/kvstore_server/index.html">mxnet.kvstore_server</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../api/profiler/index.html">mxnet.profiler</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../api/rtc/index.html">mxnet.rtc</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../api/runtime/index.html">mxnet.runtime</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../../api/runtime/generated/mxnet.runtime.Feature.html">mxnet.runtime.Feature</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../api/runtime/generated/mxnet.runtime.Features.html">mxnet.runtime.Features</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../api/runtime/generated/mxnet.runtime.feature_list.html">mxnet.runtime.feature_list</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../../api/test_utils/index.html">mxnet.test_utils</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../api/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>
<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"><a class="reference internal" href="../../api/index.html">Python API</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../../api/np/index.html">mxnet.np</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../../api/np/arrays.html">Array objects</a><ul>
<li class="toctree-l4"><a class="reference internal" href="../../api/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="../../api/np/arrays.indexing.html">Indexing</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="../../api/np/routines.html">Routines</a><ul>
<li class="toctree-l4"><a class="reference internal" href="../../api/np/routines.array-creation.html">Array creation routines</a><ul>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.eye.html">mxnet.np.eye</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.empty.html">mxnet.np.empty</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.full.html">mxnet.np.full</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.identity.html">mxnet.np.identity</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.ones.html">mxnet.np.ones</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.ones_like.html">mxnet.np.ones_like</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.zeros.html">mxnet.np.zeros</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.zeros_like.html">mxnet.np.zeros_like</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.array.html">mxnet.np.array</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.copy.html">mxnet.np.copy</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.arange.html">mxnet.np.arange</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.linspace.html">mxnet.np.linspace</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.logspace.html">mxnet.np.logspace</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.meshgrid.html">mxnet.np.meshgrid</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.tril.html">mxnet.np.tril</a></li>
</ul>
</li>
<li class="toctree-l4"><a class="reference internal" href="../../api/np/routines.array-manipulation.html">Array manipulation routines</a><ul>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.reshape.html">mxnet.np.reshape</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.ravel.html">mxnet.np.ravel</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.ndarray.flatten.html">mxnet.np.ndarray.flatten</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.swapaxes.html">mxnet.np.swapaxes</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.ndarray.T.html">mxnet.np.ndarray.T</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.transpose.html">mxnet.np.transpose</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.moveaxis.html">mxnet.np.moveaxis</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.rollaxis.html">mxnet.np.rollaxis</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.expand_dims.html">mxnet.np.expand_dims</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.squeeze.html">mxnet.np.squeeze</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.broadcast_to.html">mxnet.np.broadcast_to</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.broadcast_arrays.html">mxnet.np.broadcast_arrays</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.atleast_1d.html">mxnet.np.atleast_1d</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.atleast_2d.html">mxnet.np.atleast_2d</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.atleast_3d.html">mxnet.np.atleast_3d</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.concatenate.html">mxnet.np.concatenate</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.stack.html">mxnet.np.stack</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.dstack.html">mxnet.np.dstack</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.vstack.html">mxnet.np.vstack</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.column_stack.html">mxnet.np.column_stack</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.hstack.html">mxnet.np.hstack</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.split.html">mxnet.np.split</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.hsplit.html">mxnet.np.hsplit</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.vsplit.html">mxnet.np.vsplit</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.array_split.html">mxnet.np.array_split</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.dsplit.html">mxnet.np.dsplit</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.tile.html">mxnet.np.tile</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.repeat.html">mxnet.np.repeat</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.unique.html">mxnet.np.unique</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.delete.html">mxnet.np.delete</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.insert.html">mxnet.np.insert</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.append.html">mxnet.np.append</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.resize.html">mxnet.np.resize</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.trim_zeros.html">mxnet.np.trim_zeros</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.reshape.html">mxnet.np.reshape</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.flip.html">mxnet.np.flip</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.roll.html">mxnet.np.roll</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.rot90.html">mxnet.np.rot90</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.fliplr.html">mxnet.np.fliplr</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.flipud.html">mxnet.np.flipud</a></li>
</ul>
</li>
<li class="toctree-l4"><a class="reference internal" href="../../api/np/routines.io.html">Input and output</a><ul>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.genfromtxt.html">mxnet.np.genfromtxt</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.ndarray.tolist.html">mxnet.np.ndarray.tolist</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.set_printoptions.html">mxnet.np.set_printoptions</a></li>
</ul>
</li>
<li class="toctree-l4"><a class="reference internal" href="../../api/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="../../api/np/generated/mxnet.np.dot.html">mxnet.np.dot</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.vdot.html">mxnet.np.vdot</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.inner.html">mxnet.np.inner</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.outer.html">mxnet.np.outer</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.tensordot.html">mxnet.np.tensordot</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.einsum.html">mxnet.np.einsum</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.linalg.multi_dot.html">mxnet.np.linalg.multi_dot</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.matmul.html">mxnet.np.matmul</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.linalg.matrix_power.html">mxnet.np.linalg.matrix_power</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.kron.html">mxnet.np.kron</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.linalg.svd.html">mxnet.np.linalg.svd</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.linalg.cholesky.html">mxnet.np.linalg.cholesky</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.linalg.qr.html">mxnet.np.linalg.qr</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.linalg.eig.html">mxnet.np.linalg.eig</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.linalg.eigh.html">mxnet.np.linalg.eigh</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.linalg.eigvals.html">mxnet.np.linalg.eigvals</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.linalg.eigvalsh.html">mxnet.np.linalg.eigvalsh</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.linalg.norm.html">mxnet.np.linalg.norm</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.trace.html">mxnet.np.trace</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.linalg.cond.html">mxnet.np.linalg.cond</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.linalg.det.html">mxnet.np.linalg.det</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.linalg.matrix_rank.html">mxnet.np.linalg.matrix_rank</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.linalg.slogdet.html">mxnet.np.linalg.slogdet</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.linalg.solve.html">mxnet.np.linalg.solve</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.linalg.tensorsolve.html">mxnet.np.linalg.tensorsolve</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.linalg.lstsq.html">mxnet.np.linalg.lstsq</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.linalg.inv.html">mxnet.np.linalg.inv</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.linalg.pinv.html">mxnet.np.linalg.pinv</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.linalg.tensorinv.html">mxnet.np.linalg.tensorinv</a></li>
</ul>
</li>
<li class="toctree-l4"><a class="reference internal" href="../../api/np/routines.math.html">Mathematical functions</a><ul>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.sin.html">mxnet.np.sin</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.cos.html">mxnet.np.cos</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.tan.html">mxnet.np.tan</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.arcsin.html">mxnet.np.arcsin</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.arccos.html">mxnet.np.arccos</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.arctan.html">mxnet.np.arctan</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.degrees.html">mxnet.np.degrees</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.radians.html">mxnet.np.radians</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.hypot.html">mxnet.np.hypot</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.arctan2.html">mxnet.np.arctan2</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.deg2rad.html">mxnet.np.deg2rad</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.rad2deg.html">mxnet.np.rad2deg</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.unwrap.html">mxnet.np.unwrap</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.sinh.html">mxnet.np.sinh</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.cosh.html">mxnet.np.cosh</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.tanh.html">mxnet.np.tanh</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.arcsinh.html">mxnet.np.arcsinh</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.arccosh.html">mxnet.np.arccosh</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.arctanh.html">mxnet.np.arctanh</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.rint.html">mxnet.np.rint</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.fix.html">mxnet.np.fix</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.floor.html">mxnet.np.floor</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.ceil.html">mxnet.np.ceil</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.trunc.html">mxnet.np.trunc</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.around.html">mxnet.np.around</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.round_.html">mxnet.np.round_</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.sum.html">mxnet.np.sum</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.prod.html">mxnet.np.prod</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.cumsum.html">mxnet.np.cumsum</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.nanprod.html">mxnet.np.nanprod</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.nansum.html">mxnet.np.nansum</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.cumprod.html">mxnet.np.cumprod</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.nancumprod.html">mxnet.np.nancumprod</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.nancumsum.html">mxnet.np.nancumsum</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.diff.html">mxnet.np.diff</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.ediff1d.html">mxnet.np.ediff1d</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.cross.html">mxnet.np.cross</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.trapz.html">mxnet.np.trapz</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.exp.html">mxnet.np.exp</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.expm1.html">mxnet.np.expm1</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.log.html">mxnet.np.log</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.log10.html">mxnet.np.log10</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.log2.html">mxnet.np.log2</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.log1p.html">mxnet.np.log1p</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.logaddexp.html">mxnet.np.logaddexp</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.i0.html">mxnet.np.i0</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.ldexp.html">mxnet.np.ldexp</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.signbit.html">mxnet.np.signbit</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.copysign.html">mxnet.np.copysign</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.frexp.html">mxnet.np.frexp</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.spacing.html">mxnet.np.spacing</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.lcm.html">mxnet.np.lcm</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.gcd.html">mxnet.np.gcd</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.add.html">mxnet.np.add</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.reciprocal.html">mxnet.np.reciprocal</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.negative.html">mxnet.np.negative</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.divide.html">mxnet.np.divide</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.power.html">mxnet.np.power</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.subtract.html">mxnet.np.subtract</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.mod.html">mxnet.np.mod</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.multiply.html">mxnet.np.multiply</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.true_divide.html">mxnet.np.true_divide</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.remainder.html">mxnet.np.remainder</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.positive.html">mxnet.np.positive</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.float_power.html">mxnet.np.float_power</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.fmod.html">mxnet.np.fmod</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.modf.html">mxnet.np.modf</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.divmod.html">mxnet.np.divmod</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.floor_divide.html">mxnet.np.floor_divide</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.clip.html">mxnet.np.clip</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.sqrt.html">mxnet.np.sqrt</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.cbrt.html">mxnet.np.cbrt</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.square.html">mxnet.np.square</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.absolute.html">mxnet.np.absolute</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.sign.html">mxnet.np.sign</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.maximum.html">mxnet.np.maximum</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.minimum.html">mxnet.np.minimum</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.fabs.html">mxnet.np.fabs</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.heaviside.html">mxnet.np.heaviside</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.fmax.html">mxnet.np.fmax</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.fmin.html">mxnet.np.fmin</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.nan_to_num.html">mxnet.np.nan_to_num</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.interp.html">mxnet.np.interp</a></li>
</ul>
</li>
<li class="toctree-l4"><a class="reference internal" href="../../api/np/random/index.html">np.random</a><ul>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/random/generated/mxnet.np.random.choice.html">mxnet.np.random.choice</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/random/generated/mxnet.np.random.shuffle.html">mxnet.np.random.shuffle</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/random/generated/mxnet.np.random.normal.html">mxnet.np.random.normal</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/random/generated/mxnet.np.random.uniform.html">mxnet.np.random.uniform</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/random/generated/mxnet.np.random.rand.html">mxnet.np.random.rand</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/random/generated/mxnet.np.random.randint.html">mxnet.np.random.randint</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/random/generated/mxnet.np.random.beta.html">mxnet.np.random.beta</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/random/generated/mxnet.np.random.chisquare.html">mxnet.np.random.chisquare</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/random/generated/mxnet.np.random.exponential.html">mxnet.np.random.exponential</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/random/generated/mxnet.np.random.f.html">mxnet.np.random.f</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/random/generated/mxnet.np.random.gamma.html">mxnet.np.random.gamma</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/random/generated/mxnet.np.random.gumbel.html">mxnet.np.random.gumbel</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/random/generated/mxnet.np.random.laplace.html">mxnet.np.random.laplace</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/random/generated/mxnet.np.random.logistic.html">mxnet.np.random.logistic</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/random/generated/mxnet.np.random.lognormal.html">mxnet.np.random.lognormal</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/random/generated/mxnet.np.random.multinomial.html">mxnet.np.random.multinomial</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/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="../../api/np/random/generated/mxnet.np.random.pareto.html">mxnet.np.random.pareto</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/random/generated/mxnet.np.random.power.html">mxnet.np.random.power</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/random/generated/mxnet.np.random.rayleigh.html">mxnet.np.random.rayleigh</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/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="../../api/np/routines.sort.html">Sorting, searching, and counting</a><ul>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.ndarray.sort.html">mxnet.np.ndarray.sort</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.sort.html">mxnet.np.sort</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.lexsort.html">mxnet.np.lexsort</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.argsort.html">mxnet.np.argsort</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.msort.html">mxnet.np.msort</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.partition.html">mxnet.np.partition</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.argpartition.html">mxnet.np.argpartition</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.argmax.html">mxnet.np.argmax</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.argmin.html">mxnet.np.argmin</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.nanargmax.html">mxnet.np.nanargmax</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.nanargmin.html">mxnet.np.nanargmin</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.argwhere.html">mxnet.np.argwhere</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.nonzero.html">mxnet.np.nonzero</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.flatnonzero.html">mxnet.np.flatnonzero</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.where.html">mxnet.np.where</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.searchsorted.html">mxnet.np.searchsorted</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.extract.html">mxnet.np.extract</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.count_nonzero.html">mxnet.np.count_nonzero</a></li>
</ul>
</li>
<li class="toctree-l4"><a class="reference internal" href="../../api/np/routines.statistics.html">Statistics</a><ul>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.min.html">mxnet.np.min</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.max.html">mxnet.np.max</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.amin.html">mxnet.np.amin</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.amax.html">mxnet.np.amax</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.nanmin.html">mxnet.np.nanmin</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.nanmax.html">mxnet.np.nanmax</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.ptp.html">mxnet.np.ptp</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.percentile.html">mxnet.np.percentile</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.nanpercentile.html">mxnet.np.nanpercentile</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.quantile.html">mxnet.np.quantile</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.nanquantile.html">mxnet.np.nanquantile</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.mean.html">mxnet.np.mean</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.std.html">mxnet.np.std</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.var.html">mxnet.np.var</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.median.html">mxnet.np.median</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.average.html">mxnet.np.average</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.nanmedian.html">mxnet.np.nanmedian</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.nanstd.html">mxnet.np.nanstd</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.nanvar.html">mxnet.np.nanvar</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.corrcoef.html">mxnet.np.corrcoef</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.correlate.html">mxnet.np.correlate</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.cov.html">mxnet.np.cov</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.histogram.html">mxnet.np.histogram</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.histogram2d.html">mxnet.np.histogram2d</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.histogramdd.html">mxnet.np.histogramdd</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.bincount.html">mxnet.np.bincount</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/np/generated/mxnet.np.histogram_bin_edges.html">mxnet.np.histogram_bin_edges</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/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="../../api/npx/index.html">NPX: NumPy Neural Network Extension</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../../api/npx/generated/mxnet.npx.set_np.html">mxnet.npx.set_np</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../api/npx/generated/mxnet.npx.reset_np.html">mxnet.npx.reset_np</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../api/npx/generated/mxnet.npx.cpu.html">mxnet.npx.cpu</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../api/npx/generated/mxnet.npx.cpu_pinned.html">mxnet.npx.cpu_pinned</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../api/npx/generated/mxnet.npx.gpu.html">mxnet.npx.gpu</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../api/npx/generated/mxnet.npx.gpu_memory_info.html">mxnet.npx.gpu_memory_info</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../api/npx/generated/mxnet.npx.current_device.html">mxnet.npx.current_device</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../api/npx/generated/mxnet.npx.num_gpus.html">mxnet.npx.num_gpus</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../api/npx/generated/mxnet.npx.activation.html">mxnet.npx.activation</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../api/npx/generated/mxnet.npx.batch_norm.html">mxnet.npx.batch_norm</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../api/npx/generated/mxnet.npx.convolution.html">mxnet.npx.convolution</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../api/npx/generated/mxnet.npx.dropout.html">mxnet.npx.dropout</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../api/npx/generated/mxnet.npx.embedding.html">mxnet.npx.embedding</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../api/npx/generated/mxnet.npx.fully_connected.html">mxnet.npx.fully_connected</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../api/npx/generated/mxnet.npx.layer_norm.html">mxnet.npx.layer_norm</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../api/npx/generated/mxnet.npx.pooling.html">mxnet.npx.pooling</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../api/npx/generated/mxnet.npx.rnn.html">mxnet.npx.rnn</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../api/npx/generated/mxnet.npx.leaky_relu.html">mxnet.npx.leaky_relu</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../api/npx/generated/mxnet.npx.multibox_detection.html">mxnet.npx.multibox_detection</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../api/npx/generated/mxnet.npx.multibox_prior.html">mxnet.npx.multibox_prior</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../api/npx/generated/mxnet.npx.multibox_target.html">mxnet.npx.multibox_target</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../api/npx/generated/mxnet.npx.roi_pooling.html">mxnet.npx.roi_pooling</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../api/npx/generated/mxnet.npx.sigmoid.html">mxnet.npx.sigmoid</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../api/npx/generated/mxnet.npx.relu.html">mxnet.npx.relu</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../api/npx/generated/mxnet.npx.smooth_l1.html">mxnet.npx.smooth_l1</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../api/npx/generated/mxnet.npx.softmax.html">mxnet.npx.softmax</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../api/npx/generated/mxnet.npx.log_softmax.html">mxnet.npx.log_softmax</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../api/npx/generated/mxnet.npx.topk.html">mxnet.npx.topk</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../api/npx/generated/mxnet.npx.waitall.html">mxnet.npx.waitall</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../api/npx/generated/mxnet.npx.load.html">mxnet.npx.load</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../api/npx/generated/mxnet.npx.save.html">mxnet.npx.save</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../api/npx/generated/mxnet.npx.one_hot.html">mxnet.npx.one_hot</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../api/npx/generated/mxnet.npx.pick.html">mxnet.npx.pick</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../api/npx/generated/mxnet.npx.reshape_like.html">mxnet.npx.reshape_like</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../api/npx/generated/mxnet.npx.batch_flatten.html">mxnet.npx.batch_flatten</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../api/npx/generated/mxnet.npx.batch_dot.html">mxnet.npx.batch_dot</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../api/npx/generated/mxnet.npx.gamma.html">mxnet.npx.gamma</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../api/npx/generated/mxnet.npx.sequence_mask.html">mxnet.npx.sequence_mask</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../../api/gluon/index.html">mxnet.gluon</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../../api/gluon/block.html">gluon.Block</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../api/gluon/hybrid_block.html">gluon.HybridBlock</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../api/gluon/symbol_block.html">gluon.SymbolBlock</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../api/gluon/constant.html">gluon.Constant</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../api/gluon/parameter.html">gluon.Parameter</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../api/gluon/trainer.html">gluon.Trainer</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../api/gluon/contrib/index.html">gluon.contrib</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../api/gluon/data/index.html">gluon.data</a><ul>
<li class="toctree-l4"><a class="reference internal" href="../../api/gluon/data/vision/index.html">data.vision</a><ul>
<li class="toctree-l5"><a class="reference internal" href="../../api/gluon/data/vision/datasets/index.html">vision.datasets</a></li>
<li class="toctree-l5"><a class="reference internal" href="../../api/gluon/data/vision/transforms/index.html">vision.transforms</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="../../api/gluon/loss/index.html">gluon.loss</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../api/gluon/metric/index.html">gluon.metric</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../api/gluon/model_zoo/index.html">gluon.model_zoo.vision</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../api/gluon/nn/index.html">gluon.nn</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../api/gluon/rnn/index.html">gluon.rnn</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../api/gluon/utils/index.html">gluon.utils</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../../api/autograd/index.html">mxnet.autograd</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../api/initializer/index.html">mxnet.initializer</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../api/optimizer/index.html">mxnet.optimizer</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../api/lr_scheduler/index.html">mxnet.lr_scheduler</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../api/kvstore/index.html">KVStore: Communication for Distributed Training</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../api/kvstore/index.html#horovod">Horovod</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../../api/kvstore/generated/mxnet.kvstore.Horovod.html">mxnet.kvstore.Horovod</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../../api/kvstore/index.html#byteps">BytePS</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../../api/kvstore/generated/mxnet.kvstore.BytePS.html">mxnet.kvstore.BytePS</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../../api/kvstore/index.html#kvstore-interface">KVStore Interface</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../../api/kvstore/generated/mxnet.kvstore.KVStore.html">mxnet.kvstore.KVStore</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../api/kvstore/generated/mxnet.kvstore.KVStoreBase.html">mxnet.kvstore.KVStoreBase</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../api/kvstore/generated/mxnet.kvstore.KVStoreServer.html">mxnet.kvstore.KVStoreServer</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../../api/contrib/index.html">mxnet.contrib</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../../api/contrib/io/index.html">contrib.io</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../api/contrib/ndarray/index.html">contrib.ndarray</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../api/contrib/onnx/index.html">contrib.onnx</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../api/contrib/quantization/index.html">contrib.quantization</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../api/contrib/symbol/index.html">contrib.symbol</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../api/contrib/tensorboard/index.html">contrib.tensorboard</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../api/contrib/tensorrt/index.html">contrib.tensorrt</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../api/contrib/text/index.html">contrib.text</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../../api/legacy/index.html">Legacy</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../../api/legacy/callback/index.html">mxnet.callback</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../api/legacy/image/index.html">mxnet.image</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../api/legacy/io/index.html">mxnet.io</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../api/legacy/ndarray/index.html">mxnet.ndarray</a><ul>
<li class="toctree-l4"><a class="reference internal" href="../../api/legacy/ndarray/ndarray.html">ndarray</a></li>
<li class="toctree-l4"><a class="reference internal" href="../../api/legacy/ndarray/contrib/index.html">ndarray.contrib</a></li>
<li class="toctree-l4"><a class="reference internal" href="../../api/legacy/ndarray/image/index.html">ndarray.image</a></li>
<li class="toctree-l4"><a class="reference internal" href="../../api/legacy/ndarray/linalg/index.html">ndarray.linalg</a></li>
<li class="toctree-l4"><a class="reference internal" href="../../api/legacy/ndarray/op/index.html">ndarray.op</a></li>
<li class="toctree-l4"><a class="reference internal" href="../../api/legacy/ndarray/random/index.html">ndarray.random</a></li>
<li class="toctree-l4"><a class="reference internal" href="../../api/legacy/ndarray/register/index.html">ndarray.register</a></li>
<li class="toctree-l4"><a class="reference internal" href="../../api/legacy/ndarray/sparse/index.html">ndarray.sparse</a></li>
<li class="toctree-l4"><a class="reference internal" href="../../api/legacy/ndarray/utils/index.html">ndarray.utils</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="../../api/legacy/recordio/index.html">mxnet.recordio</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../api/legacy/symbol/index.html">mxnet.symbol</a><ul>
<li class="toctree-l4"><a class="reference internal" href="../../api/legacy/symbol/symbol.html">symbol</a></li>
<li class="toctree-l4"><a class="reference internal" href="../../api/legacy/symbol/contrib/index.html">symbol.contrib</a></li>
<li class="toctree-l4"><a class="reference internal" href="../../api/legacy/symbol/image/index.html">symbol.image</a></li>
<li class="toctree-l4"><a class="reference internal" href="../../api/legacy/symbol/linalg/index.html">symbol.linalg</a></li>
<li class="toctree-l4"><a class="reference internal" href="../../api/legacy/symbol/op/index.html">symbol.op</a></li>
<li class="toctree-l4"><a class="reference internal" href="../../api/legacy/symbol/random/index.html">symbol.random</a></li>
<li class="toctree-l4"><a class="reference internal" href="../../api/legacy/symbol/register/index.html">symbol.register</a></li>
<li class="toctree-l4"><a class="reference internal" href="../../api/legacy/symbol/sparse/index.html">symbol.sparse</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="../../api/legacy/visualization/index.html">mxnet.visualization</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../../api/device/index.html">mxnet.device</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../api/engine/index.html">mxnet.engine</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../api/executor/index.html">mxnet.executor</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../api/kvstore_server/index.html">mxnet.kvstore_server</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../api/profiler/index.html">mxnet.profiler</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../api/rtc/index.html">mxnet.rtc</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../api/runtime/index.html">mxnet.runtime</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../../api/runtime/generated/mxnet.runtime.Feature.html">mxnet.runtime.Feature</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../api/runtime/generated/mxnet.runtime.Features.html">mxnet.runtime.Features</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../api/runtime/generated/mxnet.runtime.feature_list.html">mxnet.runtime.feature_list</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../../api/test_utils/index.html">mxnet.test_utils</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../api/util/index.html">mxnet.util</a></li>
</ul>
</li>
</ul>
</nav>
</div>
</header>
<div class="document">
<div class="page-content" role="main">
<h1>Source code for mxnet.test_utils</h1><div class="highlight"><pre>
<span></span><span class="c1"># Licensed to the Apache Software Foundation (ASF) under one</span>
<span class="c1"># or more contributor license agreements. See the NOTICE file</span>
<span class="c1"># distributed with this work for additional information</span>
<span class="c1"># regarding copyright ownership. The ASF licenses this file</span>
<span class="c1"># to you under the Apache License, Version 2.0 (the</span>
<span class="c1"># &quot;License&quot;); you may not use this file except in compliance</span>
<span class="c1"># with the License. You may obtain a copy of the License at</span>
<span class="c1">#</span>
<span class="c1"># http://www.apache.org/licenses/LICENSE-2.0</span>
<span class="c1">#</span>
<span class="c1"># Unless required by applicable law or agreed to in writing,</span>
<span class="c1"># software distributed under the License is distributed on an</span>
<span class="c1"># &quot;AS IS&quot; BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</span>
<span class="c1"># KIND, either express or implied. See the License for the</span>
<span class="c1"># specific language governing permissions and limitations</span>
<span class="c1"># under the License.</span>
<span class="sd">&quot;&quot;&quot;Tools for testing.&quot;&quot;&quot;</span>
<span class="c1"># pylint: disable=too-many-lines</span>
<span class="kn">import</span> <span class="nn">time</span>
<span class="kn">import</span> <span class="nn">gzip</span>
<span class="kn">import</span> <span class="nn">struct</span>
<span class="kn">import</span> <span class="nn">traceback</span>
<span class="kn">import</span> <span class="nn">numbers</span>
<span class="kn">import</span> <span class="nn">sys</span>
<span class="kn">import</span> <span class="nn">os</span>
<span class="kn">import</span> <span class="nn">platform</span>
<span class="kn">import</span> <span class="nn">errno</span>
<span class="kn">import</span> <span class="nn">logging</span>
<span class="kn">import</span> <span class="nn">bz2</span>
<span class="kn">import</span> <span class="nn">zipfile</span>
<span class="kn">import</span> <span class="nn">json</span>
<span class="kn">from</span> <span class="nn">contextlib</span> <span class="kn">import</span> <span class="n">contextmanager</span>
<span class="kn">from</span> <span class="nn">collections</span> <span class="kn">import</span> <span class="n">OrderedDict</span>
<span class="kn">import</span> <span class="nn">numpy</span> <span class="k">as</span> <span class="nn">np</span>
<span class="kn">import</span> <span class="nn">numpy.testing</span> <span class="k">as</span> <span class="nn">npt</span>
<span class="kn">import</span> <span class="nn">numpy.random</span> <span class="k">as</span> <span class="nn">rnd</span>
<span class="k">try</span><span class="p">:</span>
<span class="kn">import</span> <span class="nn">scipy.stats</span> <span class="k">as</span> <span class="nn">ss</span>
<span class="k">except</span> <span class="ne">ImportError</span><span class="p">:</span>
<span class="n">ss</span> <span class="o">=</span> <span class="kc">None</span>
<span class="k">try</span><span class="p">:</span>
<span class="kn">import</span> <span class="nn">requests</span>
<span class="k">except</span> <span class="ne">ImportError</span><span class="p">:</span>
<span class="c1"># in rare cases requests may be not installed</span>
<span class="k">pass</span>
<span class="kn">import</span> <span class="nn">mxnet</span> <span class="k">as</span> <span class="nn">mx</span>
<span class="kn">from</span> <span class="nn">.device</span> <span class="kn">import</span> <span class="n">current_device</span>
<span class="kn">from</span> <span class="nn">.ndarray.ndarray</span> <span class="kn">import</span> <span class="n">_STORAGE_TYPE_STR_TO_ID</span><span class="p">,</span> <span class="n">get_dtype_name</span>
<span class="kn">from</span> <span class="nn">.symbol</span> <span class="kn">import</span> <span class="n">Symbol</span>
<span class="kn">from</span> <span class="nn">.symbol.numpy</span> <span class="kn">import</span> <span class="n">_Symbol</span> <span class="k">as</span> <span class="n">np_symbol</span>
<span class="kn">from</span> <span class="nn">.util</span> <span class="kn">import</span> <span class="n">use_np</span><span class="p">,</span> <span class="n">use_np_default_dtype</span><span class="p">,</span> <span class="n">getenv</span><span class="p">,</span> <span class="n">setenv</span> <span class="c1"># pylint: disable=unused-import</span>
<span class="kn">from</span> <span class="nn">.util</span> <span class="kn">import</span> <span class="n">get_max_supported_compute_capability</span><span class="p">,</span> <span class="n">get_rtc_compile_opts</span> <span class="c1"># pylint: disable=unused-import</span>
<span class="kn">from</span> <span class="nn">.runtime</span> <span class="kn">import</span> <span class="n">Features</span>
<span class="kn">from</span> <span class="nn">.numpy_extension</span> <span class="kn">import</span> <span class="n">get_cuda_compute_capability</span>
<div class="viewcode-block" id="default_device"><a class="viewcode-back" href="../../api/test_utils/index.html#mxnet.test_utils.default_device">[docs]</a><span class="k">def</span> <span class="nf">default_device</span><span class="p">():</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Get default device for regression test.&quot;&quot;&quot;</span>
<span class="c1"># _TODO: get device from environment variable to support</span>
<span class="c1"># testing with GPUs</span>
<span class="k">return</span> <span class="n">current_device</span><span class="p">()</span></div>
<div class="viewcode-block" id="set_default_device"><a class="viewcode-back" href="../../api/test_utils/index.html#mxnet.test_utils.set_default_device">[docs]</a><span class="k">def</span> <span class="nf">set_default_device</span><span class="p">(</span><span class="n">device</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Set default device.&quot;&quot;&quot;</span>
<span class="n">mx</span><span class="o">.</span><span class="n">device</span><span class="o">.</span><span class="n">_current</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="n">device</span><span class="p">)</span></div>
<div class="viewcode-block" id="default_dtype"><a class="viewcode-back" href="../../api/test_utils/index.html#mxnet.test_utils.default_dtype">[docs]</a><span class="k">def</span> <span class="nf">default_dtype</span><span class="p">():</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Get default data type for regression test.&quot;&quot;&quot;</span>
<span class="c1"># _TODO: get default dtype from environment variable</span>
<span class="k">return</span> <span class="n">np</span><span class="o">.</span><span class="n">float32</span></div>
<div class="viewcode-block" id="default_rtols"><a class="viewcode-back" href="../../api/test_utils/index.html#mxnet.test_utils.default_rtols">[docs]</a><span class="k">def</span> <span class="nf">default_rtols</span><span class="p">():</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Get default relative tolerances for data comparisons involving each data type.&quot;&quot;&quot;</span>
<span class="k">return</span> <span class="p">{</span><span class="n">np</span><span class="o">.</span><span class="n">dtype</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">float16</span><span class="p">):</span> <span class="mf">1e-2</span><span class="p">,</span>
<span class="n">np</span><span class="o">.</span><span class="n">dtype</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">float32</span><span class="p">):</span> <span class="mf">1e-4</span><span class="p">,</span>
<span class="n">np</span><span class="o">.</span><span class="n">dtype</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">float64</span><span class="p">):</span> <span class="mf">1e-5</span><span class="p">,</span>
<span class="n">np</span><span class="o">.</span><span class="n">dtype</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">bool</span><span class="p">):</span> <span class="mi">0</span><span class="p">,</span>
<span class="n">np</span><span class="o">.</span><span class="n">dtype</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">int8</span><span class="p">):</span> <span class="mi">0</span><span class="p">,</span>
<span class="n">np</span><span class="o">.</span><span class="n">dtype</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">uint8</span><span class="p">):</span> <span class="mi">0</span><span class="p">,</span>
<span class="n">np</span><span class="o">.</span><span class="n">dtype</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">int32</span><span class="p">):</span> <span class="mi">0</span><span class="p">,</span>
<span class="n">np</span><span class="o">.</span><span class="n">dtype</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">uint32</span><span class="p">):</span> <span class="mi">0</span><span class="p">,</span>
<span class="n">np</span><span class="o">.</span><span class="n">dtype</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">int64</span><span class="p">):</span> <span class="mi">0</span><span class="p">,</span>
<span class="n">np</span><span class="o">.</span><span class="n">dtype</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">uint64</span><span class="p">):</span> <span class="mi">0</span><span class="p">}</span></div>
<div class="viewcode-block" id="default_atols"><a class="viewcode-back" href="../../api/test_utils/index.html#mxnet.test_utils.default_atols">[docs]</a><span class="k">def</span> <span class="nf">default_atols</span><span class="p">():</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Get default absolute tolerances for data comparisons involving each data type.&quot;&quot;&quot;</span>
<span class="k">return</span> <span class="p">{</span><span class="n">np</span><span class="o">.</span><span class="n">dtype</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">float16</span><span class="p">):</span> <span class="mf">1e-1</span><span class="p">,</span>
<span class="n">np</span><span class="o">.</span><span class="n">dtype</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">float32</span><span class="p">):</span> <span class="mf">1e-3</span><span class="p">,</span>
<span class="n">np</span><span class="o">.</span><span class="n">dtype</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">float64</span><span class="p">):</span> <span class="mf">1e-20</span><span class="p">,</span>
<span class="n">np</span><span class="o">.</span><span class="n">dtype</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">bool</span><span class="p">):</span> <span class="mi">0</span><span class="p">,</span>
<span class="n">np</span><span class="o">.</span><span class="n">dtype</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">int8</span><span class="p">):</span> <span class="mi">0</span><span class="p">,</span>
<span class="n">np</span><span class="o">.</span><span class="n">dtype</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">uint8</span><span class="p">):</span> <span class="mi">0</span><span class="p">,</span>
<span class="n">np</span><span class="o">.</span><span class="n">dtype</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">int32</span><span class="p">):</span> <span class="mi">0</span><span class="p">,</span>
<span class="n">np</span><span class="o">.</span><span class="n">dtype</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">uint32</span><span class="p">):</span> <span class="mi">0</span><span class="p">,</span>
<span class="n">np</span><span class="o">.</span><span class="n">dtype</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">int64</span><span class="p">):</span> <span class="mi">0</span><span class="p">,</span>
<span class="n">np</span><span class="o">.</span><span class="n">dtype</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">uint64</span><span class="p">):</span> <span class="mi">0</span><span class="p">}</span></div>
<div class="viewcode-block" id="default_numeric_eps"><a class="viewcode-back" href="../../api/test_utils/index.html#mxnet.test_utils.default_numeric_eps">[docs]</a><span class="k">def</span> <span class="nf">default_numeric_eps</span><span class="p">():</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Get default epsilon for finite difference gradient calculations with data type.&quot;&quot;&quot;</span>
<span class="c1"># prefer a power-of-two eps, since no bits are dropped when serving as an input delta</span>
<span class="k">return</span> <span class="p">{</span><span class="n">np</span><span class="o">.</span><span class="n">dtype</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">float16</span><span class="p">):</span> <span class="mf">1.0</span> <span class="o">/</span> <span class="mi">2</span><span class="o">**</span><span class="mi">6</span><span class="p">,</span>
<span class="n">np</span><span class="o">.</span><span class="n">dtype</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">float32</span><span class="p">):</span> <span class="mf">1.0</span> <span class="o">/</span> <span class="mi">2</span><span class="o">**</span><span class="mi">9</span><span class="p">,</span>
<span class="n">np</span><span class="o">.</span><span class="n">dtype</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">float64</span><span class="p">):</span> <span class="mf">1.0</span> <span class="o">/</span> <span class="mi">2</span><span class="o">**</span><span class="mi">14</span><span class="p">}</span></div>
<div class="viewcode-block" id="effective_dtype"><a class="viewcode-back" href="../../api/test_utils/index.html#mxnet.test_utils.effective_dtype">[docs]</a><span class="k">def</span> <span class="nf">effective_dtype</span><span class="p">(</span><span class="n">dat</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot; Return the most appropriate dtype for determining the tolerance used in dat comparisons</span>
<span class="sd"> Parameters</span>
<span class="sd"> ----------</span>
<span class="sd"> dat : np.ndarray or mx.nd.array or mx.np.ndarray</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="c1"># On arch 80 gpus or later, a float32-io gemm or conv op will trim the mantissa of</span>
<span class="c1"># data inputs to be of comparable precision to a float16, so float16 becomes the</span>
<span class="c1"># &#39;effective dtype&#39; for tolerance tests involving such op outputs.</span>
<span class="c1"># Is TF32 enabled in the device (the default on arch 80 GPUs)</span>
<span class="k">def</span> <span class="nf">is_TF32_enabled</span><span class="p">(</span><span class="n">device</span><span class="p">):</span>
<span class="k">try</span><span class="p">:</span>
<span class="k">return</span> <span class="p">(</span><span class="n">device</span><span class="o">.</span><span class="n">device_type</span> <span class="o">==</span> <span class="s1">&#39;gpu&#39;</span> <span class="ow">and</span>
<span class="n">get_cuda_compute_capability</span><span class="p">(</span><span class="n">device</span><span class="p">)</span> <span class="o">&gt;=</span> <span class="mi">80</span> <span class="ow">and</span>
<span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;NVIDIA_TF32_OVERRIDE&#39;</span><span class="p">)</span> <span class="o">!=</span> <span class="s1">&#39;0&#39;</span><span class="p">)</span>
<span class="k">except</span><span class="p">:</span> <span class="c1"># pylint: disable=bare-except</span>
<span class="k">return</span> <span class="kc">False</span>
<span class="n">device</span> <span class="o">=</span> <span class="n">dat</span><span class="o">.</span><span class="n">device</span> <span class="k">if</span> <span class="nb">hasattr</span><span class="p">(</span><span class="n">dat</span><span class="p">,</span> <span class="s1">&#39;device&#39;</span><span class="p">)</span> <span class="k">else</span> <span class="kc">None</span>
<span class="n">dtype</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">dtype</span><span class="p">(</span><span class="n">dat</span><span class="o">.</span><span class="n">dtype</span><span class="p">)</span>
<span class="k">if</span> <span class="n">dtype</span> <span class="o">==</span> <span class="n">np</span><span class="o">.</span><span class="n">dtype</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">float32</span><span class="p">)</span> <span class="ow">and</span> <span class="n">is_TF32_enabled</span><span class="p">(</span><span class="n">device</span><span class="p">):</span>
<span class="k">return</span> <span class="n">np</span><span class="o">.</span><span class="n">dtype</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">float16</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">return</span> <span class="n">dtype</span></div>
<div class="viewcode-block" id="get_tolerance"><a class="viewcode-back" href="../../api/test_utils/index.html#mxnet.test_utils.get_tolerance">[docs]</a><span class="k">def</span> <span class="nf">get_tolerance</span><span class="p">(</span><span class="n">dat</span><span class="p">,</span> <span class="n">tol</span><span class="p">,</span> <span class="n">default_tol</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot; Return the tolerance to be used for dat comparisons based on the given tol, datatype and device.</span>
<span class="sd"> Parameters</span>
<span class="sd"> ----------</span>
<span class="sd"> dat : np.ndarray or mx.nd.array or mx.np.ndarray</span>
<span class="sd"> tol : float, or a dict of dtype-&gt;float</span>
<span class="sd"> default_tol : default dict of dtype-&gt;float for all types</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">tol</span><span class="p">,</span> <span class="n">numbers</span><span class="o">.</span><span class="n">Number</span><span class="p">):</span>
<span class="k">return</span> <span class="n">tol</span>
<span class="c1"># If the caller has supplied a tol dict, use that if it has an entry for dtype,</span>
<span class="c1"># else use the supplied default tol dict.</span>
<span class="n">dtype</span> <span class="o">=</span> <span class="n">effective_dtype</span><span class="p">(</span><span class="n">dat</span><span class="p">)</span>
<span class="n">tol</span> <span class="o">=</span> <span class="p">{}</span> <span class="k">if</span> <span class="n">tol</span> <span class="ow">is</span> <span class="kc">None</span> <span class="k">else</span> <span class="n">tol</span>
<span class="k">return</span> <span class="n">tol</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">dtype</span><span class="p">,</span> <span class="n">default_tol</span><span class="p">[</span><span class="n">dtype</span><span class="p">])</span></div>
<div class="viewcode-block" id="get_tols"><a class="viewcode-back" href="../../api/test_utils/index.html#mxnet.test_utils.get_tols">[docs]</a><span class="k">def</span> <span class="nf">get_tols</span><span class="p">(</span><span class="n">x</span><span class="p">,</span> <span class="n">y</span><span class="p">,</span> <span class="n">rtol</span><span class="p">,</span> <span class="n">atol</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;For comparing two datasets &#39;x&#39; and &#39;y&#39;, what relative and absolute tolerances should be used.&quot;&quot;&quot;</span>
<span class="c1"># Tolerance analysis needs &#39;dtype&#39; of &#39;x&#39; and &#39;y&#39;, so convert numbers to numpy scalars as needed</span>
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">x</span><span class="p">,</span> <span class="n">numbers</span><span class="o">.</span><span class="n">Number</span><span class="p">):</span>
<span class="n">x</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">x</span><span class="p">)</span>
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">y</span><span class="p">,</span> <span class="n">numbers</span><span class="o">.</span><span class="n">Number</span><span class="p">):</span>
<span class="n">y</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">y</span><span class="p">)</span>
<span class="c1"># If tols are not specified, use the largest default tol for &#39;x&#39; and &#39;y&#39; based on their ctx and dtype.</span>
<span class="n">rtol</span> <span class="o">=</span> <span class="nb">max</span><span class="p">(</span><span class="n">get_tolerance</span><span class="p">(</span><span class="n">x</span><span class="p">,</span> <span class="n">rtol</span><span class="p">,</span> <span class="n">default_rtols</span><span class="p">()),</span>
<span class="n">get_tolerance</span><span class="p">(</span><span class="n">y</span><span class="p">,</span> <span class="n">rtol</span><span class="p">,</span> <span class="n">default_rtols</span><span class="p">()))</span>
<span class="n">atol</span> <span class="o">=</span> <span class="nb">max</span><span class="p">(</span><span class="n">get_tolerance</span><span class="p">(</span><span class="n">x</span><span class="p">,</span> <span class="n">atol</span><span class="p">,</span> <span class="n">default_atols</span><span class="p">()),</span>
<span class="n">get_tolerance</span><span class="p">(</span><span class="n">y</span><span class="p">,</span> <span class="n">atol</span><span class="p">,</span> <span class="n">default_atols</span><span class="p">()))</span>
<span class="k">return</span> <span class="n">rtol</span><span class="p">,</span> <span class="n">atol</span></div>
<div class="viewcode-block" id="get_atol"><a class="viewcode-back" href="../../api/test_utils/index.html#mxnet.test_utils.get_atol">[docs]</a><span class="k">def</span> <span class="nf">get_atol</span><span class="p">(</span><span class="n">atol</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">dtype</span><span class="o">=</span><span class="n">np</span><span class="o">.</span><span class="n">dtype</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">float64</span><span class="p">)):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Get default numerical threshold for regression test.&quot;&quot;&quot;</span>
<span class="k">return</span> <span class="n">default_atols</span><span class="p">()[</span><span class="n">dtype</span><span class="p">]</span> <span class="k">if</span> <span class="n">atol</span> <span class="ow">is</span> <span class="kc">None</span> <span class="k">else</span> <span class="n">atol</span></div>
<div class="viewcode-block" id="get_rtol"><a class="viewcode-back" href="../../api/test_utils/index.html#mxnet.test_utils.get_rtol">[docs]</a><span class="k">def</span> <span class="nf">get_rtol</span><span class="p">(</span><span class="n">rtol</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">dtype</span><span class="o">=</span><span class="n">np</span><span class="o">.</span><span class="n">dtype</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">float64</span><span class="p">)):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Get default numerical threshold for regression test.&quot;&quot;&quot;</span>
<span class="k">return</span> <span class="n">default_rtols</span><span class="p">()[</span><span class="n">dtype</span><span class="p">]</span> <span class="k">if</span> <span class="n">rtol</span> <span class="ow">is</span> <span class="kc">None</span> <span class="k">else</span> <span class="n">rtol</span></div>
<div class="viewcode-block" id="get_etol"><a class="viewcode-back" href="../../api/test_utils/index.html#mxnet.test_utils.get_etol">[docs]</a><span class="k">def</span> <span class="nf">get_etol</span><span class="p">(</span><span class="n">etol</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Get default numerical threshold for regression test.&quot;&quot;&quot;</span>
<span class="c1"># _TODO: get from env variable, different threshold might</span>
<span class="c1"># be needed for different device and dtype</span>
<span class="k">return</span> <span class="mi">0</span> <span class="k">if</span> <span class="n">etol</span> <span class="ow">is</span> <span class="kc">None</span> <span class="k">else</span> <span class="n">etol</span></div>
<div class="viewcode-block" id="random_arrays"><a class="viewcode-back" href="../../api/test_utils/index.html#mxnet.test_utils.random_arrays">[docs]</a><span class="k">def</span> <span class="nf">random_arrays</span><span class="p">(</span><span class="o">*</span><span class="n">shapes</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Generate some random numpy arrays.&quot;&quot;&quot;</span>
<span class="n">arrays</span> <span class="o">=</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="n">np</span><span class="o">.</span><span class="n">random</span><span class="o">.</span><span class="n">randn</span><span class="p">(),</span> <span class="n">dtype</span><span class="o">=</span><span class="n">default_dtype</span><span class="p">())</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">s</span><span class="p">)</span> <span class="o">==</span> <span class="mi">0</span> <span class="k">else</span> <span class="n">np</span><span class="o">.</span><span class="n">random</span><span class="o">.</span><span class="n">randn</span><span class="p">(</span><span class="o">*</span><span class="n">s</span><span class="p">)</span><span class="o">.</span><span class="n">astype</span><span class="p">(</span><span class="n">default_dtype</span><span class="p">())</span>
<span class="k">for</span> <span class="n">s</span> <span class="ow">in</span> <span class="n">shapes</span><span class="p">]</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">arrays</span><span class="p">)</span> <span class="o">==</span> <span class="mi">1</span><span class="p">:</span>
<span class="k">return</span> <span class="n">arrays</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
<span class="k">return</span> <span class="n">arrays</span></div>
<div class="viewcode-block" id="random_uniform_arrays"><a class="viewcode-back" href="../../api/test_utils/index.html#mxnet.test_utils.random_uniform_arrays">[docs]</a><span class="k">def</span> <span class="nf">random_uniform_arrays</span><span class="p">(</span><span class="o">*</span><span class="n">shapes</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Generate some random numpy arrays.&quot;&quot;&quot;</span>
<span class="n">low</span> <span class="o">=</span> <span class="n">kwargs</span><span class="o">.</span><span class="n">pop</span><span class="p">(</span><span class="s1">&#39;low&#39;</span><span class="p">,</span> <span class="mf">0.0</span><span class="p">)</span>
<span class="n">high</span> <span class="o">=</span> <span class="n">kwargs</span><span class="o">.</span><span class="n">pop</span><span class="p">(</span><span class="s1">&#39;high&#39;</span><span class="p">,</span> <span class="mf">1.0</span><span class="p">)</span>
<span class="n">dtype</span> <span class="o">=</span> <span class="n">kwargs</span><span class="o">.</span><span class="n">pop</span><span class="p">(</span><span class="s1">&#39;dtype&#39;</span><span class="p">,</span> <span class="n">default_dtype</span><span class="p">())</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">kwargs</span><span class="p">)</span> <span class="o">&gt;</span> <span class="mi">0</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">TypeError</span><span class="p">(</span><span class="s1">&#39;Got unexpected argument/s : &#39;</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">kwargs</span><span class="o">.</span><span class="n">keys</span><span class="p">()))</span>
<span class="n">arrays</span> <span class="o">=</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">uniform</span><span class="p">(</span><span class="n">low</span><span class="p">,</span> <span class="n">high</span><span class="p">,</span> <span class="n">size</span><span class="o">=</span><span class="n">s</span><span class="p">)</span><span class="o">.</span><span class="n">astype</span><span class="p">(</span><span class="n">dtype</span><span class="p">)</span>
<span class="k">for</span> <span class="n">s</span> <span class="ow">in</span> <span class="n">shapes</span><span class="p">]</span>
<span class="k">return</span> <span class="n">arrays</span></div>
<div class="viewcode-block" id="random_sample"><a class="viewcode-back" href="../../api/test_utils/index.html#mxnet.test_utils.random_sample">[docs]</a><span class="k">def</span> <span class="nf">random_sample</span><span class="p">(</span><span class="n">population</span><span class="p">,</span> <span class="n">k</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Return a k length list of the elements chosen from the population sequence.&quot;&quot;&quot;</span>
<span class="k">assert</span> <span class="mi">0</span> <span class="o">&lt;=</span> <span class="n">k</span> <span class="o">&lt;=</span> <span class="nb">len</span><span class="p">(</span><span class="n">population</span><span class="p">)</span>
<span class="n">population_copy</span> <span class="o">=</span> <span class="n">population</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">shuffle</span><span class="p">(</span><span class="n">population_copy</span><span class="p">)</span>
<span class="k">return</span> <span class="n">population_copy</span><span class="p">[</span><span class="mi">0</span><span class="p">:</span><span class="n">k</span><span class="p">]</span></div>
<span class="k">def</span> <span class="nf">_sorted_items</span><span class="p">(</span><span class="n">d</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Return (key, value) pairs of dict &#39;d&#39; in a deterministic order (sorted by key).&quot;&quot;&quot;</span>
<span class="k">return</span> <span class="nb">sorted</span><span class="p">(</span><span class="n">d</span><span class="o">.</span><span class="n">items</span><span class="p">(),</span> <span class="n">key</span><span class="o">=</span><span class="k">lambda</span> <span class="n">t</span><span class="p">:</span> <span class="n">t</span><span class="p">[</span><span class="mi">0</span><span class="p">])</span>
<span class="k">def</span> <span class="nf">_sorted_dict</span><span class="p">(</span><span class="n">d</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Return ordered dictionary containing items ordered by their keys.&quot;&quot;&quot;</span>
<span class="k">return</span> <span class="n">OrderedDict</span><span class="p">(</span><span class="n">_sorted_items</span><span class="p">(</span><span class="n">d</span><span class="p">))</span>
<span class="k">def</span> <span class="nf">_validate_csr_generation_inputs</span><span class="p">(</span><span class="n">num_rows</span><span class="p">,</span> <span class="n">num_cols</span><span class="p">,</span> <span class="n">density</span><span class="p">,</span>
<span class="n">distribution</span><span class="o">=</span><span class="s2">&quot;uniform&quot;</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Validates inputs for csr generation helper functions</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">total_nnz</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span><span class="n">num_rows</span> <span class="o">*</span> <span class="n">num_cols</span> <span class="o">*</span> <span class="n">density</span><span class="p">)</span>
<span class="k">if</span> <span class="n">density</span> <span class="o">&lt;</span> <span class="mi">0</span> <span class="ow">or</span> <span class="n">density</span> <span class="o">&gt;</span> <span class="mi">1</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s2">&quot;density has to be between 0 and 1&quot;</span><span class="p">)</span>
<span class="k">if</span> <span class="n">num_rows</span> <span class="o">&lt;=</span> <span class="mi">0</span> <span class="ow">or</span> <span class="n">num_cols</span> <span class="o">&lt;=</span> <span class="mi">0</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s2">&quot;num_rows or num_cols should be greater than 0&quot;</span><span class="p">)</span>
<span class="k">if</span> <span class="n">distribution</span> <span class="o">==</span> <span class="s2">&quot;powerlaw&quot;</span><span class="p">:</span>
<span class="k">if</span> <span class="n">total_nnz</span> <span class="o">&lt;</span> <span class="mi">2</span> <span class="o">*</span> <span class="n">num_rows</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;not supported for this density: </span><span class="si">{</span><span class="n">density</span><span class="si">}</span><span class="s2">&quot;</span>
<span class="sa">f</span><span class="s2">&quot; for this shape (</span><span class="si">{</span><span class="n">num_rows</span><span class="si">}</span><span class="s2">, </span><span class="si">{</span><span class="n">num_cols</span><span class="si">}</span><span class="s2">)&quot;</span>
<span class="s2">&quot; Please keep :&quot;</span>
<span class="s2">&quot; num_rows * num_cols * density &gt;= 2 * num_rows&quot;</span><span class="p">)</span>
<div class="viewcode-block" id="shuffle_csr_column_indices"><a class="viewcode-back" href="../../api/test_utils/index.html#mxnet.test_utils.shuffle_csr_column_indices">[docs]</a><span class="k">def</span> <span class="nf">shuffle_csr_column_indices</span><span class="p">(</span><span class="n">csr</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Shuffle CSR column indices per row</span>
<span class="sd"> This allows validation of unordered column indices, which is not a requirement</span>
<span class="sd"> for a valid CSR matrix</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">row_count</span> <span class="o">=</span> <span class="nb">len</span><span class="p">(</span><span class="n">csr</span><span class="o">.</span><span class="n">indptr</span><span class="p">)</span> <span class="o">-</span> <span class="mi">1</span>
<span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="n">row_count</span><span class="p">):</span>
<span class="n">start_index</span> <span class="o">=</span> <span class="n">csr</span><span class="o">.</span><span class="n">indptr</span><span class="p">[</span><span class="n">i</span><span class="p">]</span>
<span class="n">end_index</span> <span class="o">=</span> <span class="n">csr</span><span class="o">.</span><span class="n">indptr</span><span class="p">[</span><span class="n">i</span> <span class="o">+</span> <span class="mi">1</span><span class="p">]</span>
<span class="n">sublist</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">csr</span><span class="o">.</span><span class="n">indices</span><span class="p">[</span><span class="n">start_index</span> <span class="p">:</span> <span class="n">end_index</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">shuffle</span><span class="p">(</span><span class="n">sublist</span><span class="p">)</span>
<span class="n">csr</span><span class="o">.</span><span class="n">indices</span><span class="p">[</span><span class="n">start_index</span> <span class="p">:</span> <span class="n">end_index</span><span class="p">]</span> <span class="o">=</span> <span class="n">sublist</span></div>
<span class="k">def</span> <span class="nf">_get_uniform_dataset_csr</span><span class="p">(</span><span class="n">num_rows</span><span class="p">,</span> <span class="n">num_cols</span><span class="p">,</span> <span class="n">density</span><span class="o">=</span><span class="mf">0.1</span><span class="p">,</span> <span class="n">dtype</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
<span class="n">data_init</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">shuffle_csr_indices</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Returns CSRNDArray with uniform distribution</span>
<span class="sd"> This generates a csr matrix with totalnnz unique randomly chosen numbers</span>
<span class="sd"> from num_rows*num_cols and arranges them in the 2d array in the</span>
<span class="sd"> following way:</span>
<span class="sd"> row_index = (random_number_generated / num_rows)</span>
<span class="sd"> col_index = random_number_generated - row_index * num_cols</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">_validate_csr_generation_inputs</span><span class="p">(</span><span class="n">num_rows</span><span class="p">,</span> <span class="n">num_cols</span><span class="p">,</span> <span class="n">density</span><span class="p">,</span>
<span class="n">distribution</span><span class="o">=</span><span class="s2">&quot;uniform&quot;</span><span class="p">)</span>
<span class="k">try</span><span class="p">:</span>
<span class="kn">from</span> <span class="nn">scipy</span> <span class="kn">import</span> <span class="n">sparse</span> <span class="k">as</span> <span class="n">spsp</span>
<span class="n">csr</span> <span class="o">=</span> <span class="n">spsp</span><span class="o">.</span><span class="n">rand</span><span class="p">(</span><span class="n">num_rows</span><span class="p">,</span> <span class="n">num_cols</span><span class="p">,</span> <span class="n">density</span><span class="p">,</span> <span class="n">dtype</span><span class="o">=</span><span class="n">dtype</span><span class="p">,</span> <span class="nb">format</span><span class="o">=</span><span class="s2">&quot;csr&quot;</span><span class="p">)</span>
<span class="k">if</span> <span class="n">data_init</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">csr</span><span class="o">.</span><span class="n">data</span><span class="o">.</span><span class="n">fill</span><span class="p">(</span><span class="n">data_init</span><span class="p">)</span>
<span class="k">if</span> <span class="n">shuffle_csr_indices</span> <span class="ow">is</span> <span class="kc">True</span><span class="p">:</span>
<span class="n">shuffle_csr_column_indices</span><span class="p">(</span><span class="n">csr</span><span class="p">)</span>
<span class="n">result</span> <span class="o">=</span> <span class="n">mx</span><span class="o">.</span><span class="n">nd</span><span class="o">.</span><span class="n">sparse</span><span class="o">.</span><span class="n">csr_matrix</span><span class="p">((</span><span class="n">csr</span><span class="o">.</span><span class="n">data</span><span class="p">,</span> <span class="n">csr</span><span class="o">.</span><span class="n">indices</span><span class="p">,</span> <span class="n">csr</span><span class="o">.</span><span class="n">indptr</span><span class="p">),</span>
<span class="n">shape</span><span class="o">=</span><span class="p">(</span><span class="n">num_rows</span><span class="p">,</span> <span class="n">num_cols</span><span class="p">),</span> <span class="n">dtype</span><span class="o">=</span><span class="n">dtype</span><span class="p">)</span>
<span class="k">except</span> <span class="ne">ImportError</span><span class="p">:</span>
<span class="k">assert</span><span class="p">(</span><span class="n">data_init</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">),</span> \
<span class="s2">&quot;data_init option is not supported when scipy is absent&quot;</span>
<span class="k">assert</span><span class="p">(</span><span class="ow">not</span> <span class="n">shuffle_csr_indices</span><span class="p">),</span> \
<span class="s2">&quot;shuffle_csr_indices option is not supported when scipy is absent&quot;</span>
<span class="c1"># scipy not available. try to generate one from a dense array</span>
<span class="n">dns</span> <span class="o">=</span> <span class="n">mx</span><span class="o">.</span><span class="n">nd</span><span class="o">.</span><span class="n">random</span><span class="o">.</span><span class="n">uniform</span><span class="p">(</span><span class="n">shape</span><span class="o">=</span><span class="p">(</span><span class="n">num_rows</span><span class="p">,</span> <span class="n">num_cols</span><span class="p">),</span> <span class="n">dtype</span><span class="o">=</span><span class="n">dtype</span><span class="p">)</span>
<span class="n">masked_dns</span> <span class="o">=</span> <span class="n">dns</span> <span class="o">*</span> <span class="p">(</span><span class="n">dns</span> <span class="o">&lt;</span> <span class="n">density</span><span class="p">)</span>
<span class="n">result</span> <span class="o">=</span> <span class="n">masked_dns</span><span class="o">.</span><span class="n">tostype</span><span class="p">(</span><span class="s1">&#39;csr&#39;</span><span class="p">)</span>
<span class="k">return</span> <span class="n">result</span>
<span class="k">def</span> <span class="nf">_get_powerlaw_dataset_csr</span><span class="p">(</span><span class="n">num_rows</span><span class="p">,</span> <span class="n">num_cols</span><span class="p">,</span> <span class="n">density</span><span class="o">=</span><span class="mf">0.1</span><span class="p">,</span> <span class="n">dtype</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Returns CSRNDArray with powerlaw distribution</span>
<span class="sd"> with exponentially increasing number of non zeros in each row.</span>
<span class="sd"> Not supported for cases where total_nnz &lt; 2*num_rows. This is because</span>
<span class="sd"> the algorithm first tries to ensure that there are rows with no zeros by</span>
<span class="sd"> putting non zeros at beginning of each row.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">_validate_csr_generation_inputs</span><span class="p">(</span><span class="n">num_rows</span><span class="p">,</span> <span class="n">num_cols</span><span class="p">,</span> <span class="n">density</span><span class="p">,</span>
<span class="n">distribution</span><span class="o">=</span><span class="s2">&quot;powerlaw&quot;</span><span class="p">)</span>
<span class="n">total_nnz</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span><span class="n">num_rows</span> <span class="o">*</span> <span class="n">num_cols</span> <span class="o">*</span> <span class="n">density</span><span class="p">)</span>
<span class="n">unused_nnz</span> <span class="o">=</span> <span class="n">total_nnz</span>
<span class="n">output_arr</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">zeros</span><span class="p">((</span><span class="n">num_rows</span><span class="p">,</span> <span class="n">num_cols</span><span class="p">),</span> <span class="n">dtype</span><span class="o">=</span><span class="n">dtype</span><span class="p">)</span>
<span class="c1"># Start with ones on each row so that no row is empty</span>
<span class="k">for</span> <span class="n">row</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="n">num_rows</span><span class="p">):</span>
<span class="n">output_arr</span><span class="p">[</span><span class="n">row</span><span class="p">][</span><span class="mi">0</span><span class="p">]</span> <span class="o">=</span> <span class="mi">1</span> <span class="o">+</span> <span class="n">rnd</span><span class="o">.</span><span class="n">uniform</span><span class="p">(</span><span class="mf">0.001</span><span class="p">,</span> <span class="mi">2</span><span class="p">)</span>
<span class="n">unused_nnz</span> <span class="o">=</span> <span class="n">unused_nnz</span> <span class="o">-</span> <span class="mi">1</span>
<span class="k">if</span> <span class="n">unused_nnz</span> <span class="o">&lt;=</span> <span class="mi">0</span><span class="p">:</span>
<span class="k">return</span> <span class="n">mx</span><span class="o">.</span><span class="n">nd</span><span class="o">.</span><span class="n">array</span><span class="p">(</span><span class="n">output_arr</span><span class="p">)</span><span class="o">.</span><span class="n">tostype</span><span class="p">(</span><span class="s2">&quot;csr&quot;</span><span class="p">)</span>
<span class="c1"># Populate rest of matrix with 2^i items in ith row.</span>
<span class="c1"># if we have used all total nnz return the sparse matrix</span>
<span class="c1"># else if we reached max column size then fill up full columns until we use all nnz</span>
<span class="n">col_max</span> <span class="o">=</span> <span class="mi">2</span>
<span class="k">for</span> <span class="n">row</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="n">num_rows</span><span class="p">):</span>
<span class="n">col_limit</span> <span class="o">=</span> <span class="nb">min</span><span class="p">(</span><span class="n">num_cols</span><span class="p">,</span> <span class="n">col_max</span><span class="p">)</span>
<span class="c1"># In case col_limit reached assign same value to all elements, which is much faster</span>
<span class="k">if</span> <span class="n">col_limit</span> <span class="o">==</span> <span class="n">num_cols</span> <span class="ow">and</span> <span class="n">unused_nnz</span> <span class="o">&gt;</span> <span class="n">col_limit</span><span class="p">:</span>
<span class="n">output_arr</span><span class="p">[</span><span class="n">row</span><span class="p">]</span> <span class="o">=</span> <span class="mi">1</span> <span class="o">+</span> <span class="n">rnd</span><span class="o">.</span><span class="n">uniform</span><span class="p">(</span><span class="mf">0.001</span><span class="p">,</span> <span class="mi">2</span><span class="p">)</span>
<span class="n">unused_nnz</span> <span class="o">=</span> <span class="n">unused_nnz</span> <span class="o">-</span> <span class="n">col_limit</span> <span class="o">+</span> <span class="mi">1</span>
<span class="k">if</span> <span class="n">unused_nnz</span> <span class="o">&lt;=</span> <span class="mi">0</span><span class="p">:</span>
<span class="k">return</span> <span class="n">mx</span><span class="o">.</span><span class="n">nd</span><span class="o">.</span><span class="n">array</span><span class="p">(</span><span class="n">output_arr</span><span class="p">)</span><span class="o">.</span><span class="n">tostype</span><span class="p">(</span><span class="s2">&quot;csr&quot;</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">continue</span>
<span class="k">for</span> <span class="n">col_index</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span> <span class="n">col_limit</span><span class="p">):</span>
<span class="n">output_arr</span><span class="p">[</span><span class="n">row</span><span class="p">][</span><span class="n">col_index</span><span class="p">]</span> <span class="o">=</span> <span class="mi">1</span> <span class="o">+</span> <span class="n">rnd</span><span class="o">.</span><span class="n">uniform</span><span class="p">(</span><span class="mf">0.001</span><span class="p">,</span> <span class="mi">2</span><span class="p">)</span>
<span class="n">unused_nnz</span> <span class="o">=</span> <span class="n">unused_nnz</span> <span class="o">-</span> <span class="mi">1</span>
<span class="k">if</span> <span class="n">unused_nnz</span> <span class="o">&lt;=</span> <span class="mi">0</span><span class="p">:</span>
<span class="k">return</span> <span class="n">mx</span><span class="o">.</span><span class="n">nd</span><span class="o">.</span><span class="n">array</span><span class="p">(</span><span class="n">output_arr</span><span class="p">)</span><span class="o">.</span><span class="n">tostype</span><span class="p">(</span><span class="s2">&quot;csr&quot;</span><span class="p">)</span>
<span class="n">col_max</span> <span class="o">=</span> <span class="n">col_max</span> <span class="o">*</span> <span class="mi">2</span>
<span class="k">if</span> <span class="n">unused_nnz</span> <span class="o">&gt;</span> <span class="mi">0</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;not supported for this density: </span><span class="si">{</span><span class="n">density</span><span class="si">}</span><span class="s2">&quot;</span>
<span class="sa">f</span><span class="s2">&quot; for this shape (</span><span class="si">{</span><span class="n">num_rows</span><span class="si">}</span><span class="s2">,</span><span class="si">{</span><span class="n">num_cols</span><span class="si">}</span><span class="s2">)&quot;</span><span class="p">)</span>
<span class="k">return</span> <span class="n">mx</span><span class="o">.</span><span class="n">nd</span><span class="o">.</span><span class="n">array</span><span class="p">(</span><span class="n">output_arr</span><span class="p">)</span><span class="o">.</span><span class="n">tostype</span><span class="p">(</span><span class="s2">&quot;csr&quot;</span><span class="p">)</span>
<div class="viewcode-block" id="assign_each"><a class="viewcode-back" href="../../api/test_utils/index.html#mxnet.test_utils.assign_each">[docs]</a><span class="k">def</span> <span class="nf">assign_each</span><span class="p">(</span><span class="n">the_input</span><span class="p">,</span> <span class="n">function</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Return ndarray composed of passing each array value through some function&quot;&quot;&quot;</span>
<span class="k">if</span> <span class="n">function</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">output</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">the_input</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">it_input</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">nditer</span><span class="p">(</span><span class="n">the_input</span><span class="p">,</span> <span class="n">flags</span><span class="o">=</span><span class="p">[</span><span class="s1">&#39;f_index&#39;</span><span class="p">])</span>
<span class="n">output</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">zeros</span><span class="p">(</span><span class="n">the_input</span><span class="o">.</span><span class="n">shape</span><span class="p">)</span>
<span class="n">it_out</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">nditer</span><span class="p">(</span><span class="n">output</span><span class="p">,</span> <span class="n">flags</span><span class="o">=</span><span class="p">[</span><span class="s1">&#39;f_index&#39;</span><span class="p">],</span> <span class="n">op_flags</span><span class="o">=</span><span class="p">[</span><span class="s1">&#39;writeonly&#39;</span><span class="p">])</span>
<span class="k">while</span> <span class="ow">not</span> <span class="n">it_input</span><span class="o">.</span><span class="n">finished</span><span class="p">:</span>
<span class="n">val_input</span> <span class="o">=</span> <span class="n">it_input</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
<span class="n">it_out</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">=</span> <span class="n">function</span><span class="p">(</span><span class="n">val_input</span><span class="p">)</span>
<span class="n">it_input</span><span class="o">.</span><span class="n">iternext</span><span class="p">()</span>
<span class="n">it_out</span><span class="o">.</span><span class="n">iternext</span><span class="p">()</span>
<span class="k">return</span> <span class="n">output</span></div>
<div class="viewcode-block" id="assign_each2"><a class="viewcode-back" href="../../api/test_utils/index.html#mxnet.test_utils.assign_each2">[docs]</a><span class="k">def</span> <span class="nf">assign_each2</span><span class="p">(</span><span class="n">input1</span><span class="p">,</span> <span class="n">input2</span><span class="p">,</span> <span class="n">function</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Return ndarray composed of passing two array values through some function&quot;&quot;&quot;</span>
<span class="k">if</span> <span class="n">function</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">output</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">input1</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">assert</span> <span class="n">input1</span><span class="o">.</span><span class="n">shape</span> <span class="o">==</span> <span class="n">input2</span><span class="o">.</span><span class="n">shape</span>
<span class="n">it_input1</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">nditer</span><span class="p">(</span><span class="n">input1</span><span class="p">,</span> <span class="n">flags</span><span class="o">=</span><span class="p">[</span><span class="s1">&#39;f_index&#39;</span><span class="p">])</span>
<span class="n">it_input2</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">nditer</span><span class="p">(</span><span class="n">input2</span><span class="p">,</span> <span class="n">flags</span><span class="o">=</span><span class="p">[</span><span class="s1">&#39;f_index&#39;</span><span class="p">])</span>
<span class="n">output</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">zeros</span><span class="p">(</span><span class="n">input1</span><span class="o">.</span><span class="n">shape</span><span class="p">)</span>
<span class="n">it_out</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">nditer</span><span class="p">(</span><span class="n">output</span><span class="p">,</span> <span class="n">flags</span><span class="o">=</span><span class="p">[</span><span class="s1">&#39;f_index&#39;</span><span class="p">],</span> <span class="n">op_flags</span><span class="o">=</span><span class="p">[</span><span class="s1">&#39;writeonly&#39;</span><span class="p">])</span>
<span class="k">while</span> <span class="ow">not</span> <span class="n">it_input1</span><span class="o">.</span><span class="n">finished</span><span class="p">:</span>
<span class="n">val_input1</span> <span class="o">=</span> <span class="n">it_input1</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
<span class="n">val_input2</span> <span class="o">=</span> <span class="n">it_input2</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
<span class="n">it_out</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">=</span> <span class="n">function</span><span class="p">(</span><span class="n">val_input1</span><span class="p">,</span> <span class="n">val_input2</span><span class="p">)</span>
<span class="n">it_input1</span><span class="o">.</span><span class="n">iternext</span><span class="p">()</span>
<span class="n">it_input2</span><span class="o">.</span><span class="n">iternext</span><span class="p">()</span>
<span class="n">it_out</span><span class="o">.</span><span class="n">iternext</span><span class="p">()</span>
<span class="k">return</span> <span class="n">output</span></div>
<span class="k">def</span> <span class="nf">create_2d_np_tensor</span><span class="p">(</span><span class="n">rows</span><span class="p">,</span> <span class="n">columns</span><span class="p">,</span> <span class="n">dtype</span><span class="o">=</span><span class="n">np</span><span class="o">.</span><span class="n">int64</span><span class="p">):</span>
<span class="n">inp</span> <span class="o">=</span> <span class="n">mx</span><span class="o">.</span><span class="n">np</span><span class="o">.</span><span class="n">arange</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="n">rows</span><span class="p">,</span> <span class="n">dtype</span><span class="o">=</span><span class="n">dtype</span><span class="p">)</span><span class="o">.</span><span class="n">reshape</span><span class="p">(</span><span class="n">rows</span><span class="p">,</span> <span class="mi">1</span><span class="p">)</span>
<span class="n">inp</span> <span class="o">=</span> <span class="n">mx</span><span class="o">.</span><span class="n">np</span><span class="o">.</span><span class="n">broadcast_to</span><span class="p">(</span><span class="n">inp</span><span class="p">,</span> <span class="n">shape</span><span class="o">=</span><span class="p">(</span><span class="n">inp</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="mi">0</span><span class="p">],</span> <span class="n">columns</span><span class="p">))</span>
<span class="k">return</span> <span class="n">inp</span>
<span class="c1"># For testing Large Tensors having total size &gt; 2^32 elements</span>
<span class="k">def</span> <span class="nf">create_2d_tensor</span><span class="p">(</span><span class="n">rows</span><span class="p">,</span> <span class="n">columns</span><span class="p">,</span> <span class="n">dtype</span><span class="o">=</span><span class="n">np</span><span class="o">.</span><span class="n">int64</span><span class="p">):</span>
<span class="n">a</span> <span class="o">=</span> <span class="n">mx</span><span class="o">.</span><span class="n">nd</span><span class="o">.</span><span class="n">arange</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="n">rows</span><span class="p">,</span> <span class="n">dtype</span><span class="o">=</span><span class="n">dtype</span><span class="p">)</span><span class="o">.</span><span class="n">reshape</span><span class="p">(</span><span class="n">rows</span><span class="p">,</span> <span class="mi">1</span><span class="p">)</span>
<span class="n">b</span> <span class="o">=</span> <span class="n">mx</span><span class="o">.</span><span class="n">nd</span><span class="o">.</span><span class="n">broadcast_to</span><span class="p">(</span><span class="n">a</span><span class="p">,</span> <span class="n">shape</span><span class="o">=</span><span class="p">(</span><span class="n">a</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="mi">0</span><span class="p">],</span> <span class="n">columns</span><span class="p">))</span>
<span class="k">return</span> <span class="n">b</span>
<span class="c1"># For testing Large Vectors having total size &gt; 2^32 elements</span>
<span class="k">def</span> <span class="nf">create_vector</span><span class="p">(</span><span class="n">size</span><span class="p">,</span> <span class="n">dtype</span><span class="o">=</span><span class="n">np</span><span class="o">.</span><span class="n">int64</span><span class="p">):</span>
<span class="n">a</span> <span class="o">=</span> <span class="n">mx</span><span class="o">.</span><span class="n">nd</span><span class="o">.</span><span class="n">arange</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="n">size</span><span class="p">,</span> <span class="n">dtype</span><span class="o">=</span><span class="n">dtype</span><span class="p">)</span>
<span class="k">return</span> <span class="n">a</span>
<div class="viewcode-block" id="rand_sparse_ndarray"><a class="viewcode-back" href="../../api/test_utils/index.html#mxnet.test_utils.rand_sparse_ndarray">[docs]</a><span class="k">def</span> <span class="nf">rand_sparse_ndarray</span><span class="p">(</span><span class="n">shape</span><span class="p">,</span> <span class="n">stype</span><span class="p">,</span> <span class="n">density</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">dtype</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">distribution</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
<span class="n">data_init</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">rsp_indices</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">modifier_func</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
<span class="n">shuffle_csr_indices</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">ctx</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Generate a random sparse ndarray. Returns the ndarray, value(np) and indices(np)</span>
<span class="sd"> Parameters</span>
<span class="sd"> ----------</span>
<span class="sd"> shape: list or tuple</span>
<span class="sd"> stype: str</span>
<span class="sd"> valid values: &quot;csr&quot; or &quot;row_sparse&quot;</span>
<span class="sd"> density: float, optional</span>
<span class="sd"> should be between 0 and 1</span>
<span class="sd"> distribution: str, optional</span>
<span class="sd"> valid values: &quot;uniform&quot; or &quot;powerlaw&quot;</span>
<span class="sd"> dtype: numpy.dtype, optional</span>
<span class="sd"> default value is None</span>
<span class="sd"> Returns</span>
<span class="sd"> -------</span>
<span class="sd"> Result of type CSRNDArray or RowSparseNDArray</span>
<span class="sd"> Examples</span>
<span class="sd"> --------</span>
<span class="sd"> Below is an example of the powerlaw distribution with csr as the stype.</span>
<span class="sd"> It calculates the nnz using the shape and density.</span>
<span class="sd"> It fills up the ndarray with exponentially increasing number of elements.</span>
<span class="sd"> If there are enough unused_nnzs, n+1th row will have twice more nnzs compared to nth row.</span>
<span class="sd"> else, remaining unused_nnzs will be used in n+1th row</span>
<span class="sd"> If number of cols is too small and we have already reached column size it will fill up</span>
<span class="sd"> all following columns in all followings rows until we reach the required density.</span>
<span class="sd"> &gt;&gt;&gt; csr_arr, _ = rand_sparse_ndarray(shape=(5, 16), stype=&quot;csr&quot;,</span>
<span class="sd"> density=0.50, distribution=&quot;powerlaw&quot;)</span>
<span class="sd"> &gt;&gt;&gt; indptr = csr_arr.indptr.asnumpy()</span>
<span class="sd"> &gt;&gt;&gt; indices = csr_arr.indices.asnumpy()</span>
<span class="sd"> &gt;&gt;&gt; data = csr_arr.data.asnumpy()</span>
<span class="sd"> &gt;&gt;&gt; row2nnz = len(data[indptr[1]:indptr[2]])</span>
<span class="sd"> &gt;&gt;&gt; row3nnz = len(data[indptr[2]:indptr[3]])</span>
<span class="sd"> &gt;&gt;&gt; assert(row3nnz == 2*row2nnz)</span>
<span class="sd"> &gt;&gt;&gt; row4nnz = len(data[indptr[3]:indptr[4]])</span>
<span class="sd"> &gt;&gt;&gt; assert(row4nnz == 2*row3nnz)</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">ctx</span> <span class="o">=</span> <span class="n">ctx</span> <span class="k">if</span> <span class="n">ctx</span> <span class="k">else</span> <span class="n">default_device</span><span class="p">()</span>
<span class="n">density</span> <span class="o">=</span> <span class="n">rnd</span><span class="o">.</span><span class="n">rand</span><span class="p">()</span> <span class="k">if</span> <span class="n">density</span> <span class="ow">is</span> <span class="kc">None</span> <span class="k">else</span> <span class="n">density</span>
<span class="n">dtype</span> <span class="o">=</span> <span class="n">default_dtype</span><span class="p">()</span> <span class="k">if</span> <span class="n">dtype</span> <span class="ow">is</span> <span class="kc">None</span> <span class="k">else</span> <span class="n">dtype</span>
<span class="n">distribution</span> <span class="o">=</span> <span class="s2">&quot;uniform&quot;</span> <span class="k">if</span> <span class="n">distribution</span> <span class="ow">is</span> <span class="kc">None</span> <span class="k">else</span> <span class="n">distribution</span>
<span class="k">if</span> <span class="n">stype</span> <span class="o">==</span> <span class="s1">&#39;row_sparse&#39;</span><span class="p">:</span>
<span class="k">assert</span> <span class="p">(</span><span class="n">distribution</span> <span class="o">==</span> <span class="s2">&quot;uniform&quot;</span><span class="p">),</span> \
<span class="sa">f</span><span class="s2">&quot;Distribution </span><span class="si">{</span><span class="n">distribution</span><span class="si">}</span><span class="s2"> not supported for row_sparse&quot;</span>
<span class="c1"># sample index</span>
<span class="k">if</span> <span class="n">rsp_indices</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">indices</span> <span class="o">=</span> <span class="n">rsp_indices</span>
<span class="k">assert</span><span class="p">(</span><span class="nb">len</span><span class="p">(</span><span class="n">indices</span><span class="p">)</span> <span class="o">&lt;=</span> <span class="n">shape</span><span class="p">[</span><span class="mi">0</span><span class="p">])</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">idx_sample</span> <span class="o">=</span> <span class="n">rnd</span><span class="o">.</span><span class="n">rand</span><span class="p">(</span><span class="n">shape</span><span class="p">[</span><span class="mi">0</span><span class="p">])</span>
<span class="n">indices</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">argwhere</span><span class="p">(</span><span class="n">idx_sample</span> <span class="o">&lt;</span> <span class="n">density</span><span class="p">)</span><span class="o">.</span><span class="n">flatten</span><span class="p">()</span>
<span class="k">if</span> <span class="n">indices</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>
<span class="n">result</span> <span class="o">=</span> <span class="n">mx</span><span class="o">.</span><span class="n">nd</span><span class="o">.</span><span class="n">zeros</span><span class="p">(</span><span class="n">shape</span><span class="p">,</span> <span class="n">stype</span><span class="o">=</span><span class="s1">&#39;row_sparse&#39;</span><span class="p">,</span> <span class="n">dtype</span><span class="o">=</span><span class="n">dtype</span><span class="p">,</span> <span class="n">ctx</span><span class="o">=</span><span class="n">ctx</span><span class="p">)</span>
<span class="k">return</span> <span class="n">result</span><span class="p">,</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="n">dtype</span><span class="o">=</span><span class="n">dtype</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="c1"># generate random values</span>
<span class="n">val</span> <span class="o">=</span> <span class="n">rnd</span><span class="o">.</span><span class="n">rand</span><span class="p">(</span><span class="n">indices</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="mi">0</span><span class="p">],</span> <span class="o">*</span><span class="n">shape</span><span class="p">[</span><span class="mi">1</span><span class="p">:])</span><span class="o">.</span><span class="n">astype</span><span class="p">(</span><span class="n">dtype</span><span class="p">)</span>
<span class="c1"># Allow caller to override or adjust random values</span>
<span class="k">if</span> <span class="n">data_init</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">val</span><span class="o">.</span><span class="n">fill</span><span class="p">(</span><span class="n">data_init</span><span class="p">)</span>
<span class="k">if</span> <span class="n">modifier_func</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">val</span> <span class="o">=</span> <span class="n">assign_each</span><span class="p">(</span><span class="n">val</span><span class="p">,</span> <span class="n">modifier_func</span><span class="p">)</span>
<span class="n">arr</span> <span class="o">=</span> <span class="n">mx</span><span class="o">.</span><span class="n">nd</span><span class="o">.</span><span class="n">sparse</span><span class="o">.</span><span class="n">row_sparse_array</span><span class="p">((</span><span class="n">val</span><span class="p">,</span> <span class="n">indices</span><span class="p">),</span> <span class="n">shape</span><span class="o">=</span><span class="n">shape</span><span class="p">,</span> <span class="n">dtype</span><span class="o">=</span><span class="n">dtype</span><span class="p">,</span> <span class="n">ctx</span><span class="o">=</span><span class="n">ctx</span><span class="p">)</span>
<span class="k">return</span> <span class="n">arr</span><span class="p">,</span> <span class="p">(</span><span class="n">val</span><span class="p">,</span> <span class="n">indices</span><span class="p">)</span>
<span class="k">elif</span> <span class="n">stype</span> <span class="o">==</span> <span class="s1">&#39;csr&#39;</span><span class="p">:</span>
<span class="k">assert</span> <span class="nb">len</span><span class="p">(</span><span class="n">shape</span><span class="p">)</span> <span class="o">==</span> <span class="mi">2</span>
<span class="k">if</span> <span class="n">distribution</span> <span class="o">==</span> <span class="s2">&quot;uniform&quot;</span><span class="p">:</span>
<span class="n">csr</span> <span class="o">=</span> <span class="n">_get_uniform_dataset_csr</span><span class="p">(</span><span class="n">shape</span><span class="p">[</span><span class="mi">0</span><span class="p">],</span> <span class="n">shape</span><span class="p">[</span><span class="mi">1</span><span class="p">],</span> <span class="n">density</span><span class="p">,</span>
<span class="n">data_init</span><span class="o">=</span><span class="n">data_init</span><span class="p">,</span>
<span class="n">shuffle_csr_indices</span><span class="o">=</span><span class="n">shuffle_csr_indices</span><span class="p">,</span> <span class="n">dtype</span><span class="o">=</span><span class="n">dtype</span><span class="p">)</span><span class="o">.</span><span class="n">as_in_context</span><span class="p">(</span><span class="n">ctx</span><span class="p">)</span>
<span class="k">return</span> <span class="n">csr</span><span class="p">,</span> <span class="p">(</span><span class="n">csr</span><span class="o">.</span><span class="n">indptr</span><span class="p">,</span> <span class="n">csr</span><span class="o">.</span><span class="n">indices</span><span class="p">,</span> <span class="n">csr</span><span class="o">.</span><span class="n">data</span><span class="p">)</span>
<span class="k">elif</span> <span class="n">distribution</span> <span class="o">==</span> <span class="s2">&quot;powerlaw&quot;</span><span class="p">:</span>
<span class="n">csr</span> <span class="o">=</span> <span class="n">_get_powerlaw_dataset_csr</span><span class="p">(</span><span class="n">shape</span><span class="p">[</span><span class="mi">0</span><span class="p">],</span> <span class="n">shape</span><span class="p">[</span><span class="mi">1</span><span class="p">],</span> <span class="n">density</span><span class="o">=</span><span class="n">density</span><span class="p">,</span> <span class="n">dtype</span><span class="o">=</span><span class="n">dtype</span><span class="p">)</span><span class="o">.</span><span class="n">as_in_context</span><span class="p">(</span><span class="n">ctx</span><span class="p">)</span>
<span class="k">return</span> <span class="n">csr</span><span class="p">,</span> <span class="p">(</span><span class="n">csr</span><span class="o">.</span><span class="n">indptr</span><span class="p">,</span> <span class="n">csr</span><span class="o">.</span><span class="n">indices</span><span class="p">,</span> <span class="n">csr</span><span class="o">.</span><span class="n">data</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">assert</span><span class="p">(</span><span class="kc">False</span><span class="p">),</span> <span class="sa">f</span><span class="s2">&quot;Distribution not supported: </span><span class="si">{</span><span class="n">distribution</span><span class="si">}</span><span class="s2">&quot;</span>
<span class="k">return</span> <span class="kc">False</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">assert</span><span class="p">(</span><span class="kc">False</span><span class="p">),</span> <span class="s2">&quot;unknown storage type&quot;</span>
<span class="k">return</span> <span class="kc">False</span></div>
<div class="viewcode-block" id="rand_ndarray"><a class="viewcode-back" href="../../api/test_utils/index.html#mxnet.test_utils.rand_ndarray">[docs]</a><span class="k">def</span> <span class="nf">rand_ndarray</span><span class="p">(</span><span class="n">shape</span><span class="p">,</span> <span class="n">stype</span><span class="o">=</span><span class="s1">&#39;default&#39;</span><span class="p">,</span> <span class="n">density</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">dtype</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">modifier_func</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
<span class="n">shuffle_csr_indices</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">distribution</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">ctx</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Generate a random sparse ndarray. Returns the generated ndarray.&quot;&quot;&quot;</span>
<span class="n">ctx</span> <span class="o">=</span> <span class="n">ctx</span> <span class="k">if</span> <span class="n">ctx</span> <span class="k">else</span> <span class="n">default_device</span><span class="p">()</span>
<span class="k">if</span> <span class="n">stype</span> <span class="o">==</span> <span class="s1">&#39;default&#39;</span><span class="p">:</span>
<span class="n">arr</span> <span class="o">=</span> <span class="n">mx</span><span class="o">.</span><span class="n">nd</span><span class="o">.</span><span class="n">array</span><span class="p">(</span><span class="n">random_arrays</span><span class="p">(</span><span class="n">shape</span><span class="p">),</span> <span class="n">dtype</span><span class="o">=</span><span class="n">dtype</span><span class="p">,</span> <span class="n">ctx</span><span class="o">=</span><span class="n">ctx</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">arr</span><span class="p">,</span> <span class="n">_</span> <span class="o">=</span> <span class="n">rand_sparse_ndarray</span><span class="p">(</span><span class="n">shape</span><span class="p">,</span> <span class="n">stype</span><span class="p">,</span> <span class="n">density</span><span class="o">=</span><span class="n">density</span><span class="p">,</span>
<span class="n">modifier_func</span><span class="o">=</span><span class="n">modifier_func</span><span class="p">,</span> <span class="n">dtype</span><span class="o">=</span><span class="n">dtype</span><span class="p">,</span>
<span class="n">shuffle_csr_indices</span><span class="o">=</span><span class="n">shuffle_csr_indices</span><span class="p">,</span>
<span class="n">distribution</span><span class="o">=</span><span class="n">distribution</span><span class="p">,</span> <span class="n">ctx</span><span class="o">=</span><span class="n">ctx</span><span class="p">)</span>
<span class="k">return</span> <span class="n">arr</span></div>
<div class="viewcode-block" id="create_sparse_array"><a class="viewcode-back" href="../../api/test_utils/index.html#mxnet.test_utils.create_sparse_array">[docs]</a><span class="k">def</span> <span class="nf">create_sparse_array</span><span class="p">(</span><span class="n">shape</span><span class="p">,</span> <span class="n">stype</span><span class="p">,</span> <span class="n">data_init</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">rsp_indices</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
<span class="n">dtype</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">modifier_func</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">density</span><span class="o">=</span><span class="mf">.5</span><span class="p">,</span>
<span class="n">shuffle_csr_indices</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Create a sparse array, For Rsp, assure indices are in a canonical format&quot;&quot;&quot;</span>
<span class="k">if</span> <span class="n">stype</span> <span class="o">==</span> <span class="s1">&#39;row_sparse&#39;</span><span class="p">:</span>
<span class="k">if</span> <span class="n">rsp_indices</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">arr_indices</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">asarray</span><span class="p">(</span><span class="n">rsp_indices</span><span class="p">)</span>
<span class="n">arr_indices</span><span class="o">.</span><span class="n">sort</span><span class="p">()</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">arr_indices</span> <span class="o">=</span> <span class="kc">None</span>
<span class="n">arr_data</span><span class="p">,</span> <span class="p">(</span><span class="n">_</span><span class="p">,</span> <span class="n">_</span><span class="p">)</span> <span class="o">=</span> <span class="n">rand_sparse_ndarray</span><span class="p">(</span><span class="n">shape</span><span class="p">,</span> <span class="n">stype</span><span class="p">,</span>
<span class="n">density</span><span class="o">=</span><span class="n">density</span><span class="p">,</span>
<span class="n">data_init</span><span class="o">=</span><span class="n">data_init</span><span class="p">,</span>
<span class="n">rsp_indices</span><span class="o">=</span><span class="n">arr_indices</span><span class="p">,</span>
<span class="n">dtype</span><span class="o">=</span><span class="n">dtype</span><span class="p">,</span>
<span class="n">modifier_func</span><span class="o">=</span><span class="n">modifier_func</span><span class="p">)</span>
<span class="k">elif</span> <span class="n">stype</span> <span class="o">==</span> <span class="s1">&#39;csr&#39;</span><span class="p">:</span>
<span class="n">arr_data</span><span class="p">,</span> <span class="p">(</span><span class="n">_</span><span class="p">,</span> <span class="n">_</span><span class="p">,</span> <span class="n">_</span><span class="p">)</span> <span class="o">=</span> <span class="n">rand_sparse_ndarray</span><span class="p">(</span><span class="n">shape</span><span class="p">,</span>
<span class="n">stype</span><span class="p">,</span>
<span class="n">density</span><span class="o">=</span><span class="n">density</span><span class="p">,</span>
<span class="n">data_init</span><span class="o">=</span><span class="n">data_init</span><span class="p">,</span>
<span class="n">dtype</span><span class="o">=</span><span class="n">dtype</span><span class="p">,</span>
<span class="n">modifier_func</span><span class="o">=</span><span class="n">modifier_func</span><span class="p">,</span>
<span class="n">shuffle_csr_indices</span><span class="o">=</span><span class="n">shuffle_csr_indices</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">msg</span> <span class="o">=</span> <span class="s2">&quot;Unknown storage type: &quot;</span> <span class="o">+</span> <span class="n">stype</span>
<span class="k">raise</span> <span class="ne">AssertionError</span><span class="p">(</span><span class="n">msg</span><span class="p">)</span>
<span class="k">return</span> <span class="n">arr_data</span></div>
<div class="viewcode-block" id="create_sparse_array_zd"><a class="viewcode-back" href="../../api/test_utils/index.html#mxnet.test_utils.create_sparse_array_zd">[docs]</a><span class="k">def</span> <span class="nf">create_sparse_array_zd</span><span class="p">(</span><span class="n">shape</span><span class="p">,</span> <span class="n">stype</span><span class="p">,</span> <span class="n">density</span><span class="p">,</span> <span class="n">data_init</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
<span class="n">rsp_indices</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">dtype</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">modifier_func</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
<span class="n">shuffle_csr_indices</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Create sparse array, using only rsp_indices to determine density&quot;&quot;&quot;</span>
<span class="k">if</span> <span class="n">stype</span> <span class="o">==</span> <span class="s1">&#39;row_sparse&#39;</span><span class="p">:</span>
<span class="n">density</span> <span class="o">=</span> <span class="mf">0.0</span>
<span class="k">if</span> <span class="n">rsp_indices</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="k">assert</span> <span class="nb">len</span><span class="p">(</span><span class="n">rsp_indices</span><span class="p">)</span> <span class="o">&lt;=</span> <span class="n">shape</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
<span class="k">return</span> <span class="n">create_sparse_array</span><span class="p">(</span><span class="n">shape</span><span class="p">,</span> <span class="n">stype</span><span class="p">,</span>
<span class="n">data_init</span><span class="o">=</span><span class="n">data_init</span><span class="p">,</span>
<span class="n">rsp_indices</span><span class="o">=</span><span class="n">rsp_indices</span><span class="p">,</span>
<span class="n">dtype</span><span class="o">=</span><span class="n">dtype</span><span class="p">,</span>
<span class="n">modifier_func</span><span class="o">=</span><span class="n">modifier_func</span><span class="p">,</span>
<span class="n">density</span><span class="o">=</span><span class="n">density</span><span class="p">,</span>
<span class="n">shuffle_csr_indices</span><span class="o">=</span><span class="n">shuffle_csr_indices</span><span class="p">)</span></div>
<span class="k">def</span> <span class="nf">rand_shape_2d</span><span class="p">(</span><span class="n">dim0</span><span class="o">=</span><span class="mi">10</span><span class="p">,</span> <span class="n">dim1</span><span class="o">=</span><span class="mi">10</span><span class="p">,</span> <span class="n">allow_zero_size</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
<span class="n">low</span> <span class="o">=</span> <span class="mi">0</span> <span class="k">if</span> <span class="n">allow_zero_size</span> <span class="k">else</span> <span class="mi">1</span>
<span class="k">return</span> <span class="n">rnd</span><span class="o">.</span><span class="n">randint</span><span class="p">(</span><span class="n">low</span><span class="p">,</span> <span class="n">dim0</span> <span class="o">+</span> <span class="mi">1</span><span class="p">),</span> <span class="n">rnd</span><span class="o">.</span><span class="n">randint</span><span class="p">(</span><span class="n">low</span><span class="p">,</span> <span class="n">dim1</span> <span class="o">+</span> <span class="mi">1</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">rand_shape_3d</span><span class="p">(</span><span class="n">dim0</span><span class="o">=</span><span class="mi">10</span><span class="p">,</span> <span class="n">dim1</span><span class="o">=</span><span class="mi">10</span><span class="p">,</span> <span class="n">dim2</span><span class="o">=</span><span class="mi">10</span><span class="p">,</span> <span class="n">allow_zero_size</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
<span class="n">low</span> <span class="o">=</span> <span class="mi">0</span> <span class="k">if</span> <span class="n">allow_zero_size</span> <span class="k">else</span> <span class="mi">1</span>
<span class="k">return</span> <span class="n">rnd</span><span class="o">.</span><span class="n">randint</span><span class="p">(</span><span class="n">low</span><span class="p">,</span> <span class="n">dim0</span> <span class="o">+</span> <span class="mi">1</span><span class="p">),</span> <span class="n">rnd</span><span class="o">.</span><span class="n">randint</span><span class="p">(</span><span class="n">low</span><span class="p">,</span> <span class="n">dim1</span> <span class="o">+</span> <span class="mi">1</span><span class="p">),</span> <span class="n">rnd</span><span class="o">.</span><span class="n">randint</span><span class="p">(</span><span class="n">low</span><span class="p">,</span> <span class="n">dim2</span> <span class="o">+</span> <span class="mi">1</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">rand_shape_nd</span><span class="p">(</span><span class="n">num_dim</span><span class="p">,</span> <span class="n">dim</span><span class="o">=</span><span class="mi">10</span><span class="p">,</span> <span class="n">allow_zero_size</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
<span class="n">low</span> <span class="o">=</span> <span class="mi">0</span> <span class="k">if</span> <span class="n">allow_zero_size</span> <span class="k">else</span> <span class="mi">1</span>
<span class="k">return</span> <span class="nb">tuple</span><span class="p">(</span><span class="n">rnd</span><span class="o">.</span><span class="n">randint</span><span class="p">(</span><span class="n">low</span><span class="p">,</span> <span class="n">dim</span><span class="o">+</span><span class="mi">1</span><span class="p">,</span> <span class="n">size</span><span class="o">=</span><span class="n">num_dim</span><span class="p">))</span>
<span class="k">def</span> <span class="nf">rand_coord_2d</span><span class="p">(</span><span class="n">x_low</span><span class="p">,</span> <span class="n">x_high</span><span class="p">,</span> <span class="n">y_low</span><span class="p">,</span> <span class="n">y_high</span><span class="p">):</span>
<span class="n">x</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">random</span><span class="o">.</span><span class="n">randint</span><span class="p">(</span><span class="n">x_low</span><span class="p">,</span> <span class="n">x_high</span><span class="p">,</span> <span class="n">dtype</span><span class="o">=</span><span class="n">np</span><span class="o">.</span><span class="n">int64</span><span class="p">)</span>
<span class="n">y</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">random</span><span class="o">.</span><span class="n">randint</span><span class="p">(</span><span class="n">y_low</span><span class="p">,</span> <span class="n">y_high</span><span class="p">,</span> <span class="n">dtype</span><span class="o">=</span><span class="n">np</span><span class="o">.</span><span class="n">int64</span><span class="p">)</span>
<span class="k">return</span> <span class="n">x</span><span class="p">,</span> <span class="n">y</span>
<div class="viewcode-block" id="np_reduce"><a class="viewcode-back" href="../../api/test_utils/index.html#mxnet.test_utils.np_reduce">[docs]</a><span class="k">def</span> <span class="nf">np_reduce</span><span class="p">(</span><span class="n">dat</span><span class="p">,</span> <span class="n">axis</span><span class="p">,</span> <span class="n">keepdims</span><span class="p">,</span> <span class="n">numpy_reduce_func</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Compatible reduce for old version of NumPy.</span>
<span class="sd"> Parameters</span>
<span class="sd"> ----------</span>
<span class="sd"> dat : np.ndarray</span>
<span class="sd"> Same as NumPy.</span>
<span class="sd"> axis : None or int or list-like</span>
<span class="sd"> Same as NumPy.</span>
<span class="sd"> keepdims : bool</span>
<span class="sd"> Same as NumPy.</span>
<span class="sd"> numpy_reduce_func : function</span>
<span class="sd"> A NumPy reducing function like ``np.sum`` or ``np.max``.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">axis</span><span class="p">,</span> <span class="nb">int</span><span class="p">):</span>
<span class="n">axis</span> <span class="o">=</span> <span class="p">[</span><span class="n">axis</span><span class="p">]</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">axis</span> <span class="o">=</span> <span class="nb">list</span><span class="p">(</span><span class="n">axis</span><span class="p">)</span> <span class="k">if</span> <span class="n">axis</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span> <span class="k">else</span> <span class="nb">range</span><span class="p">(</span><span class="nb">len</span><span class="p">(</span><span class="n">dat</span><span class="o">.</span><span class="n">shape</span><span class="p">))</span>
<span class="n">ret</span> <span class="o">=</span> <span class="n">dat</span>
<span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="nb">reversed</span><span class="p">(</span><span class="nb">sorted</span><span class="p">(</span><span class="n">axis</span><span class="p">)):</span>
<span class="n">ret</span> <span class="o">=</span> <span class="n">numpy_reduce_func</span><span class="p">(</span><span class="n">ret</span><span class="p">,</span> <span class="n">axis</span><span class="o">=</span><span class="n">i</span><span class="p">)</span>
<span class="k">if</span> <span class="n">keepdims</span><span class="p">:</span>
<span class="n">keepdims_shape</span> <span class="o">=</span> <span class="nb">list</span><span class="p">(</span><span class="n">dat</span><span class="o">.</span><span class="n">shape</span><span class="p">)</span>
<span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="n">axis</span><span class="p">:</span>
<span class="n">keepdims_shape</span><span class="p">[</span><span class="n">i</span><span class="p">]</span> <span class="o">=</span> <span class="mi">1</span>
<span class="n">ret</span> <span class="o">=</span> <span class="n">ret</span><span class="o">.</span><span class="n">reshape</span><span class="p">(</span><span class="nb">tuple</span><span class="p">(</span><span class="n">keepdims_shape</span><span class="p">))</span>
<span class="k">return</span> <span class="n">ret</span></div>
<span class="k">def</span> <span class="nf">_find_max_violation</span><span class="p">(</span><span class="n">a</span><span class="p">,</span> <span class="n">b</span><span class="p">,</span> <span class="n">rtol</span><span class="p">,</span> <span class="n">atol</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Finds and returns the location of maximum violation.&quot;&quot;&quot;</span>
<span class="c1"># &#39;smart&#39; absdiff that considers inf&#39;s as equals (to match np.allclose)</span>
<span class="n">absdiff</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">where</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">equal</span><span class="p">(</span><span class="n">a</span><span class="p">,</span> <span class="n">b</span><span class="p">),</span> <span class="mi">0</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">a</span><span class="o">-</span><span class="n">b</span><span class="p">))</span>
<span class="n">tol</span> <span class="o">=</span> <span class="n">atol</span> <span class="o">+</span> <span class="n">rtol</span><span class="o">*</span><span class="n">np</span><span class="o">.</span><span class="n">abs</span><span class="p">(</span><span class="n">b</span><span class="p">)</span>
<span class="n">violation</span> <span class="o">=</span> <span class="n">absdiff</span><span class="o">/</span><span class="p">(</span><span class="n">tol</span><span class="o">+</span><span class="mf">1e-20</span><span class="p">)</span>
<span class="n">loc</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">argmax</span><span class="p">(</span><span class="n">violation</span><span class="p">)</span>
<span class="n">idx</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">unravel_index</span><span class="p">(</span><span class="n">loc</span><span class="p">,</span> <span class="n">violation</span><span class="o">.</span><span class="n">shape</span><span class="p">)</span>
<span class="k">return</span> <span class="n">idx</span><span class="p">,</span> <span class="n">np</span><span class="o">.</span><span class="n">max</span><span class="p">(</span><span class="n">violation</span><span class="p">)</span>
<div class="viewcode-block" id="same"><a class="viewcode-back" href="../../api/test_utils/index.html#mxnet.test_utils.same">[docs]</a><span class="k">def</span> <span class="nf">same</span><span class="p">(</span><span class="n">a</span><span class="p">,</span> <span class="n">b</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Test if two NumPy arrays are the same.</span>
<span class="sd"> Parameters</span>
<span class="sd"> ----------</span>
<span class="sd"> a : np.ndarray</span>
<span class="sd"> b : np.ndarray</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">return</span> <span class="n">np</span><span class="o">.</span><span class="n">array_equal</span><span class="p">(</span><span class="n">a</span><span class="p">,</span> <span class="n">b</span><span class="p">)</span></div>
<span class="k">def</span> <span class="nf">checkShapes</span><span class="p">(</span><span class="n">a</span><span class="p">,</span> <span class="n">b</span><span class="p">):</span>
<span class="k">if</span> <span class="n">a</span><span class="o">.</span><span class="n">shape</span> <span class="o">!=</span> <span class="n">b</span><span class="o">.</span><span class="n">shape</span><span class="p">:</span>
<span class="n">msg</span> <span class="o">=</span> <span class="n">npt</span><span class="o">.</span><span class="n">build_err_msg</span><span class="p">([</span><span class="n">a</span><span class="p">,</span> <span class="n">b</span><span class="p">],</span>
<span class="n">err_msg</span><span class="o">=</span><span class="s2">&quot;a.shape = </span><span class="si">{}</span><span class="s2"> and b.shape = </span><span class="si">{}</span><span class="s2"> are not equal&quot;</span>
<span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="n">a</span><span class="o">.</span><span class="n">shape</span><span class="p">),</span> <span class="nb">str</span><span class="p">(</span><span class="n">b</span><span class="o">.</span><span class="n">shape</span><span class="p">)))</span>
<span class="k">raise</span> <span class="ne">AssertionError</span><span class="p">(</span><span class="n">msg</span><span class="p">)</span>
<div class="viewcode-block" id="almost_equal"><a class="viewcode-back" href="../../api/test_utils/index.html#mxnet.test_utils.almost_equal">[docs]</a><span class="k">def</span> <span class="nf">almost_equal</span><span class="p">(</span><span class="n">a</span><span class="p">,</span> <span class="n">b</span><span class="p">,</span> <span class="n">rtol</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">atol</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">equal_nan</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">use_broadcast</span><span class="o">=</span><span class="kc">True</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Test if two numpy arrays are almost equal.&quot;&quot;&quot;</span>
<span class="c1"># pylint: disable=unexpected-keyword-arg</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">use_broadcast</span><span class="p">:</span>
<span class="n">checkShapes</span><span class="p">(</span><span class="n">a</span><span class="p">,</span> <span class="n">b</span><span class="p">)</span>
<span class="k">return</span> <span class="n">np</span><span class="o">.</span><span class="n">allclose</span><span class="p">(</span><span class="n">a</span><span class="p">,</span> <span class="n">b</span><span class="p">,</span> <span class="n">rtol</span><span class="o">=</span><span class="n">get_rtol</span><span class="p">(</span><span class="n">rtol</span><span class="p">),</span> <span class="n">atol</span><span class="o">=</span><span class="n">get_atol</span><span class="p">(</span><span class="n">atol</span><span class="p">),</span> <span class="n">equal_nan</span><span class="o">=</span><span class="n">equal_nan</span><span class="p">)</span></div>
<span class="c1"># pylint: enable=unexpected-keyword-arg</span>
<div class="viewcode-block" id="locationError"><a class="viewcode-back" href="../../api/test_utils/index.html#mxnet.test_utils.locationError">[docs]</a><span class="k">def</span> <span class="nf">locationError</span><span class="p">(</span><span class="n">a</span><span class="p">,</span> <span class="n">b</span><span class="p">,</span> <span class="n">index</span><span class="p">,</span> <span class="n">names</span><span class="p">,</span> <span class="n">maxError</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Create element mismatch comment</span>
<span class="sd"> Parameters</span>
<span class="sd"> ----------</span>
<span class="sd"> a, b : compared np.ndarray&#39;s</span>
<span class="sd"> index : tuple of coordinate arrays</span>
<span class="sd"> Location of violation</span>
<span class="sd"> names : tuple of names</span>
<span class="sd"> The names of compared arrays.</span>
<span class="sd"> maxError: boolean, optional</span>
<span class="sd"> Flag indicating that maximum error is reporting.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">maximum</span> <span class="o">=</span> <span class="s2">&quot;maximum &quot;</span> <span class="k">if</span> <span class="n">maxError</span> <span class="k">else</span> <span class="s2">&quot;&quot;</span>
<span class="k">return</span> <span class="sa">f</span><span class="s2">&quot;Location of </span><span class="si">{</span><span class="n">maximum</span><span class="si">}</span><span class="s2"> error: </span><span class="si">{</span><span class="nb">str</span><span class="p">(</span><span class="n">index</span><span class="p">)</span><span class="si">}</span><span class="s2">, </span><span class="si">{</span><span class="n">names</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span><span class="si">}</span><span class="s2">=</span><span class="si">{</span><span class="n">a</span><span class="p">[</span><span class="n">index</span><span class="p">]</span><span class="si">:</span><span class="s2">.8f</span><span class="si">}</span><span class="s2">, </span><span class="si">{</span><span class="n">names</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span><span class="si">}</span><span class="s2">=</span><span class="si">{</span><span class="n">b</span><span class="p">[</span><span class="n">index</span><span class="p">]</span><span class="si">:</span><span class="s2">.8f</span><span class="si">}</span><span class="s2">&quot;</span></div>
<div class="viewcode-block" id="assert_almost_equal"><a class="viewcode-back" href="../../api/test_utils/index.html#mxnet.test_utils.assert_almost_equal">[docs]</a><span class="k">def</span> <span class="nf">assert_almost_equal</span><span class="p">(</span><span class="n">a</span><span class="p">,</span> <span class="n">b</span><span class="p">,</span> <span class="n">rtol</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">atol</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">names</span><span class="o">=</span><span class="p">(</span><span class="s1">&#39;a&#39;</span><span class="p">,</span> <span class="s1">&#39;b&#39;</span><span class="p">),</span> <span class="n">equal_nan</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span>
<span class="n">use_broadcast</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">mismatches</span><span class="o">=</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="w"> </span><span class="sd">&quot;&quot;&quot;Test that two numpy arrays are almost equal. Raise exception message if not.</span>
<span class="sd"> Parameters</span>
<span class="sd"> ----------</span>
<span class="sd"> a : np.ndarray or mx.nd.array</span>
<span class="sd"> b : np.ndarray or mx.nd.array</span>
<span class="sd"> rtol : None or float or dict of dtype -&gt; float</span>
<span class="sd"> The relative threshold. Default threshold will be used if set to ``None``.</span>
<span class="sd"> atol : None or float or dict of dtype -&gt; float</span>
<span class="sd"> The absolute threshold. Default threshold will be used if set to ``None``.</span>
<span class="sd"> names : tuple of names, optional</span>
<span class="sd"> The names used in error message when an exception occurs</span>
<span class="sd"> equal_nan : boolean, optional</span>
<span class="sd"> The flag determining how to treat NAN values in comparison</span>
<span class="sd"> mismatches : tuple of mismatches</span>
<span class="sd"> Maximum number of mismatches to be printed (mismatches[0]) and determine (mismatches[1])</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">use_broadcast</span><span class="p">:</span>
<span class="n">checkShapes</span><span class="p">(</span><span class="n">a</span><span class="p">,</span> <span class="n">b</span><span class="p">)</span>
<span class="n">rtol</span><span class="p">,</span> <span class="n">atol</span> <span class="o">=</span> <span class="n">get_tols</span><span class="p">(</span><span class="n">a</span><span class="p">,</span> <span class="n">b</span><span class="p">,</span> <span class="n">rtol</span><span class="p">,</span> <span class="n">atol</span><span class="p">)</span>
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">a</span><span class="p">,</span> <span class="n">mx</span><span class="o">.</span><span class="n">numpy</span><span class="o">.</span><span class="n">ndarray</span><span class="p">):</span>
<span class="n">a</span> <span class="o">=</span> <span class="n">a</span><span class="o">.</span><span class="n">asnumpy</span><span class="p">()</span>
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">b</span><span class="p">,</span> <span class="n">mx</span><span class="o">.</span><span class="n">numpy</span><span class="o">.</span><span class="n">ndarray</span><span class="p">):</span>
<span class="n">b</span> <span class="o">=</span> <span class="n">b</span><span class="o">.</span><span class="n">asnumpy</span><span class="p">()</span>
<span class="n">use_np_allclose</span> <span class="o">=</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">a</span><span class="p">,</span> <span class="n">np</span><span class="o">.</span><span class="n">ndarray</span><span class="p">)</span> <span class="ow">and</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">b</span><span class="p">,</span> <span class="n">np</span><span class="o">.</span><span class="n">ndarray</span><span class="p">)</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">use_np_allclose</span><span class="p">:</span>
<span class="k">if</span> <span class="ow">not</span> <span class="p">(</span><span class="nb">hasattr</span><span class="p">(</span><span class="n">a</span><span class="p">,</span> <span class="s1">&#39;ctx&#39;</span><span class="p">)</span> <span class="ow">and</span> <span class="nb">hasattr</span><span class="p">(</span><span class="n">b</span><span class="p">,</span> <span class="s1">&#39;ctx&#39;</span><span class="p">)</span> <span class="ow">and</span> <span class="n">a</span><span class="o">.</span><span class="n">device</span> <span class="o">==</span> <span class="n">b</span><span class="o">.</span><span class="n">device</span> <span class="ow">and</span> <span class="n">a</span><span class="o">.</span><span class="n">dtype</span> <span class="o">==</span> <span class="n">b</span><span class="o">.</span><span class="n">dtype</span><span class="p">):</span>
<span class="n">use_np_allclose</span> <span class="o">=</span> <span class="kc">True</span>
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">a</span><span class="p">,</span> <span class="n">mx</span><span class="o">.</span><span class="n">nd</span><span class="o">.</span><span class="n">NDArray</span><span class="p">):</span>
<span class="n">a</span> <span class="o">=</span> <span class="n">a</span><span class="o">.</span><span class="n">asnumpy</span><span class="p">()</span>
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">b</span><span class="p">,</span> <span class="n">mx</span><span class="o">.</span><span class="n">nd</span><span class="o">.</span><span class="n">NDArray</span><span class="p">):</span>
<span class="n">b</span> <span class="o">=</span> <span class="n">b</span><span class="o">.</span><span class="n">asnumpy</span><span class="p">()</span>
<span class="k">if</span> <span class="n">use_np_allclose</span><span class="p">:</span>
<span class="k">if</span> <span class="nb">hasattr</span><span class="p">(</span><span class="n">a</span><span class="p">,</span> <span class="s1">&#39;dtype&#39;</span><span class="p">)</span> <span class="ow">and</span> <span class="n">a</span><span class="o">.</span><span class="n">dtype</span> <span class="o">==</span> <span class="n">np</span><span class="o">.</span><span class="n">bool_</span> <span class="ow">and</span> <span class="nb">hasattr</span><span class="p">(</span><span class="n">b</span><span class="p">,</span> <span class="s1">&#39;dtype&#39;</span><span class="p">)</span> <span class="ow">and</span> <span class="n">b</span><span class="o">.</span><span class="n">dtype</span> <span class="o">==</span> <span class="n">np</span><span class="o">.</span><span class="n">bool_</span><span class="p">:</span>
<span class="n">np</span><span class="o">.</span><span class="n">testing</span><span class="o">.</span><span class="n">assert_equal</span><span class="p">(</span><span class="n">a</span><span class="p">,</span> <span class="n">b</span><span class="p">)</span>
<span class="k">return</span>
<span class="k">if</span> <span class="n">almost_equal</span><span class="p">(</span><span class="n">a</span><span class="p">,</span> <span class="n">b</span><span class="p">,</span> <span class="n">rtol</span><span class="p">,</span> <span class="n">atol</span><span class="p">,</span> <span class="n">equal_nan</span><span class="o">=</span><span class="n">equal_nan</span><span class="p">):</span>
<span class="k">return</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">output</span> <span class="o">=</span> <span class="n">mx</span><span class="o">.</span><span class="n">nd</span><span class="o">.</span><span class="n">contrib</span><span class="o">.</span><span class="n">allclose</span><span class="p">(</span><span class="n">a</span><span class="p">,</span> <span class="n">b</span><span class="p">,</span> <span class="n">rtol</span><span class="p">,</span> <span class="n">atol</span><span class="p">,</span> <span class="n">equal_nan</span><span class="p">)</span>
<span class="k">if</span> <span class="n">output</span><span class="o">.</span><span class="n">asnumpy</span><span class="p">()</span> <span class="o">==</span> <span class="mi">1</span><span class="p">:</span>
<span class="k">return</span>
<span class="n">a</span> <span class="o">=</span> <span class="n">a</span><span class="o">.</span><span class="n">asnumpy</span><span class="p">()</span>
<span class="n">b</span> <span class="o">=</span> <span class="n">b</span><span class="o">.</span><span class="n">asnumpy</span><span class="p">()</span>
<span class="n">index</span><span class="p">,</span> <span class="n">rel</span> <span class="o">=</span> <span class="n">_find_max_violation</span><span class="p">(</span><span class="n">a</span><span class="p">,</span> <span class="n">b</span><span class="p">,</span> <span class="n">rtol</span><span class="p">,</span> <span class="n">atol</span><span class="p">)</span>
<span class="k">if</span> <span class="n">index</span> <span class="o">!=</span> <span class="p">():</span>
<span class="c1"># a, b are the numpy arrays</span>
<span class="n">indexErr</span> <span class="o">=</span> <span class="n">index</span>
<span class="n">relErr</span> <span class="o">=</span> <span class="n">rel</span>
<span class="nb">print</span><span class="p">(</span><span class="s1">&#39;</span><span class="se">\n</span><span class="s1">*** Maximum errors for vector of size </span><span class="si">{}</span><span class="s1">: rtol=</span><span class="si">{}</span><span class="s1">, atol=</span><span class="si">{}</span><span class="se">\n</span><span class="s1">&#39;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">a</span><span class="o">.</span><span class="n">size</span><span class="p">,</span> <span class="n">rtol</span><span class="p">,</span> <span class="n">atol</span><span class="p">))</span>
<span class="n">aTmp</span> <span class="o">=</span> <span class="n">a</span><span class="o">.</span><span class="n">copy</span><span class="p">()</span>
<span class="n">bTmp</span> <span class="o">=</span> <span class="n">b</span><span class="o">.</span><span class="n">copy</span><span class="p">()</span>
<span class="n">i</span> <span class="o">=</span> <span class="mi">1</span>
<span class="k">while</span> <span class="n">i</span> <span class="o">&lt;=</span> <span class="n">a</span><span class="o">.</span><span class="n">size</span><span class="p">:</span>
<span class="k">if</span> <span class="n">i</span> <span class="o">&lt;=</span> <span class="n">mismatches</span><span class="p">[</span><span class="mi">0</span><span class="p">]:</span>
<span class="nb">print</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="n">i</span><span class="si">:</span><span class="s2">3d</span><span class="si">}</span><span class="s2">: Error </span><span class="si">{</span><span class="n">rel</span><span class="si">}</span><span class="s2"> </span><span class="si">{</span><span class="n">locationError</span><span class="p">(</span><span class="n">a</span><span class="p">,</span><span class="w"> </span><span class="n">b</span><span class="p">,</span><span class="w"> </span><span class="n">index</span><span class="p">,</span><span class="w"> </span><span class="n">names</span><span class="p">)</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">)</span>
<span class="n">aTmp</span><span class="p">[</span><span class="n">index</span><span class="p">]</span> <span class="o">=</span> <span class="n">bTmp</span><span class="p">[</span><span class="n">index</span><span class="p">]</span> <span class="o">=</span> <span class="mi">0</span>
<span class="k">if</span> <span class="n">almost_equal</span><span class="p">(</span><span class="n">aTmp</span><span class="p">,</span> <span class="n">bTmp</span><span class="p">,</span> <span class="n">rtol</span><span class="p">,</span> <span class="n">atol</span><span class="p">,</span> <span class="n">equal_nan</span><span class="o">=</span><span class="n">equal_nan</span><span class="p">):</span>
<span class="k">break</span>
<span class="n">i</span> <span class="o">+=</span> <span class="mi">1</span>
<span class="k">if</span> <span class="n">i</span> <span class="o">&lt;=</span> <span class="n">mismatches</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span> <span class="ow">or</span> <span class="n">mismatches</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span> <span class="o">&lt;=</span> <span class="mi">0</span><span class="p">:</span>
<span class="n">index</span><span class="p">,</span> <span class="n">rel</span> <span class="o">=</span> <span class="n">_find_max_violation</span><span class="p">(</span><span class="n">aTmp</span><span class="p">,</span> <span class="n">bTmp</span><span class="p">,</span> <span class="n">rtol</span><span class="p">,</span> <span class="n">atol</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">break</span>
<span class="n">mismatchDegree</span> <span class="o">=</span> <span class="s2">&quot;at least &quot;</span> <span class="k">if</span> <span class="n">mismatches</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span> <span class="o">&gt;</span> <span class="mi">0</span> <span class="ow">and</span> <span class="n">i</span> <span class="o">&gt;</span> <span class="n">mismatches</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span> <span class="k">else</span> <span class="s2">&quot;&quot;</span>
<span class="n">errMsg</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">&quot;Error </span><span class="si">{</span><span class="n">relErr</span><span class="si">}</span><span class="s2"> exceeds tolerance rtol=</span><span class="si">{</span><span class="n">rtol</span><span class="si">:</span><span class="s2">e</span><span class="si">}</span><span class="s2">, atol=</span><span class="si">{</span><span class="n">atol</span><span class="si">:</span><span class="s2">e</span><span class="si">}</span><span class="s2"> &quot;</span> \
<span class="sa">f</span><span class="s2">&quot;(mismatch </span><span class="si">{</span><span class="n">mismatchDegree</span><span class="si">}{</span><span class="mi">100</span><span class="o">*</span><span class="n">i</span><span class="o">/</span><span class="n">a</span><span class="o">.</span><span class="n">size</span><span class="si">}</span><span class="s2">%).</span><span class="se">\n</span><span class="s2">&quot;</span> \
<span class="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="n">locationError</span><span class="p">(</span><span class="n">a</span><span class="p">,</span><span class="w"> </span><span class="n">b</span><span class="p">,</span><span class="w"> </span><span class="n">indexErr</span><span class="p">,</span><span class="w"> </span><span class="n">names</span><span class="p">,</span><span class="w"> </span><span class="n">maxError</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span><span class="si">}</span><span class="s2">&quot;</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">errMsg</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">&quot;Error </span><span class="si">{</span><span class="n">rel</span><span class="si">}</span><span class="s2"> exceeds tolerance rtol=</span><span class="si">{</span><span class="n">rtol</span><span class="si">:</span><span class="s2">e</span><span class="si">}</span><span class="s2">, atol=</span><span class="si">{</span><span class="n">atol</span><span class="si">:</span><span class="s2">e</span><span class="si">}</span><span class="s2">.</span><span class="se">\n</span><span class="s2">&quot;</span>
<span class="n">np</span><span class="o">.</span><span class="n">set_printoptions</span><span class="p">(</span><span class="n">threshold</span><span class="o">=</span><span class="mi">4</span><span class="p">,</span> <span class="n">suppress</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
<span class="n">msg</span> <span class="o">=</span> <span class="n">npt</span><span class="o">.</span><span class="n">build_err_msg</span><span class="p">([</span><span class="n">a</span><span class="p">,</span> <span class="n">b</span><span class="p">],</span> <span class="n">err_msg</span><span class="o">=</span><span class="n">errMsg</span><span class="p">)</span>
<span class="k">raise</span> <span class="ne">AssertionError</span><span class="p">(</span><span class="n">msg</span><span class="p">)</span></div>
<span class="k">def</span> <span class="nf">assert_allclose</span><span class="p">(</span><span class="n">a</span><span class="p">,</span> <span class="n">b</span><span class="p">,</span> <span class="n">rtol</span><span class="o">=</span><span class="mf">1e-07</span><span class="p">,</span> <span class="n">atol</span><span class="o">=</span><span class="mi">0</span><span class="p">,</span> <span class="n">equal_nan</span><span class="o">=</span><span class="kc">True</span><span class="p">):</span>
<span class="n">assert_almost_equal</span><span class="p">(</span><span class="n">a</span><span class="p">,</span> <span class="n">b</span><span class="p">,</span> <span class="n">rtol</span><span class="o">=</span><span class="n">rtol</span><span class="p">,</span> <span class="n">atol</span><span class="o">=</span><span class="n">atol</span><span class="p">,</span> <span class="n">equal_nan</span><span class="o">=</span><span class="n">equal_nan</span><span class="p">)</span>
<div class="viewcode-block" id="assert_almost_equal_with_err"><a class="viewcode-back" href="../../api/test_utils/index.html#mxnet.test_utils.assert_almost_equal_with_err">[docs]</a><span class="k">def</span> <span class="nf">assert_almost_equal_with_err</span><span class="p">(</span><span class="n">a</span><span class="p">,</span> <span class="n">b</span><span class="p">,</span> <span class="n">rtol</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">atol</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">etol</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
<span class="n">names</span><span class="o">=</span><span class="p">(</span><span class="s1">&#39;a&#39;</span><span class="p">,</span> <span class="s1">&#39;b&#39;</span><span class="p">),</span> <span class="n">equal_nan</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">mismatches</span><span class="o">=</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="w"> </span><span class="sd">&quot;&quot;&quot;Test that two numpy arrays are almost equal within given error rate. Raise exception message if not.</span>
<span class="sd"> Parameters</span>
<span class="sd"> ----------</span>
<span class="sd"> a : np.ndarray</span>
<span class="sd"> b : np.ndarray</span>
<span class="sd"> rtol : None or float or dict of dtype -&gt; float</span>
<span class="sd"> The relative threshold. Default threshold will be used if set to ``None``.</span>
<span class="sd"> atol : None or float or dict of dtype -&gt; float</span>
<span class="sd"> The absolute threshold. Default threshold will be used if set to ``None``.</span>
<span class="sd"> etol : None or float</span>
<span class="sd"> The error rate threshold. If etol is float, return true if error_rate &lt; etol even if</span>
<span class="sd"> any error is found.</span>
<span class="sd"> names : tuple of names, optional</span>
<span class="sd"> The names used in error message when an exception occurs</span>
<span class="sd"> equal_nan : boolean, optional</span>
<span class="sd"> The flag determining how to treat NAN values in comparison</span>
<span class="sd"> mismatches : tuple of mismatches</span>
<span class="sd"> Maximum number of mismatches to be printed (mismatches[0]) and determine (mismatches[1])</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">etol</span> <span class="o">=</span> <span class="n">get_etol</span><span class="p">(</span><span class="n">etol</span><span class="p">)</span>
<span class="k">if</span> <span class="n">etol</span> <span class="o">&gt;</span> <span class="mi">0</span><span class="p">:</span>
<span class="n">rtol</span><span class="p">,</span> <span class="n">atol</span> <span class="o">=</span> <span class="n">get_tols</span><span class="p">(</span><span class="n">a</span><span class="p">,</span> <span class="n">b</span><span class="p">,</span> <span class="n">rtol</span><span class="p">,</span> <span class="n">atol</span><span class="p">)</span>
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">a</span><span class="p">,</span> <span class="n">mx</span><span class="o">.</span><span class="n">nd</span><span class="o">.</span><span class="n">NDArray</span><span class="p">):</span>
<span class="n">a</span> <span class="o">=</span> <span class="n">a</span><span class="o">.</span><span class="n">asnumpy</span><span class="p">()</span>
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">b</span><span class="p">,</span> <span class="n">mx</span><span class="o">.</span><span class="n">nd</span><span class="o">.</span><span class="n">NDArray</span><span class="p">):</span>
<span class="n">b</span> <span class="o">=</span> <span class="n">b</span><span class="o">.</span><span class="n">asnumpy</span><span class="p">()</span>
<span class="n">equals</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">isclose</span><span class="p">(</span><span class="n">a</span><span class="p">,</span> <span class="n">b</span><span class="p">,</span> <span class="n">rtol</span><span class="o">=</span><span class="n">rtol</span><span class="p">,</span> <span class="n">atol</span><span class="o">=</span><span class="n">atol</span><span class="p">)</span>
<span class="n">err</span> <span class="o">=</span> <span class="mi">1</span> <span class="o">-</span> <span class="n">np</span><span class="o">.</span><span class="n">count_nonzero</span><span class="p">(</span><span class="n">equals</span><span class="p">)</span> <span class="o">/</span> <span class="n">equals</span><span class="o">.</span><span class="n">size</span>
<span class="k">if</span> <span class="n">err</span> <span class="o">&gt;</span> <span class="n">etol</span><span class="p">:</span>
<span class="n">index</span><span class="p">,</span> <span class="n">rel</span> <span class="o">=</span> <span class="n">_find_max_violation</span><span class="p">(</span><span class="n">a</span><span class="p">,</span> <span class="n">b</span><span class="p">,</span> <span class="n">rtol</span><span class="p">,</span> <span class="n">atol</span><span class="p">)</span>
<span class="n">indexErr</span> <span class="o">=</span> <span class="n">index</span>
<span class="n">relErr</span> <span class="o">=</span> <span class="n">rel</span>
<span class="nb">print</span><span class="p">(</span><span class="s1">&#39;</span><span class="se">\n</span><span class="s1">*** Maximum errors for vector of size </span><span class="si">{}</span><span class="s1">: rtol=</span><span class="si">{}</span><span class="s1">, atol=</span><span class="si">{}</span><span class="se">\n</span><span class="s1">&#39;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">a</span><span class="o">.</span><span class="n">size</span><span class="p">,</span> <span class="n">rtol</span><span class="p">,</span> <span class="n">atol</span><span class="p">))</span>
<span class="n">aTmp</span> <span class="o">=</span> <span class="n">a</span><span class="o">.</span><span class="n">copy</span><span class="p">()</span>
<span class="n">bTmp</span> <span class="o">=</span> <span class="n">b</span><span class="o">.</span><span class="n">copy</span><span class="p">()</span>
<span class="n">i</span> <span class="o">=</span> <span class="mi">1</span>
<span class="k">while</span> <span class="n">i</span> <span class="o">&lt;=</span> <span class="n">a</span><span class="o">.</span><span class="n">size</span><span class="p">:</span>
<span class="k">if</span> <span class="n">i</span> <span class="o">&lt;=</span> <span class="n">mismatches</span><span class="p">[</span><span class="mi">0</span><span class="p">]:</span>
<span class="nb">print</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="n">i</span><span class="si">:</span><span class="s2">3d</span><span class="si">}</span><span class="s2">: Error </span><span class="si">{</span><span class="n">rel</span><span class="si">}</span><span class="s2"> </span><span class="si">{</span><span class="n">locationError</span><span class="p">(</span><span class="n">a</span><span class="p">,</span><span class="w"> </span><span class="n">b</span><span class="p">,</span><span class="w"> </span><span class="n">index</span><span class="p">,</span><span class="w"> </span><span class="n">names</span><span class="p">)</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">)</span>
<span class="n">aTmp</span><span class="p">[</span><span class="n">index</span><span class="p">]</span> <span class="o">=</span> <span class="n">bTmp</span><span class="p">[</span><span class="n">index</span><span class="p">]</span> <span class="o">=</span> <span class="mi">0</span>
<span class="k">if</span> <span class="n">almost_equal</span><span class="p">(</span><span class="n">aTmp</span><span class="p">,</span> <span class="n">bTmp</span><span class="p">,</span> <span class="n">rtol</span><span class="p">,</span> <span class="n">atol</span><span class="p">,</span> <span class="n">equal_nan</span><span class="o">=</span><span class="n">equal_nan</span><span class="p">):</span>
<span class="k">break</span>
<span class="n">i</span> <span class="o">+=</span> <span class="mi">1</span>
<span class="k">if</span> <span class="n">i</span> <span class="o">&lt;=</span> <span class="n">mismatches</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span> <span class="ow">or</span> <span class="n">mismatches</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span> <span class="o">&lt;=</span> <span class="mi">0</span><span class="p">:</span>
<span class="n">index</span><span class="p">,</span> <span class="n">rel</span> <span class="o">=</span> <span class="n">_find_max_violation</span><span class="p">(</span><span class="n">aTmp</span><span class="p">,</span> <span class="n">bTmp</span><span class="p">,</span> <span class="n">rtol</span><span class="p">,</span> <span class="n">atol</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">break</span>
<span class="n">mismatchDegree</span> <span class="o">=</span> <span class="s2">&quot;at least &quot;</span> <span class="k">if</span> <span class="n">mismatches</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span> <span class="o">&gt;</span> <span class="mi">0</span> <span class="ow">and</span> <span class="n">i</span> <span class="o">&gt;</span> <span class="n">mismatches</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span> <span class="k">else</span> <span class="s2">&quot;&quot;</span>
<span class="n">errMsg</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">&quot;Error </span><span class="si">{</span><span class="n">relErr</span><span class="si">}</span><span class="s2"> exceeds tolerance rtol=</span><span class="si">{</span><span class="n">rtol</span><span class="si">:</span><span class="s2">e</span><span class="si">}</span><span class="s2">, atol=</span><span class="si">{</span><span class="n">atol</span><span class="si">:</span><span class="s2">e</span><span class="si">}</span><span class="s2"> &quot;</span> \
<span class="sa">f</span><span class="s2">&quot;(mismatch </span><span class="si">{</span><span class="n">mismatchDegree</span><span class="si">}{</span><span class="mi">100</span><span class="o">*</span><span class="n">i</span><span class="o">/</span><span class="n">a</span><span class="o">.</span><span class="n">size</span><span class="si">}</span><span class="s2">%).</span><span class="se">\n</span><span class="s2">&quot;</span> \
<span class="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="n">locationError</span><span class="p">(</span><span class="n">a</span><span class="p">,</span><span class="w"> </span><span class="n">b</span><span class="p">,</span><span class="w"> </span><span class="n">indexErr</span><span class="p">,</span><span class="w"> </span><span class="n">names</span><span class="p">,</span><span class="w"> </span><span class="n">maxError</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span><span class="si">}</span><span class="s2">&quot;</span>
<span class="n">np</span><span class="o">.</span><span class="n">set_printoptions</span><span class="p">(</span><span class="n">threshold</span><span class="o">=</span><span class="mi">4</span><span class="p">,</span> <span class="n">suppress</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
<span class="n">msg</span> <span class="o">=</span> <span class="n">npt</span><span class="o">.</span><span class="n">build_err_msg</span><span class="p">([</span><span class="n">a</span><span class="p">,</span> <span class="n">b</span><span class="p">],</span> <span class="n">err_msg</span><span class="o">=</span><span class="n">errMsg</span><span class="p">)</span>
<span class="k">raise</span> <span class="ne">AssertionError</span><span class="p">(</span><span class="n">msg</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">assert_almost_equal</span><span class="p">(</span><span class="n">a</span><span class="p">,</span> <span class="n">b</span><span class="p">,</span> <span class="n">rtol</span><span class="o">=</span><span class="n">rtol</span><span class="p">,</span> <span class="n">atol</span><span class="o">=</span><span class="n">atol</span><span class="p">,</span> <span class="n">equal_nan</span><span class="o">=</span><span class="n">equal_nan</span><span class="p">)</span></div>
<div class="viewcode-block" id="assert_almost_equal_ignore_nan"><a class="viewcode-back" href="../../api/test_utils/index.html#mxnet.test_utils.assert_almost_equal_ignore_nan">[docs]</a><span class="k">def</span> <span class="nf">assert_almost_equal_ignore_nan</span><span class="p">(</span><span class="n">a</span><span class="p">,</span> <span class="n">b</span><span class="p">,</span> <span class="n">rtol</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">atol</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">names</span><span class="o">=</span><span class="p">(</span><span class="s1">&#39;a&#39;</span><span class="p">,</span> <span class="s1">&#39;b&#39;</span><span class="p">)):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Test that two NumPy arrays are almost equal (ignoring NaN in either array).</span>
<span class="sd"> Combines a relative and absolute measure of approximate eqality.</span>
<span class="sd"> If either the relative or absolute check passes, the arrays are considered equal.</span>
<span class="sd"> Including an absolute check resolves issues with the relative check where all</span>
<span class="sd"> array values are close to zero.</span>
<span class="sd"> Parameters</span>
<span class="sd"> ----------</span>
<span class="sd"> a : np.ndarray</span>
<span class="sd"> b : np.ndarray</span>
<span class="sd"> rtol : None or float</span>
<span class="sd"> The relative threshold. Default threshold will be used if set to ``None``.</span>
<span class="sd"> atol : None or float</span>
<span class="sd"> The absolute threshold. Default threshold will be used if set to ``None``.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">a</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">copy</span><span class="p">(</span><span class="n">a</span><span class="p">)</span>
<span class="n">b</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">copy</span><span class="p">(</span><span class="n">b</span><span class="p">)</span>
<span class="n">nan_mask</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">logical_or</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">isnan</span><span class="p">(</span><span class="n">a</span><span class="p">),</span> <span class="n">np</span><span class="o">.</span><span class="n">isnan</span><span class="p">(</span><span class="n">b</span><span class="p">))</span>
<span class="n">a</span><span class="p">[</span><span class="n">nan_mask</span><span class="p">]</span> <span class="o">=</span> <span class="mi">0</span>
<span class="n">b</span><span class="p">[</span><span class="n">nan_mask</span><span class="p">]</span> <span class="o">=</span> <span class="mi">0</span>
<span class="n">assert_almost_equal</span><span class="p">(</span><span class="n">a</span><span class="p">,</span> <span class="n">b</span><span class="p">,</span> <span class="n">rtol</span><span class="p">,</span> <span class="n">atol</span><span class="p">,</span> <span class="n">names</span><span class="p">)</span></div>
<div class="viewcode-block" id="assert_exception"><a class="viewcode-back" href="../../api/test_utils/index.html#mxnet.test_utils.assert_exception">[docs]</a><span class="k">def</span> <span class="nf">assert_exception</span><span class="p">(</span><span class="n">f</span><span class="p">,</span> <span class="n">exception_type</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Test that function f will throw an exception of type given by `exception_type`&quot;&quot;&quot;</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">f</span><span class="p">(</span><span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
<span class="k">assert</span><span class="p">(</span><span class="kc">False</span><span class="p">)</span>
<span class="k">except</span> <span class="n">exception_type</span><span class="p">:</span>
<span class="k">return</span></div>
<span class="k">def</span> <span class="nf">_parse_location</span><span class="p">(</span><span class="n">sym</span><span class="p">,</span> <span class="n">location</span><span class="p">,</span> <span class="n">ctx</span><span class="p">,</span> <span class="n">dtype</span><span class="o">=</span><span class="n">default_dtype</span><span class="p">()):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Parses the given location to a ordered dictionary.</span>
<span class="sd"> Arguments of the provided op `sym` are used as dictionary keys</span>
<span class="sd"> and elements of `location` are used as values.</span>
<span class="sd"> Parameters</span>
<span class="sd"> ----------</span>
<span class="sd"> sym : Symbol</span>
<span class="sd"> Symbol containing op</span>
<span class="sd"> location : list or tuple or dict</span>
<span class="sd"> Argument values location</span>
<span class="sd"> - if type is list or tuple of `np.ndarray`</span>
<span class="sd"> inner elements are arrays correspoding to</span>
<span class="sd"> ``sym.list_arguments()``.</span>
<span class="sd"> - if type is dict of str -&gt; `np.ndarray`</span>
<span class="sd"> maps the name of arguments to the corresponding `np.ndarray`.</span>
<span class="sd"> *In either case, value of all the arguments must be provided.*</span>
<span class="sd"> ctx : Device</span>
<span class="sd"> Device context.</span>
<span class="sd"> dtype: &quot;asnumpy&quot; or np.float16 or np.float32 or np.float64</span>
<span class="sd"> If dtype is &quot;asnumpy&quot; then the mx.nd.array created will have the same</span>
<span class="sd"> type as th numpy array from which it is copied.</span>
<span class="sd"> Otherwise, dtype is the explicit datatype for all mx.nd.array objects</span>
<span class="sd"> created in this function.</span>
<span class="sd"> Returns</span>
<span class="sd"> -------</span>
<span class="sd"> dict</span>
<span class="sd"> Dictionary with `sym` arguments as keys and `location` elements as</span>
<span class="sd"> values.</span>
<span class="sd"> Examples</span>
<span class="sd"> -------</span>
<span class="sd"> &gt;&gt;&gt; a = mx.symbol.Variable(&#39;a&#39;)</span>
<span class="sd"> &gt;&gt;&gt; b = mx.symbol.Variable(&#39;b&#39;)</span>
<span class="sd"> &gt;&gt;&gt; l1 = np.ndarray([2,3])</span>
<span class="sd"> &gt;&gt;&gt; l2 = np.ndarray([3,4])</span>
<span class="sd"> &gt;&gt;&gt; _parse_location(a * b, [l1, l2], None)</span>
<span class="sd"> {&#39;a&#39;: &lt;NDArray 2x3 @cpu(0)&gt;, &#39;b&#39;: &lt;NDArray 3x4 @cpu(0)&gt;}</span>
<span class="sd"> &gt;&gt;&gt; _parse_location(a * b, {&#39;a&#39;: l1, &#39;b&#39;: l2}, None)</span>
<span class="sd"> {&#39;a&#39;: &lt;NDArray 2x3 @cpu(0)&gt;, &#39;b&#39;: &lt;NDArray 3x4 @cpu(0)&gt;}</span>
<span class="sd"> &gt;&gt;&gt; _parse_location(a * b, {&#39;a&#39;: l1}, None)</span>
<span class="sd"> ValueError: Symbol arguments and keys of the given location do not match.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">assert</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">location</span><span class="p">,</span> <span class="p">(</span><span class="nb">dict</span><span class="p">,</span> <span class="nb">list</span><span class="p">,</span> <span class="nb">tuple</span><span class="p">))</span>
<span class="k">assert</span> <span class="n">dtype</span> <span class="o">==</span> <span class="s2">&quot;asnumpy&quot;</span> <span class="ow">or</span> <span class="n">dtype</span> <span class="ow">in</span> <span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">float16</span><span class="p">,</span> <span class="n">np</span><span class="o">.</span><span class="n">float32</span><span class="p">,</span> <span class="n">np</span><span class="o">.</span><span class="n">float64</span><span class="p">)</span>
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">location</span><span class="p">,</span> <span class="nb">dict</span><span class="p">):</span>
<span class="k">if</span> <span class="nb">set</span><span class="p">(</span><span class="n">location</span><span class="o">.</span><span class="n">keys</span><span class="p">())</span> <span class="o">!=</span> <span class="nb">set</span><span class="p">(</span><span class="n">sym</span><span class="o">.</span><span class="n">list_arguments</span><span class="p">()):</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s2">&quot;Symbol arguments and keys of the given location do not match.&quot;</span>
<span class="sa">f</span><span class="s2">&quot;symbol args:</span><span class="si">{</span><span class="nb">str</span><span class="p">(</span><span class="nb">set</span><span class="p">(</span><span class="n">sym</span><span class="o">.</span><span class="n">list_arguments</span><span class="p">()))</span><span class="si">}</span><span class="s2">, location.keys():</span><span class="si">{</span><span class="nb">str</span><span class="p">(</span><span class="nb">set</span><span class="p">(</span><span class="n">location</span><span class="o">.</span><span class="n">keys</span><span class="p">()))</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">location</span> <span class="o">=</span> <span class="p">{</span><span class="n">k</span><span class="p">:</span> <span class="n">v</span> <span class="k">for</span> <span class="n">k</span><span class="p">,</span> <span class="n">v</span> <span class="ow">in</span> <span class="nb">zip</span><span class="p">(</span><span class="n">sym</span><span class="o">.</span><span class="n">list_arguments</span><span class="p">(),</span> <span class="n">location</span><span class="p">)}</span>
<span class="n">location</span> <span class="o">=</span> <span class="p">{</span><span class="n">k</span><span class="p">:</span> <span class="n">mx</span><span class="o">.</span><span class="n">nd</span><span class="o">.</span><span class="n">array</span><span class="p">(</span><span class="n">v</span><span class="p">,</span> <span class="n">ctx</span><span class="o">=</span><span class="n">ctx</span><span class="p">,</span> <span class="n">dtype</span><span class="o">=</span><span class="n">v</span><span class="o">.</span><span class="n">dtype</span> <span class="k">if</span> <span class="n">dtype</span> <span class="o">==</span> <span class="s2">&quot;asnumpy&quot;</span> <span class="k">else</span> <span class="n">dtype</span><span class="p">)</span> \
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">v</span><span class="p">,</span> <span class="n">np</span><span class="o">.</span><span class="n">ndarray</span><span class="p">)</span> <span class="k">else</span> <span class="n">v</span> <span class="k">for</span> <span class="n">k</span><span class="p">,</span> <span class="n">v</span> <span class="ow">in</span> <span class="n">location</span><span class="o">.</span><span class="n">items</span><span class="p">()}</span>
<span class="k">return</span> <span class="n">_sorted_dict</span><span class="p">(</span><span class="n">location</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">_parse_aux_states</span><span class="p">(</span><span class="n">sym</span><span class="p">,</span> <span class="n">aux_states</span><span class="p">,</span> <span class="n">ctx</span><span class="p">,</span> <span class="n">dtype</span><span class="o">=</span><span class="n">default_dtype</span><span class="p">()):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Parses the given auxiliary states to a dictionary.</span>
<span class="sd"> Auxiliary states of the provided op `sym` are used as dictionary</span>
<span class="sd"> keys and elements of `aux_states` are used as values.</span>
<span class="sd"> Parameters</span>
<span class="sd"> ----------</span>
<span class="sd"> sym : Symbol</span>
<span class="sd"> Symbol containing op</span>
<span class="sd"> aux_states : None or list or dict</span>
<span class="sd"> Aux states</span>
<span class="sd"> - if type is list or tuple of `np.ndarray`</span>
<span class="sd"> inner elements are arrays correspoding to</span>
<span class="sd"> ``sym.list_auxiliary_states()``.</span>
<span class="sd"> - if type is dict of str -&gt; `np.ndarray`</span>
<span class="sd"> maps the name of arguments to the corresponding `np.ndarray`.</span>
<span class="sd"> *In either case, all aux states of `sym` must be provided.*</span>
<span class="sd"> ctx : Device</span>
<span class="sd"> Device context.</span>
<span class="sd"> dtype: &quot;asnumpy&quot; or np.float16 or np.float32 or np.float64</span>
<span class="sd"> If dtype is &quot;asnumpy&quot; then the mx.nd.array created will have the same</span>
<span class="sd"> type as th numpy array from which it is copied.</span>
<span class="sd"> Otherwise, dtype is the explicit datatype for all mx.nd.array objects</span>
<span class="sd"> created in this function.</span>
<span class="sd"> Returns</span>
<span class="sd"> -------</span>
<span class="sd"> dict</span>
<span class="sd"> Dictionary with `sym` aux states as keys and `aux_states` elements</span>
<span class="sd"> as values.</span>
<span class="sd"> Examples</span>
<span class="sd"> -------</span>
<span class="sd"> &gt;&gt;&gt; data = mx.symbol.Variable(&#39;data&#39;)</span>
<span class="sd"> &gt;&gt;&gt; weight = mx.sym.Variable(name=&#39;fc1_weight&#39;)</span>
<span class="sd"> &gt;&gt;&gt; fc1 = mx.symbol.FullyConnected(data = data, weight=weight, name=&#39;fc1&#39;, num_hidden=128)</span>
<span class="sd"> &gt;&gt;&gt; fc2 = mx.symbol.BatchNorm(fc1, name=&#39;batchnorm0&#39;)</span>
<span class="sd"> &gt;&gt;&gt; mean_states = np.ones(3)</span>
<span class="sd"> &gt;&gt;&gt; var_states = np.ones(3)</span>
<span class="sd"> &gt;&gt;&gt; _parse_aux_states(fc2, [mean_states, var_states], None)</span>
<span class="sd"> {&#39;batchnorm0_moving_var&#39;: &lt;NDArray 3 @cpu(0)&gt;, &#39;batchnorm0_moving_mean&#39;: &lt;NDArray 3 @cpu(0)&gt;}</span>
<span class="sd"> &gt;&gt;&gt; _parse_aux_states(fc2, {&#39;batchnorm0_moving_var&#39;: mean_states,</span>
<span class="sd"> ... &#39;batchnorm0_moving_mean&#39;: var_states}, None)</span>
<span class="sd"> {&#39;batchnorm0_moving_var&#39;: &lt;NDArray 3 @cpu(0)&gt;, &#39;batchnorm0_moving_mean&#39;: &lt;NDArray 3 @cpu(0)&gt;}</span>
<span class="sd"> &gt;&gt;&gt; _parse_aux_states(fc2, {&#39;batchnorm0_moving_var&#39;: mean_states}, None)</span>
<span class="sd"> ValueError: Symbol aux_states names and given aux_states do not match.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">assert</span> <span class="n">dtype</span> <span class="o">==</span> <span class="s2">&quot;asnumpy&quot;</span> <span class="ow">or</span> <span class="n">dtype</span> <span class="ow">in</span> <span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">float16</span><span class="p">,</span> <span class="n">np</span><span class="o">.</span><span class="n">float32</span><span class="p">,</span> <span class="n">np</span><span class="o">.</span><span class="n">float64</span><span class="p">)</span>
<span class="k">if</span> <span class="n">aux_states</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">aux_states</span><span class="p">,</span> <span class="nb">dict</span><span class="p">):</span>
<span class="k">if</span> <span class="nb">set</span><span class="p">(</span><span class="n">aux_states</span><span class="o">.</span><span class="n">keys</span><span class="p">())</span> <span class="o">!=</span> <span class="nb">set</span><span class="p">(</span><span class="n">sym</span><span class="o">.</span><span class="n">list_auxiliary_states</span><span class="p">()):</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s2">&quot;Symbol aux_states names and given aux_states do not match.&quot;</span>
<span class="sa">f</span><span class="s2">&quot;symbol aux_names:</span><span class="si">{</span><span class="nb">str</span><span class="p">(</span><span class="nb">set</span><span class="p">(</span><span class="n">sym</span><span class="o">.</span><span class="n">list_auxiliary_states</span><span class="p">()))</span><span class="si">}</span><span class="s2">, aux_states.keys:</span><span class="si">{</span><span class="nb">str</span><span class="p">(</span><span class="nb">set</span><span class="p">(</span><span class="n">aux_states</span><span class="o">.</span><span class="n">keys</span><span class="p">()))</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">)</span>
<span class="k">elif</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">aux_states</span><span class="p">,</span> <span class="p">(</span><span class="nb">list</span><span class="p">,</span> <span class="nb">tuple</span><span class="p">)):</span>
<span class="n">aux_names</span> <span class="o">=</span> <span class="n">sym</span><span class="o">.</span><span class="n">list_auxiliary_states</span><span class="p">()</span>
<span class="n">aux_states</span> <span class="o">=</span> <span class="p">{</span><span class="n">k</span><span class="p">:</span><span class="n">v</span> <span class="k">for</span> <span class="n">k</span><span class="p">,</span> <span class="n">v</span> <span class="ow">in</span> <span class="nb">zip</span><span class="p">(</span><span class="n">aux_names</span><span class="p">,</span> <span class="n">aux_states</span><span class="p">)}</span>
<span class="n">aux_states</span> <span class="o">=</span> <span class="p">{</span><span class="n">k</span><span class="p">:</span> <span class="n">mx</span><span class="o">.</span><span class="n">nd</span><span class="o">.</span><span class="n">array</span><span class="p">(</span><span class="n">v</span><span class="p">,</span> <span class="n">ctx</span><span class="o">=</span><span class="n">ctx</span><span class="p">,</span> <span class="n">dtype</span><span class="o">=</span><span class="n">v</span><span class="o">.</span><span class="n">dtype</span> <span class="k">if</span> <span class="n">dtype</span> <span class="o">==</span> <span class="s2">&quot;asnumpy&quot;</span> <span class="k">else</span> <span class="n">dtype</span><span class="p">)</span> \
<span class="k">for</span> <span class="n">k</span><span class="p">,</span> <span class="n">v</span> <span class="ow">in</span> <span class="n">aux_states</span><span class="o">.</span><span class="n">items</span><span class="p">()}</span>
<span class="k">return</span> <span class="n">aux_states</span>
<div class="viewcode-block" id="numeric_grad"><a class="viewcode-back" href="../../api/test_utils/index.html#mxnet.test_utils.numeric_grad">[docs]</a><span class="k">def</span> <span class="nf">numeric_grad</span><span class="p">(</span><span class="n">executor</span><span class="p">,</span> <span class="n">location</span><span class="p">,</span> <span class="n">aux_states</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">eps</span><span class="o">=</span><span class="mf">1e-4</span><span class="p">,</span>
<span class="n">use_forward_train</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">dtype</span><span class="o">=</span><span class="n">default_dtype</span><span class="p">()):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Calculates a numeric gradient via finite difference method.</span>
<span class="sd"> Class based on Theano&#39;s `theano.gradient.numeric_grad` [1]</span>
<span class="sd"> Parameters</span>
<span class="sd"> ----------</span>
<span class="sd"> executor : Executor</span>
<span class="sd"> Executor that computes the forward pass.</span>
<span class="sd"> location : list of numpy.ndarray or dict of str to numpy.ndarray</span>
<span class="sd"> Argument values used as location to compute gradient</span>
<span class="sd"> Maps the name of arguments to the corresponding numpy.ndarray.</span>
<span class="sd"> Value of all the arguments must be provided.</span>
<span class="sd"> aux_states : None or list of numpy.ndarray or dict of str to numpy.ndarray, optional</span>
<span class="sd"> Auxiliary states values used as location to compute gradient</span>
<span class="sd"> Maps the name of aux_states to the corresponding numpy.ndarray.</span>
<span class="sd"> Value of all the auxiliary arguments must be provided.</span>
<span class="sd"> eps : float, optional</span>
<span class="sd"> Epsilon for the finite-difference method.</span>
<span class="sd"> use_forward_train : bool, optional</span>
<span class="sd"> Whether to use `is_train=True` in testing.</span>
<span class="sd"> dtype: np.float16 or np.float32 or np.float64</span>
<span class="sd"> Datatype for mx.nd.array.</span>
<span class="sd"> References</span>
<span class="sd"> ---------</span>
<span class="sd"> ..[1] https://github.com/Theano/Theano/blob/master/theano/gradient.py</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">def</span> <span class="nf">as_stype</span><span class="p">(</span><span class="n">var</span><span class="p">,</span> <span class="n">stype</span><span class="p">,</span> <span class="n">dtype</span><span class="p">):</span>
<span class="k">return</span> <span class="n">mx</span><span class="o">.</span><span class="n">nd</span><span class="o">.</span><span class="n">cast_storage</span><span class="p">(</span><span class="n">mx</span><span class="o">.</span><span class="n">nd</span><span class="o">.</span><span class="n">array</span><span class="p">(</span><span class="n">var</span><span class="p">,</span> <span class="n">dtype</span><span class="o">=</span><span class="n">dtype</span><span class="p">),</span> <span class="n">stype</span><span class="o">=</span><span class="n">stype</span><span class="p">)</span>
<span class="k">assert</span> <span class="n">dtype</span> <span class="ow">in</span> <span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">float16</span><span class="p">,</span> <span class="n">np</span><span class="o">.</span><span class="n">float32</span><span class="p">,</span> <span class="n">np</span><span class="o">.</span><span class="n">float64</span><span class="p">)</span>
<span class="n">approx_grads</span> <span class="o">=</span> <span class="p">{</span><span class="n">k</span><span class="p">:</span> <span class="n">np</span><span class="o">.</span><span class="n">zeros</span><span class="p">(</span><span class="n">v</span><span class="o">.</span><span class="n">shape</span><span class="p">,</span> <span class="n">dtype</span><span class="o">=</span><span class="n">dtype</span><span class="p">)</span>
<span class="k">for</span> <span class="n">k</span><span class="p">,</span> <span class="n">v</span> <span class="ow">in</span> <span class="n">location</span><span class="o">.</span><span class="n">items</span><span class="p">()}</span>
<span class="k">for</span> <span class="n">k</span><span class="p">,</span> <span class="n">v</span> <span class="ow">in</span> <span class="n">location</span><span class="o">.</span><span class="n">items</span><span class="p">():</span>
<span class="n">stype</span> <span class="o">=</span> <span class="n">executor</span><span class="o">.</span><span class="n">arg_dict</span><span class="p">[</span><span class="n">k</span><span class="p">]</span><span class="o">.</span><span class="n">stype</span>
<span class="k">if</span> <span class="n">stype</span> <span class="o">==</span> <span class="s1">&#39;default&#39;</span><span class="p">:</span>
<span class="n">executor</span><span class="o">.</span><span class="n">arg_dict</span><span class="p">[</span><span class="n">k</span><span class="p">][:]</span> <span class="o">=</span> <span class="n">as_stype</span><span class="p">(</span><span class="n">v</span><span class="p">,</span> <span class="n">stype</span><span class="p">,</span> <span class="n">dtype</span><span class="o">=</span><span class="n">dtype</span><span class="p">)</span>
<span class="k">for</span> <span class="n">k</span> <span class="ow">in</span> <span class="n">location</span><span class="p">:</span>
<span class="n">location</span><span class="p">[</span><span class="n">k</span><span class="p">]</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">asarray</span><span class="p">(</span><span class="n">location</span><span class="p">[</span><span class="n">k</span><span class="p">],</span> <span class="n">order</span><span class="o">=</span><span class="s1">&#39;C&#39;</span><span class="p">)</span>
<span class="k">for</span> <span class="n">k</span><span class="p">,</span> <span class="n">v</span> <span class="ow">in</span> <span class="n">location</span><span class="o">.</span><span class="n">items</span><span class="p">():</span>
<span class="k">if</span> <span class="n">v</span><span class="o">.</span><span class="n">dtype</span><span class="o">.</span><span class="n">kind</span> <span class="o">!=</span> <span class="s1">&#39;f&#39;</span><span class="p">:</span>
<span class="k">continue</span>
<span class="n">stype</span> <span class="o">=</span> <span class="n">executor</span><span class="o">.</span><span class="n">arg_dict</span><span class="p">[</span><span class="n">k</span><span class="p">]</span><span class="o">.</span><span class="n">stype</span>
<span class="n">old_value</span> <span class="o">=</span> <span class="n">v</span><span class="o">.</span><span class="n">copy</span><span class="p">()</span>
<span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="nb">int</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">prod</span><span class="p">(</span><span class="n">v</span><span class="o">.</span><span class="n">shape</span><span class="p">))):</span>
<span class="c1"># inplace update</span>
<span class="n">v</span><span class="o">.</span><span class="n">ravel</span><span class="p">()[</span><span class="n">i</span><span class="p">]</span> <span class="o">+=</span> <span class="n">eps</span><span class="o">/</span><span class="mf">2.0</span>
<span class="n">executor</span><span class="o">.</span><span class="n">arg_dict</span><span class="p">[</span><span class="n">k</span><span class="p">][:]</span> <span class="o">=</span> <span class="n">as_stype</span><span class="p">(</span><span class="n">v</span><span class="p">,</span> <span class="n">stype</span><span class="p">,</span> <span class="n">dtype</span><span class="o">=</span><span class="n">dtype</span><span class="p">)</span>
<span class="k">if</span> <span class="n">aux_states</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="k">for</span> <span class="n">key</span><span class="p">,</span> <span class="n">val</span> <span class="ow">in</span> <span class="n">aux_states</span><span class="o">.</span><span class="n">items</span><span class="p">():</span>
<span class="n">executor</span><span class="o">.</span><span class="n">aux_dict</span><span class="p">[</span><span class="n">key</span><span class="p">][:]</span> <span class="o">=</span> <span class="n">val</span>
<span class="n">executor</span><span class="o">.</span><span class="n">forward</span><span class="p">(</span><span class="n">is_train</span><span class="o">=</span><span class="n">use_forward_train</span><span class="p">)</span>
<span class="n">f_peps</span> <span class="o">=</span> <span class="n">executor</span><span class="o">.</span><span class="n">outputs</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span><span class="o">.</span><span class="n">asnumpy</span><span class="p">()</span>
<span class="n">v</span><span class="o">.</span><span class="n">ravel</span><span class="p">()[</span><span class="n">i</span><span class="p">]</span> <span class="o">-=</span> <span class="n">eps</span>
<span class="n">executor</span><span class="o">.</span><span class="n">arg_dict</span><span class="p">[</span><span class="n">k</span><span class="p">][:]</span> <span class="o">=</span> <span class="n">as_stype</span><span class="p">(</span><span class="n">v</span><span class="p">,</span> <span class="n">stype</span><span class="p">,</span> <span class="n">dtype</span><span class="o">=</span><span class="n">dtype</span><span class="p">)</span>
<span class="k">if</span> <span class="n">aux_states</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="k">for</span> <span class="n">key</span><span class="p">,</span> <span class="n">val</span> <span class="ow">in</span> <span class="n">aux_states</span><span class="o">.</span><span class="n">items</span><span class="p">():</span>
<span class="n">adstype</span> <span class="o">=</span> <span class="n">executor</span><span class="o">.</span><span class="n">aux_dict</span><span class="p">[</span><span class="n">key</span><span class="p">]</span><span class="o">.</span><span class="n">stype</span>
<span class="n">executor</span><span class="o">.</span><span class="n">aux_dict</span><span class="p">[</span><span class="n">key</span><span class="p">][:]</span> <span class="o">=</span> <span class="n">as_stype</span><span class="p">(</span><span class="n">val</span><span class="p">,</span> <span class="n">adstype</span><span class="p">,</span> <span class="n">dtype</span><span class="o">=</span><span class="n">dtype</span><span class="p">)</span>
<span class="n">executor</span><span class="o">.</span><span class="n">forward</span><span class="p">(</span><span class="n">is_train</span><span class="o">=</span><span class="n">use_forward_train</span><span class="p">)</span>
<span class="n">f_neps</span> <span class="o">=</span> <span class="n">executor</span><span class="o">.</span><span class="n">outputs</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span><span class="o">.</span><span class="n">asnumpy</span><span class="p">()</span>
<span class="n">approx_grad</span> <span class="o">=</span> <span class="p">(</span><span class="n">f_peps</span> <span class="o">-</span> <span class="n">f_neps</span><span class="p">)</span><span class="o">.</span><span class="n">sum</span><span class="p">()</span> <span class="o">/</span> <span class="n">eps</span>
<span class="n">approx_grads</span><span class="p">[</span><span class="n">k</span><span class="p">]</span><span class="o">.</span><span class="n">ravel</span><span class="p">()[</span><span class="n">i</span><span class="p">]</span> <span class="o">=</span> <span class="n">approx_grad</span>
<span class="n">v</span><span class="o">.</span><span class="n">ravel</span><span class="p">()[</span><span class="n">i</span><span class="p">]</span> <span class="o">=</span> <span class="n">old_value</span><span class="o">.</span><span class="n">ravel</span><span class="p">()[</span><span class="n">i</span><span class="p">]</span>
<span class="c1"># copy back the original value</span>
<span class="n">executor</span><span class="o">.</span><span class="n">arg_dict</span><span class="p">[</span><span class="n">k</span><span class="p">][:]</span> <span class="o">=</span> <span class="n">as_stype</span><span class="p">(</span><span class="n">old_value</span><span class="p">,</span> <span class="n">stype</span><span class="p">,</span> <span class="n">dtype</span><span class="o">=</span><span class="n">dtype</span><span class="p">)</span>
<span class="k">return</span> <span class="n">approx_grads</span></div>
<div class="viewcode-block" id="check_numeric_gradient"><a class="viewcode-back" href="../../api/test_utils/index.html#mxnet.test_utils.check_numeric_gradient">[docs]</a><span class="k">def</span> <span class="nf">check_numeric_gradient</span><span class="p">(</span><span class="n">sym</span><span class="p">,</span> <span class="n">location</span><span class="p">,</span> <span class="n">aux_states</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">numeric_eps</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">rtol</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
<span class="n">atol</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">grad_nodes</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">use_forward_train</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">ctx</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
<span class="n">grad_stype_dict</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">dtype</span><span class="o">=</span><span class="n">default_dtype</span><span class="p">()):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Verify an operation by checking backward pass via finite difference method.</span>
<span class="sd"> Based on Theano&#39;s `theano.gradient.verify_grad` [1]</span>
<span class="sd"> Parameters</span>
<span class="sd"> ----------</span>
<span class="sd"> sym : Symbol</span>
<span class="sd"> Symbol containing op to test</span>
<span class="sd"> location : list or tuple or dict</span>
<span class="sd"> Argument values used as location to compute gradient</span>
<span class="sd"> - if type is list of numpy.ndarray, \</span>
<span class="sd"> inner elements should have the same order as mxnet.sym.list_arguments().</span>
<span class="sd"> - if type is dict of str -&gt; numpy.ndarray, \</span>
<span class="sd"> maps the name of arguments to the corresponding numpy.ndarray.</span>
<span class="sd"> *In either case, value of all the arguments must be provided.*</span>
<span class="sd"> aux_states : list or tuple or dict, optional</span>
<span class="sd"> The auxiliary states required when generating the executor for the symbol.</span>
<span class="sd"> numeric_eps : float, optional</span>
<span class="sd"> Delta for the finite difference method that approximates the gradient.</span>
<span class="sd"> rtol : None or float</span>
<span class="sd"> The relative threshold. Default threshold will be used if set to ``None``.</span>
<span class="sd"> atol : None or float</span>
<span class="sd"> The absolute threshold. Default threshold will be used if set to ``None``.</span>
<span class="sd"> grad_nodes : None or list or tuple or dict, optional</span>
<span class="sd"> Names of the nodes to check gradient on</span>
<span class="sd"> use_forward_train : bool</span>
<span class="sd"> Whether to use is_train=True when computing the finite-difference.</span>
<span class="sd"> ctx : Context, optional</span>
<span class="sd"> Check the gradient computation on the specified device.</span>
<span class="sd"> grad_stype_dict : dict of str-&gt;str, optional</span>
<span class="sd"> Storage type dictionary for gradient ndarrays.</span>
<span class="sd"> dtype: np.float16 or np.float32 or np.float64</span>
<span class="sd"> Datatype for mx.nd.array.</span>
<span class="sd"> References</span>
<span class="sd"> ---------</span>
<span class="sd"> [1] https://github.com/Theano/Theano/blob/master/theano/gradient.py</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">assert</span> <span class="n">dtype</span> <span class="ow">in</span> <span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">float16</span><span class="p">,</span> <span class="n">np</span><span class="o">.</span><span class="n">float32</span><span class="p">,</span> <span class="n">np</span><span class="o">.</span><span class="n">float64</span><span class="p">)</span>
<span class="k">if</span> <span class="n">ctx</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">ctx</span> <span class="o">=</span> <span class="n">default_device</span><span class="p">()</span>
<span class="k">def</span> <span class="nf">random_projection</span><span class="p">(</span><span class="n">shape</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Get a random weight matrix with not too small elements</span>
<span class="sd"> Parameters</span>
<span class="sd"> ----------</span>
<span class="sd"> shape : list or tuple</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="c1"># random_projection should not have elements too small,</span>
<span class="c1"># otherwise too much precision is lost in numerical gradient</span>
<span class="n">plain</span> <span class="o">=</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="o">*</span><span class="n">shape</span><span class="p">)</span> <span class="o">+</span> <span class="mf">0.1</span>
<span class="k">return</span> <span class="n">plain</span>
<span class="n">location</span> <span class="o">=</span> <span class="n">_parse_location</span><span class="p">(</span><span class="n">sym</span><span class="o">=</span><span class="n">sym</span><span class="p">,</span> <span class="n">location</span><span class="o">=</span><span class="n">location</span><span class="p">,</span> <span class="n">ctx</span><span class="o">=</span><span class="n">ctx</span><span class="p">,</span> <span class="n">dtype</span><span class="o">=</span><span class="n">dtype</span><span class="p">)</span>
<span class="n">location_npy</span> <span class="o">=</span> <span class="p">{</span><span class="n">k</span><span class="p">:</span><span class="n">v</span><span class="o">.</span><span class="n">asnumpy</span><span class="p">()</span> <span class="k">for</span> <span class="n">k</span><span class="p">,</span> <span class="n">v</span> <span class="ow">in</span> <span class="n">location</span><span class="o">.</span><span class="n">items</span><span class="p">()}</span>
<span class="n">aux_states</span> <span class="o">=</span> <span class="n">_parse_aux_states</span><span class="p">(</span><span class="n">sym</span><span class="o">=</span><span class="n">sym</span><span class="p">,</span> <span class="n">aux_states</span><span class="o">=</span><span class="n">aux_states</span><span class="p">,</span> <span class="n">ctx</span><span class="o">=</span><span class="n">ctx</span><span class="p">,</span>
<span class="n">dtype</span><span class="o">=</span><span class="n">dtype</span><span class="p">)</span>
<span class="k">if</span> <span class="n">aux_states</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">aux_states_npy</span> <span class="o">=</span> <span class="p">{</span><span class="n">k</span><span class="p">:</span> <span class="n">v</span><span class="o">.</span><span class="n">asnumpy</span><span class="p">()</span> <span class="k">for</span> <span class="n">k</span><span class="p">,</span> <span class="n">v</span> <span class="ow">in</span> <span class="n">aux_states</span><span class="o">.</span><span class="n">items</span><span class="p">()}</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">aux_states_npy</span> <span class="o">=</span> <span class="kc">None</span>
<span class="k">if</span> <span class="n">grad_nodes</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">grad_nodes</span> <span class="o">=</span> <span class="n">sym</span><span class="o">.</span><span class="n">list_arguments</span><span class="p">()</span>
<span class="n">grad_req</span> <span class="o">=</span> <span class="p">{</span><span class="n">k</span><span class="p">:</span> <span class="s1">&#39;write&#39;</span> <span class="k">for</span> <span class="n">k</span> <span class="ow">in</span> <span class="n">grad_nodes</span><span class="p">}</span>
<span class="k">elif</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">grad_nodes</span><span class="p">,</span> <span class="p">(</span><span class="nb">list</span><span class="p">,</span> <span class="nb">tuple</span><span class="p">)):</span>
<span class="n">grad_nodes</span> <span class="o">=</span> <span class="nb">list</span><span class="p">(</span><span class="n">grad_nodes</span><span class="p">)</span>
<span class="n">grad_req</span> <span class="o">=</span> <span class="p">{</span><span class="n">k</span><span class="p">:</span> <span class="s1">&#39;write&#39;</span> <span class="k">for</span> <span class="n">k</span> <span class="ow">in</span> <span class="n">grad_nodes</span><span class="p">}</span>
<span class="k">elif</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">grad_nodes</span><span class="p">,</span> <span class="nb">dict</span><span class="p">):</span>
<span class="n">grad_req</span> <span class="o">=</span> <span class="n">grad_nodes</span><span class="o">.</span><span class="n">copy</span><span class="p">()</span>
<span class="n">grad_nodes</span> <span class="o">=</span> <span class="n">grad_nodes</span><span class="o">.</span><span class="n">keys</span><span class="p">()</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span>
<span class="n">input_shape</span> <span class="o">=</span> <span class="p">{</span><span class="n">k</span><span class="p">:</span> <span class="n">v</span><span class="o">.</span><span class="n">shape</span> <span class="k">for</span> <span class="n">k</span><span class="p">,</span> <span class="n">v</span> <span class="ow">in</span> <span class="n">location</span><span class="o">.</span><span class="n">items</span><span class="p">()}</span>
<span class="n">_</span><span class="p">,</span> <span class="n">out_shape</span><span class="p">,</span> <span class="n">_</span> <span class="o">=</span> <span class="n">sym</span><span class="o">.</span><span class="n">infer_shape</span><span class="p">(</span><span class="o">**</span><span class="n">input_shape</span><span class="p">)</span>
<span class="n">proj</span> <span class="o">=</span> <span class="n">mx</span><span class="o">.</span><span class="n">sym</span><span class="o">.</span><span class="n">Variable</span><span class="p">(</span><span class="s2">&quot;__random_proj&quot;</span><span class="p">)</span>
<span class="n">is_np_sym</span> <span class="o">=</span> <span class="nb">bool</span><span class="p">(</span><span class="nb">isinstance</span><span class="p">(</span><span class="n">sym</span><span class="p">,</span> <span class="n">np_symbol</span><span class="p">))</span>
<span class="k">if</span> <span class="n">is_np_sym</span><span class="p">:</span> <span class="c1"># convert to np symbol for using element-wise multiplication</span>
<span class="n">proj</span> <span class="o">=</span> <span class="n">proj</span><span class="o">.</span><span class="n">as_np_ndarray</span><span class="p">()</span>
<span class="n">out</span> <span class="o">=</span> <span class="n">sym</span> <span class="o">*</span> <span class="n">proj</span>
<span class="k">if</span> <span class="n">is_np_sym</span><span class="p">:</span> <span class="c1"># convert to classic symbol so that make_loss can be used</span>
<span class="n">out</span> <span class="o">=</span> <span class="n">out</span><span class="o">.</span><span class="n">as_nd_ndarray</span><span class="p">()</span>
<span class="n">out</span> <span class="o">=</span> <span class="n">mx</span><span class="o">.</span><span class="n">sym</span><span class="o">.</span><span class="n">make_loss</span><span class="p">(</span><span class="n">out</span><span class="p">)</span>
<span class="n">location</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">(</span><span class="nb">list</span><span class="p">(</span><span class="n">location</span><span class="o">.</span><span class="n">items</span><span class="p">())</span> <span class="o">+</span>
<span class="p">[(</span><span class="s2">&quot;__random_proj&quot;</span><span class="p">,</span> <span class="n">mx</span><span class="o">.</span><span class="n">nd</span><span class="o">.</span><span class="n">array</span><span class="p">(</span><span class="n">random_projection</span><span class="p">(</span><span class="n">out_shape</span><span class="p">[</span><span class="mi">0</span><span class="p">]),</span>
<span class="n">ctx</span><span class="o">=</span><span class="n">ctx</span><span class="p">,</span> <span class="n">dtype</span><span class="o">=</span><span class="n">dtype</span><span class="p">))])</span>
<span class="n">args_grad_npy</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">([(</span><span class="n">k</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">normal</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="mf">0.01</span><span class="p">,</span> <span class="n">size</span><span class="o">=</span><span class="n">location</span><span class="p">[</span><span class="n">k</span><span class="p">]</span><span class="o">.</span><span class="n">shape</span><span class="p">))</span>
<span class="k">for</span> <span class="n">k</span> <span class="ow">in</span> <span class="n">grad_nodes</span><span class="p">]</span>
<span class="o">+</span> <span class="p">[(</span><span class="s2">&quot;__random_proj&quot;</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">normal</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="mf">0.01</span><span class="p">,</span> <span class="n">size</span><span class="o">=</span><span class="n">out_shape</span><span class="p">[</span><span class="mi">0</span><span class="p">]))])</span>
<span class="n">args_grad</span> <span class="o">=</span> <span class="p">{</span><span class="n">k</span><span class="p">:</span> <span class="n">mx</span><span class="o">.</span><span class="n">nd</span><span class="o">.</span><span class="n">array</span><span class="p">(</span><span class="n">v</span><span class="p">,</span> <span class="n">ctx</span><span class="o">=</span><span class="n">ctx</span><span class="p">,</span> <span class="n">dtype</span><span class="o">=</span><span class="n">dtype</span><span class="p">)</span> <span class="k">for</span> <span class="n">k</span><span class="p">,</span> <span class="n">v</span> <span class="ow">in</span> <span class="n">args_grad_npy</span><span class="o">.</span><span class="n">items</span><span class="p">()}</span>
<span class="k">if</span> <span class="n">grad_stype_dict</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="k">assert</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">grad_stype_dict</span><span class="p">,</span> <span class="nb">dict</span><span class="p">),</span> <span class="s2">&quot;grad_stype_dict must be a dict&quot;</span>
<span class="k">for</span> <span class="n">k</span><span class="p">,</span> <span class="n">v</span> <span class="ow">in</span> <span class="n">grad_stype_dict</span><span class="o">.</span><span class="n">items</span><span class="p">():</span>
<span class="k">if</span> <span class="n">k</span> <span class="ow">in</span> <span class="n">args_grad</span> <span class="ow">and</span> <span class="n">v</span> <span class="ow">in</span> <span class="n">_STORAGE_TYPE_STR_TO_ID</span> <span class="ow">and</span> <span class="n">v</span> <span class="o">!=</span> <span class="s1">&#39;default&#39;</span><span class="p">:</span>
<span class="c1"># create an uninitialized sparse ndarray for executor</span>
<span class="c1"># if the symbolic grad is expected to be zero, it should not be initialized at all</span>
<span class="n">args_grad</span><span class="p">[</span><span class="n">k</span><span class="p">]</span> <span class="o">=</span> <span class="n">mx</span><span class="o">.</span><span class="n">nd</span><span class="o">.</span><span class="n">zeros</span><span class="p">(</span><span class="n">args_grad</span><span class="p">[</span><span class="n">k</span><span class="p">]</span><span class="o">.</span><span class="n">shape</span><span class="p">,</span> <span class="n">args_grad</span><span class="p">[</span><span class="n">k</span><span class="p">]</span><span class="o">.</span><span class="n">context</span><span class="p">,</span>
<span class="n">args_grad</span><span class="p">[</span><span class="n">k</span><span class="p">]</span><span class="o">.</span><span class="n">dtype</span><span class="p">,</span> <span class="n">v</span><span class="p">)</span>
<span class="n">grad_req</span><span class="p">[</span><span class="s2">&quot;__random_proj&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="s1">&#39;write&#39;</span>
<span class="n">executor</span> <span class="o">=</span> <span class="n">out</span><span class="o">.</span><span class="n">_bind</span><span class="p">(</span><span class="n">ctx</span><span class="p">,</span> <span class="n">grad_req</span><span class="o">=</span><span class="n">grad_req</span><span class="p">,</span>
<span class="n">args</span><span class="o">=</span><span class="n">location</span><span class="p">,</span> <span class="n">args_grad</span><span class="o">=</span><span class="n">args_grad</span><span class="p">,</span> <span class="n">aux_states</span><span class="o">=</span><span class="n">aux_states</span><span class="p">)</span>
<span class="n">inps</span> <span class="o">=</span> <span class="n">executor</span><span class="o">.</span><span class="n">arg_arrays</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">inps</span><span class="p">)</span> <span class="o">!=</span> <span class="nb">len</span><span class="p">(</span><span class="n">location</span><span class="p">):</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s2">&quot;Executor arg_arrays and and location len do not match.&quot;</span>
<span class="sa">f</span><span class="s2">&quot;Got </span><span class="si">{</span><span class="nb">len</span><span class="p">(</span><span class="n">inps</span><span class="p">)</span><span class="si">}</span><span class="s2"> inputs and </span><span class="si">{</span><span class="nb">len</span><span class="p">(</span><span class="n">location</span><span class="p">)</span><span class="si">}</span><span class="s2"> locations&quot;</span><span class="p">)</span>
<span class="n">executor</span><span class="o">.</span><span class="n">forward</span><span class="p">(</span><span class="n">is_train</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
<span class="k">assert</span> <span class="nb">len</span><span class="p">(</span><span class="n">executor</span><span class="o">.</span><span class="n">outputs</span><span class="p">)</span> <span class="o">==</span> <span class="mi">1</span>
<span class="n">eps</span> <span class="o">=</span> <span class="n">get_tolerance</span><span class="p">(</span><span class="n">executor</span><span class="o">.</span><span class="n">outputs</span><span class="p">[</span><span class="mi">0</span><span class="p">],</span> <span class="n">numeric_eps</span><span class="p">,</span> <span class="n">default_numeric_eps</span><span class="p">())</span>
<span class="c1"># cannot use finite differences with small eps without high precision</span>
<span class="k">if</span> <span class="n">dtype</span> <span class="ow">in</span> <span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">float32</span><span class="p">,</span> <span class="n">np</span><span class="o">.</span><span class="n">float16</span><span class="p">):</span>
<span class="k">assert</span> <span class="n">eps</span> <span class="o">&gt;=</span> <span class="mf">1e-5</span>
<span class="n">executor</span><span class="o">.</span><span class="n">backward</span><span class="p">()</span>
<span class="n">symbolic_grads</span> <span class="o">=</span> <span class="n">executor</span><span class="o">.</span><span class="n">grad_dict</span>
<span class="n">numeric_gradients</span> <span class="o">=</span> <span class="n">numeric_grad</span><span class="p">(</span>
<span class="n">executor</span><span class="p">,</span> <span class="n">location_npy</span><span class="p">,</span> <span class="n">aux_states_npy</span><span class="p">,</span>
<span class="n">eps</span><span class="o">=</span><span class="n">eps</span><span class="p">,</span> <span class="n">use_forward_train</span><span class="o">=</span><span class="n">use_forward_train</span><span class="p">,</span> <span class="n">dtype</span><span class="o">=</span><span class="n">dtype</span><span class="p">)</span>
<span class="k">for</span> <span class="n">name</span> <span class="ow">in</span> <span class="n">grad_nodes</span><span class="p">:</span>
<span class="n">fd_grad</span> <span class="o">=</span> <span class="n">numeric_gradients</span><span class="p">[</span><span class="n">name</span><span class="p">]</span>
<span class="n">orig_grad</span> <span class="o">=</span> <span class="n">args_grad_npy</span><span class="p">[</span><span class="n">name</span><span class="p">]</span>
<span class="n">sym_grad</span> <span class="o">=</span> <span class="n">symbolic_grads</span><span class="p">[</span><span class="n">name</span><span class="p">]</span>
<span class="k">if</span> <span class="n">grad_req</span><span class="p">[</span><span class="n">name</span><span class="p">]</span> <span class="o">==</span> <span class="s1">&#39;write&#39;</span><span class="p">:</span>
<span class="n">assert_almost_equal</span><span class="p">(</span><span class="n">fd_grad</span><span class="p">,</span> <span class="n">sym_grad</span><span class="p">,</span> <span class="n">rtol</span><span class="p">,</span> <span class="n">atol</span><span class="p">,</span>
<span class="p">(</span><span class="sa">f</span><span class="s2">&quot;NUMERICAL_</span><span class="si">{</span><span class="n">name</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">,</span> <span class="sa">f</span><span class="s2">&quot;BACKWARD_</span><span class="si">{</span><span class="n">name</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">))</span>
<span class="k">elif</span> <span class="n">grad_req</span><span class="p">[</span><span class="n">name</span><span class="p">]</span> <span class="o">==</span> <span class="s1">&#39;add&#39;</span><span class="p">:</span>
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">sym_grad</span><span class="p">,</span> <span class="n">mx</span><span class="o">.</span><span class="n">nd</span><span class="o">.</span><span class="n">NDArray</span><span class="p">):</span>
<span class="n">sym_grad</span> <span class="o">=</span> <span class="n">sym_grad</span><span class="o">.</span><span class="n">asnumpy</span><span class="p">()</span>
<span class="n">assert_almost_equal</span><span class="p">(</span><span class="n">fd_grad</span><span class="p">,</span> <span class="n">sym_grad</span> <span class="o">-</span> <span class="n">orig_grad</span><span class="p">,</span> <span class="n">rtol</span><span class="p">,</span> <span class="n">atol</span><span class="p">,</span>
<span class="p">(</span><span class="sa">f</span><span class="s2">&quot;NUMERICAL_</span><span class="si">{</span><span class="n">name</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">,</span> <span class="sa">f</span><span class="s2">&quot;BACKWARD_</span><span class="si">{</span><span class="n">name</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">))</span>
<span class="k">elif</span> <span class="n">grad_req</span><span class="p">[</span><span class="n">name</span><span class="p">]</span> <span class="o">==</span> <span class="s1">&#39;null&#39;</span><span class="p">:</span>
<span class="k">assert</span> <span class="n">sym_grad</span> <span class="ow">is</span> <span class="kc">None</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;Invalid grad_req </span><span class="si">{</span><span class="n">grad_req</span><span class="p">[</span><span class="n">name</span><span class="p">]</span><span class="si">}</span><span class="s2"> for argument </span><span class="si">{</span><span class="n">name</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">)</span></div>
<div class="viewcode-block" id="check_symbolic_forward"><a class="viewcode-back" href="../../api/test_utils/index.html#mxnet.test_utils.check_symbolic_forward">[docs]</a><span class="k">def</span> <span class="nf">check_symbolic_forward</span><span class="p">(</span><span class="n">sym</span><span class="p">,</span> <span class="n">location</span><span class="p">,</span> <span class="n">expected</span><span class="p">,</span> <span class="n">rtol</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">atol</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
<span class="n">aux_states</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">ctx</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">equal_nan</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span>
<span class="n">dtype</span><span class="o">=</span><span class="n">default_dtype</span><span class="p">()):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Compares a symbol&#39;s forward results with the expected ones.</span>
<span class="sd"> Prints error messages if the forward results are not the same as the expected ones.</span>
<span class="sd"> Parameters</span>
<span class="sd"> ---------</span>
<span class="sd"> sym : Symbol</span>
<span class="sd"> output symbol</span>
<span class="sd"> location : list of np.ndarray or dict of str to np.ndarray</span>
<span class="sd"> The evaluation point</span>
<span class="sd"> - if type is list of np.ndarray</span>
<span class="sd"> Contains all the numpy arrays corresponding to `sym.list_arguments()`.</span>
<span class="sd"> - if type is dict of str to np.ndarray</span>
<span class="sd"> Contains the mapping between argument names and their values.</span>
<span class="sd"> expected : list of np.ndarray or dict of str to np.ndarray</span>
<span class="sd"> The expected output value</span>
<span class="sd"> - if type is list of np.ndarray</span>
<span class="sd"> Contains arrays corresponding to exe.outputs.</span>
<span class="sd"> - if type is dict of str to np.ndarray</span>
<span class="sd"> Contains mapping between sym.list_output() and exe.outputs.</span>
<span class="sd"> rtol : None or float</span>
<span class="sd"> The relative threshold. Default threshold will be used if set to ``None``.</span>
<span class="sd"> atol : None or float</span>
<span class="sd"> The absolute threshold. Default threshold will be used if set to ``None``.</span>
<span class="sd"> aux_states : list of np.ndarray of dict, optional</span>
<span class="sd"> - if type is list of np.ndarray</span>
<span class="sd"> Contains all the NumPy arrays corresponding to sym.list_auxiliary_states</span>
<span class="sd"> - if type is dict of str to np.ndarray</span>
<span class="sd"> Contains the mapping between names of auxiliary states and their values.</span>
<span class="sd"> device : Device, optional</span>
<span class="sd"> running context</span>
<span class="sd"> dtype: &quot;asnumpy&quot; or np.float16 or np.float32 or np.float64</span>
<span class="sd"> If dtype is &quot;asnumpy&quot; then the mx.nd.array created will have the same</span>
<span class="sd"> type as th numpy array from which it is copied.</span>
<span class="sd"> Otherwise, dtype is the explicit datatype for all mx.nd.array objects</span>
<span class="sd"> created in this function.</span>
<span class="sd"> equal_nan: Boolean</span>
<span class="sd"> if True, `nan` is a valid value for checking equivalency (ie `nan` == `nan`)</span>
<span class="sd"> Example</span>
<span class="sd"> -------</span>
<span class="sd"> &gt;&gt;&gt; shape = (2, 2)</span>
<span class="sd"> &gt;&gt;&gt; lhs = mx.symbol.Variable(&#39;lhs&#39;)</span>
<span class="sd"> &gt;&gt;&gt; rhs = mx.symbol.Variable(&#39;rhs&#39;)</span>
<span class="sd"> &gt;&gt;&gt; sym_dot = mx.symbol.dot(lhs, rhs)</span>
<span class="sd"> &gt;&gt;&gt; mat1 = np.array([[1, 2], [3, 4]])</span>
<span class="sd"> &gt;&gt;&gt; mat2 = np.array([[5, 6], [7, 8]])</span>
<span class="sd"> &gt;&gt;&gt; ret_expected = np.array([[19, 22], [43, 50]])</span>
<span class="sd"> &gt;&gt;&gt; check_symbolic_forward(sym_dot, [mat1, mat2], [ret_expected])</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">assert</span> <span class="n">dtype</span> <span class="o">==</span> <span class="s2">&quot;asnumpy&quot;</span> <span class="ow">or</span> <span class="n">dtype</span> <span class="ow">in</span> <span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">float16</span><span class="p">,</span> <span class="n">np</span><span class="o">.</span><span class="n">float32</span><span class="p">,</span> <span class="n">np</span><span class="o">.</span><span class="n">float64</span><span class="p">)</span>
<span class="k">if</span> <span class="n">ctx</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">ctx</span> <span class="o">=</span> <span class="n">default_device</span><span class="p">()</span>
<span class="n">location</span> <span class="o">=</span> <span class="n">_parse_location</span><span class="p">(</span><span class="n">sym</span><span class="o">=</span><span class="n">sym</span><span class="p">,</span> <span class="n">location</span><span class="o">=</span><span class="n">location</span><span class="p">,</span> <span class="n">ctx</span><span class="o">=</span><span class="n">ctx</span><span class="p">,</span> <span class="n">dtype</span><span class="o">=</span><span class="n">dtype</span><span class="p">)</span>
<span class="n">aux_states</span> <span class="o">=</span> <span class="n">_parse_aux_states</span><span class="p">(</span><span class="n">sym</span><span class="o">=</span><span class="n">sym</span><span class="p">,</span> <span class="n">aux_states</span><span class="o">=</span><span class="n">aux_states</span><span class="p">,</span> <span class="n">ctx</span><span class="o">=</span><span class="n">ctx</span><span class="p">,</span>
<span class="n">dtype</span><span class="o">=</span><span class="n">dtype</span><span class="p">)</span>
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">expected</span><span class="p">,</span> <span class="nb">dict</span><span class="p">):</span>
<span class="n">expected</span> <span class="o">=</span> <span class="p">[</span><span class="n">expected</span><span class="p">[</span><span class="n">k</span><span class="p">]</span> <span class="k">for</span> <span class="n">k</span> <span class="ow">in</span> <span class="n">sym</span><span class="o">.</span><span class="n">list_outputs</span><span class="p">()]</span>
<span class="n">args_grad_data</span> <span class="o">=</span> <span class="p">{</span><span class="n">k</span><span class="p">:</span><span class="n">mx</span><span class="o">.</span><span class="n">nd</span><span class="o">.</span><span class="n">empty</span><span class="p">(</span><span class="n">v</span><span class="o">.</span><span class="n">shape</span><span class="p">,</span> <span class="n">ctx</span><span class="o">=</span><span class="n">ctx</span><span class="p">,</span> <span class="n">dtype</span><span class="o">=</span><span class="n">v</span><span class="o">.</span><span class="n">dtype</span> <span class="k">if</span> <span class="n">dtype</span> <span class="o">==</span> <span class="s2">&quot;asnumpy&quot;</span> <span class="k">else</span> <span class="n">dtype</span><span class="p">)</span> \
<span class="k">for</span> <span class="n">k</span><span class="p">,</span> <span class="n">v</span> <span class="ow">in</span> <span class="n">location</span><span class="o">.</span><span class="n">items</span><span class="p">()}</span>
<span class="n">executor</span> <span class="o">=</span> <span class="n">sym</span><span class="o">.</span><span class="n">_bind</span><span class="p">(</span><span class="n">ctx</span><span class="o">=</span><span class="n">ctx</span><span class="p">,</span> <span class="n">args</span><span class="o">=</span><span class="n">location</span><span class="p">,</span> <span class="n">args_grad</span><span class="o">=</span><span class="n">args_grad_data</span><span class="p">,</span> <span class="n">aux_states</span><span class="o">=</span><span class="n">aux_states</span><span class="p">)</span>
<span class="k">for</span> <span class="n">g</span> <span class="ow">in</span> <span class="n">executor</span><span class="o">.</span><span class="n">grad_arrays</span><span class="p">:</span>
<span class="k">if</span> <span class="n">g</span><span class="o">.</span><span class="n">ndim</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>
<span class="n">g</span><span class="p">[()]</span> <span class="o">=</span> <span class="mi">0</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">g</span><span class="p">[:]</span> <span class="o">=</span> <span class="mi">0</span>
<span class="n">executor</span><span class="o">.</span><span class="n">forward</span><span class="p">(</span><span class="n">is_train</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span>
<span class="n">outputs</span> <span class="o">=</span> <span class="n">executor</span><span class="o">.</span><span class="n">outputs</span>
<span class="k">for</span> <span class="n">output_name</span><span class="p">,</span> <span class="n">expect</span><span class="p">,</span> <span class="n">output</span> <span class="ow">in</span> <span class="nb">zip</span><span class="p">(</span><span class="n">sym</span><span class="o">.</span><span class="n">list_outputs</span><span class="p">(),</span> <span class="n">expected</span><span class="p">,</span> <span class="n">outputs</span><span class="p">):</span>
<span class="n">assert_almost_equal</span><span class="p">(</span><span class="n">expect</span><span class="p">,</span> <span class="n">output</span><span class="p">,</span> <span class="n">rtol</span><span class="p">,</span> <span class="n">atol</span><span class="p">,</span>
<span class="p">(</span><span class="sa">f</span><span class="s2">&quot;EXPECTED_</span><span class="si">{</span><span class="n">output_name</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">,</span> <span class="sa">f</span><span class="s2">&quot;FORWARD_</span><span class="si">{</span><span class="n">output_name</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">),</span>
<span class="n">equal_nan</span><span class="o">=</span><span class="n">equal_nan</span><span class="p">)</span>
<span class="k">return</span> <span class="n">executor</span><span class="o">.</span><span class="n">outputs</span></div>
<div class="viewcode-block" id="check_symbolic_backward"><a class="viewcode-back" href="../../api/test_utils/index.html#mxnet.test_utils.check_symbolic_backward">[docs]</a><span class="k">def</span> <span class="nf">check_symbolic_backward</span><span class="p">(</span><span class="n">sym</span><span class="p">,</span> <span class="n">location</span><span class="p">,</span> <span class="n">out_grads</span><span class="p">,</span> <span class="n">expected</span><span class="p">,</span> <span class="n">rtol</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">atol</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
<span class="n">aux_states</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">grad_req</span><span class="o">=</span><span class="s1">&#39;write&#39;</span><span class="p">,</span> <span class="n">ctx</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">grad_stypes</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
<span class="n">equal_nan</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">dtype</span><span class="o">=</span><span class="n">default_dtype</span><span class="p">()):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Compares a symbol&#39;s backward results with the expected ones.</span>
<span class="sd"> Prints error messages if the backward results are not the same as the expected results.</span>
<span class="sd"> Parameters</span>
<span class="sd"> ---------</span>
<span class="sd"> sym : Symbol</span>
<span class="sd"> output symbol</span>
<span class="sd"> location : list of np.ndarray or dict of str to np.ndarray</span>
<span class="sd"> The evaluation point</span>
<span class="sd"> - if type is list of np.ndarray</span>
<span class="sd"> Contains all the NumPy arrays corresponding to ``mx.sym.list_arguments``.</span>
<span class="sd"> - if type is dict of str to np.ndarray</span>
<span class="sd"> Contains the mapping between argument names and their values.</span>
<span class="sd"> out_grads : None or list of np.ndarray or dict of str to np.ndarray</span>
<span class="sd"> NumPys arrays corresponding to sym.outputs for incomming gradient.</span>
<span class="sd"> - if type is list of np.ndarray</span>
<span class="sd"> Contains arrays corresponding to ``exe.outputs``.</span>
<span class="sd"> - if type is dict of str to np.ndarray</span>
<span class="sd"> contains mapping between mxnet.sym.list_output() and Executor.outputs</span>
<span class="sd"> expected : list of np.ndarray or dict of str to np.ndarray</span>
<span class="sd"> expected gradient values</span>
<span class="sd"> - if type is list of np.ndarray</span>
<span class="sd"> Contains arrays corresponding to exe.grad_arrays</span>
<span class="sd"> - if type is dict of str to np.ndarray</span>
<span class="sd"> Contains mapping between ``sym.list_arguments()`` and exe.outputs.</span>
<span class="sd"> rtol : None or float</span>
<span class="sd"> The relative threshold. Default threshold will be used if set to ``None``.</span>
<span class="sd"> atol : None or float</span>
<span class="sd"> The absolute threshold. Default threshold will be used if set to ``None``.</span>
<span class="sd"> aux_states : list of np.ndarray or dict of str to np.ndarray</span>
<span class="sd"> grad_req : str or list of str or dict of str to str, optional</span>
<span class="sd"> Gradient requirements. &#39;write&#39;, &#39;add&#39; or &#39;null&#39;.</span>
<span class="sd"> ctx : Context, optional</span>
<span class="sd"> Running context.</span>
<span class="sd"> grad_stypes: dict of str-&gt;str</span>
<span class="sd"> dictionary of mapping argument name to stype for the gradient</span>
<span class="sd"> equal_nan: Boolean</span>
<span class="sd"> if True, `nan` is a valid value for checking equivalency (ie `nan` == `nan`)</span>
<span class="sd"> dtype: np.float16 or np.float32 or np.float64</span>
<span class="sd"> Datatype for mx.nd.array.</span>
<span class="sd"> Example</span>
<span class="sd"> -------</span>
<span class="sd"> &gt;&gt;&gt; lhs = mx.symbol.Variable(&#39;lhs&#39;)</span>
<span class="sd"> &gt;&gt;&gt; rhs = mx.symbol.Variable(&#39;rhs&#39;)</span>
<span class="sd"> &gt;&gt;&gt; sym_add = mx.symbol.elemwise_add(lhs, rhs)</span>
<span class="sd"> &gt;&gt;&gt; mat1 = np.array([[1, 2], [3, 4]])</span>
<span class="sd"> &gt;&gt;&gt; mat2 = np.array([[5, 6], [7, 8]])</span>
<span class="sd"> &gt;&gt;&gt; grad1 = mx.nd.zeros(shape)</span>
<span class="sd"> &gt;&gt;&gt; grad2 = mx.nd.zeros(shape)</span>
<span class="sd"> &gt;&gt;&gt; exec_add = sym_add._bind(default_device(), args={&#39;lhs&#39;: mat1, &#39;rhs&#39;: mat2},</span>
<span class="sd"> ... args_grad={&#39;lhs&#39;: grad1, &#39;rhs&#39;: grad2}, grad_req={&#39;lhs&#39;: &#39;write&#39;, &#39;rhs&#39;: &#39;write&#39;})</span>
<span class="sd"> &gt;&gt;&gt; exec_add.forward(is_train=True)</span>
<span class="sd"> &gt;&gt;&gt; ograd = mx.nd.ones(shape)</span>
<span class="sd"> &gt;&gt;&gt; grad_expected = ograd.copy().asnumpy()</span>
<span class="sd"> &gt;&gt;&gt; check_symbolic_backward(sym_add, [mat1, mat2], [ograd], [grad_expected, grad_expected])</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">assert</span> <span class="n">dtype</span> <span class="o">==</span> <span class="s1">&#39;asnumpy&#39;</span> <span class="ow">or</span> <span class="n">dtype</span> <span class="ow">in</span> <span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">float16</span><span class="p">,</span> <span class="n">np</span><span class="o">.</span><span class="n">float32</span><span class="p">,</span> <span class="n">np</span><span class="o">.</span><span class="n">float64</span><span class="p">)</span>
<span class="k">if</span> <span class="n">ctx</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">ctx</span> <span class="o">=</span> <span class="n">default_device</span><span class="p">()</span>
<span class="n">location</span> <span class="o">=</span> <span class="n">_parse_location</span><span class="p">(</span><span class="n">sym</span><span class="o">=</span><span class="n">sym</span><span class="p">,</span> <span class="n">location</span><span class="o">=</span><span class="n">location</span><span class="p">,</span> <span class="n">ctx</span><span class="o">=</span><span class="n">ctx</span><span class="p">,</span> <span class="n">dtype</span><span class="o">=</span><span class="n">dtype</span><span class="p">)</span>
<span class="n">aux_states</span> <span class="o">=</span> <span class="n">_parse_aux_states</span><span class="p">(</span><span class="n">sym</span><span class="o">=</span><span class="n">sym</span><span class="p">,</span> <span class="n">aux_states</span><span class="o">=</span><span class="n">aux_states</span><span class="p">,</span> <span class="n">ctx</span><span class="o">=</span><span class="n">ctx</span><span class="p">,</span>
<span class="n">dtype</span><span class="o">=</span><span class="n">dtype</span><span class="p">)</span>
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">expected</span><span class="p">,</span> <span class="p">(</span><span class="nb">list</span><span class="p">,</span> <span class="nb">tuple</span><span class="p">)):</span>
<span class="n">expected</span> <span class="o">=</span> <span class="p">{</span><span class="n">k</span><span class="p">:</span><span class="n">v</span> <span class="k">for</span> <span class="n">k</span><span class="p">,</span> <span class="n">v</span> <span class="ow">in</span> <span class="nb">zip</span><span class="p">(</span><span class="n">sym</span><span class="o">.</span><span class="n">list_arguments</span><span class="p">(),</span> <span class="n">expected</span><span class="p">)}</span>
<span class="c1"># Dirty the output buffer deterministically, for reproducibility.</span>
<span class="n">args_grad_npy</span> <span class="o">=</span> <span class="p">{</span><span class="n">k</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">normal</span><span class="p">(</span><span class="n">size</span><span class="o">=</span><span class="n">v</span><span class="o">.</span><span class="n">shape</span><span class="p">)</span> <span class="k">for</span> <span class="n">k</span><span class="p">,</span> <span class="n">v</span> <span class="ow">in</span> <span class="n">_sorted_items</span><span class="p">(</span><span class="n">expected</span><span class="p">)}</span>
<span class="n">args_grad_data</span> <span class="o">=</span> <span class="p">{}</span>
<span class="k">for</span> <span class="n">k</span><span class="p">,</span> <span class="n">v</span> <span class="ow">in</span> <span class="n">args_grad_npy</span><span class="o">.</span><span class="n">items</span><span class="p">():</span>
<span class="n">nd</span> <span class="o">=</span> <span class="n">mx</span><span class="o">.</span><span class="n">nd</span><span class="o">.</span><span class="n">array</span><span class="p">(</span><span class="n">v</span><span class="p">,</span> <span class="n">ctx</span><span class="o">=</span><span class="n">ctx</span><span class="p">,</span> <span class="n">dtype</span><span class="o">=</span><span class="n">expected</span><span class="p">[</span><span class="n">k</span><span class="p">]</span><span class="o">.</span><span class="n">dtype</span> <span class="k">if</span> <span class="n">dtype</span> <span class="o">==</span> <span class="s2">&quot;asnumpy&quot;</span> <span class="k">else</span> <span class="n">dtype</span><span class="p">)</span>
<span class="k">if</span> <span class="n">grad_stypes</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span> <span class="ow">and</span> <span class="n">k</span> <span class="ow">in</span> <span class="n">grad_stypes</span><span class="p">:</span>
<span class="n">stype</span> <span class="o">=</span> <span class="n">grad_stypes</span><span class="p">[</span><span class="n">k</span><span class="p">]</span>
<span class="k">if</span> <span class="n">stype</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span> <span class="ow">and</span> <span class="n">stype</span> <span class="o">!=</span> <span class="s1">&#39;default&#39;</span><span class="p">:</span>
<span class="n">out</span> <span class="o">=</span> <span class="n">create_sparse_array</span><span class="p">(</span><span class="n">v</span><span class="o">.</span><span class="n">shape</span><span class="p">,</span> <span class="n">stype</span><span class="p">,</span> <span class="n">density</span><span class="o">=</span><span class="mf">0.0</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">out</span> <span class="o">=</span> <span class="n">nd</span>
<span class="n">args_grad_data</span><span class="p">[</span><span class="n">k</span><span class="p">]</span> <span class="o">=</span> <span class="n">out</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">args_grad_data</span><span class="p">[</span><span class="n">k</span><span class="p">]</span> <span class="o">=</span> <span class="n">nd</span>
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">grad_req</span><span class="p">,</span> <span class="nb">str</span><span class="p">):</span>
<span class="n">grad_req</span> <span class="o">=</span> <span class="p">{</span><span class="n">k</span><span class="p">:</span><span class="n">grad_req</span> <span class="k">for</span> <span class="n">k</span> <span class="ow">in</span> <span class="n">sym</span><span class="o">.</span><span class="n">list_arguments</span><span class="p">()}</span>
<span class="k">elif</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">grad_req</span><span class="p">,</span> <span class="p">(</span><span class="nb">list</span><span class="p">,</span> <span class="nb">tuple</span><span class="p">)):</span>
<span class="n">grad_req</span> <span class="o">=</span> <span class="p">{</span><span class="n">k</span><span class="p">:</span><span class="n">v</span> <span class="k">for</span> <span class="n">k</span><span class="p">,</span> <span class="n">v</span> <span class="ow">in</span> <span class="nb">zip</span><span class="p">(</span><span class="n">sym</span><span class="o">.</span><span class="n">list_arguments</span><span class="p">(),</span> <span class="n">grad_req</span><span class="p">)}</span>
<span class="n">executor</span> <span class="o">=</span> <span class="n">sym</span><span class="o">.</span><span class="n">_bind</span><span class="p">(</span><span class="n">ctx</span><span class="o">=</span><span class="n">ctx</span><span class="p">,</span> <span class="n">args</span><span class="o">=</span><span class="n">location</span><span class="p">,</span> <span class="n">args_grad</span><span class="o">=</span><span class="n">args_grad_data</span><span class="p">,</span>
<span class="n">aux_states</span><span class="o">=</span><span class="n">aux_states</span><span class="p">,</span> <span class="n">grad_req</span><span class="o">=</span><span class="n">grad_req</span><span class="p">)</span>
<span class="n">outputs</span> <span class="o">=</span> <span class="n">executor</span><span class="o">.</span><span class="n">forward</span><span class="p">(</span><span class="n">is_train</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">out_grads</span><span class="p">,</span> <span class="p">(</span><span class="nb">tuple</span><span class="p">,</span> <span class="nb">list</span><span class="p">)):</span>
<span class="n">outg</span> <span class="o">=</span> <span class="nb">list</span><span class="p">()</span>
<span class="k">for</span> <span class="n">i</span><span class="p">,</span> <span class="n">arr</span> <span class="ow">in</span> <span class="nb">enumerate</span><span class="p">(</span><span class="n">out_grads</span><span class="p">):</span>
<span class="n">stype</span> <span class="o">=</span> <span class="n">outputs</span><span class="p">[</span><span class="n">i</span><span class="p">]</span><span class="o">.</span><span class="n">stype</span>
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">arr</span><span class="p">,</span> <span class="n">np</span><span class="o">.</span><span class="n">ndarray</span><span class="p">):</span>
<span class="n">dtype</span> <span class="o">=</span> <span class="n">arr</span><span class="o">.</span><span class="n">dtype</span> <span class="k">if</span> <span class="n">dtype</span> <span class="o">==</span> <span class="s2">&quot;asnumpy&quot;</span> <span class="k">else</span> <span class="n">dtype</span>
<span class="n">outg</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">mx</span><span class="o">.</span><span class="n">nd</span><span class="o">.</span><span class="n">array</span><span class="p">(</span><span class="n">arr</span><span class="p">,</span> <span class="n">ctx</span><span class="o">=</span><span class="n">ctx</span><span class="p">,</span> <span class="n">dtype</span><span class="o">=</span><span class="n">dtype</span><span class="p">)</span><span class="o">.</span><span class="n">tostype</span><span class="p">(</span><span class="n">stype</span><span class="p">))</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">outg</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">arr</span><span class="o">.</span><span class="n">tostype</span><span class="p">(</span><span class="n">stype</span><span class="p">))</span>
<span class="n">out_grads</span> <span class="o">=</span> <span class="n">outg</span>
<span class="k">elif</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">out_grads</span><span class="p">,</span> <span class="nb">dict</span><span class="p">):</span>
<span class="n">outg</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">()</span>
<span class="k">for</span> <span class="n">k</span><span class="p">,</span> <span class="n">v</span> <span class="ow">in</span> <span class="n">out_grads</span><span class="o">.</span><span class="n">items</span><span class="p">():</span>
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">v</span><span class="p">,</span> <span class="n">np</span><span class="o">.</span><span class="n">ndarray</span><span class="p">):</span>
<span class="n">dtype</span> <span class="o">=</span> <span class="n">v</span><span class="o">.</span><span class="n">dtype</span> <span class="k">if</span> <span class="n">dtype</span> <span class="o">==</span> <span class="s2">&quot;asnumpy&quot;</span> <span class="k">else</span> <span class="n">dtype</span>
<span class="n">outg</span><span class="p">[</span><span class="n">k</span><span class="p">]</span> <span class="o">=</span> <span class="n">mx</span><span class="o">.</span><span class="n">nd</span><span class="o">.</span><span class="n">array</span><span class="p">(</span><span class="n">v</span><span class="p">,</span> <span class="n">ctx</span><span class="o">=</span><span class="n">ctx</span><span class="p">,</span> <span class="n">dtype</span><span class="o">=</span><span class="n">dtype</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">outg</span><span class="p">[</span><span class="n">k</span><span class="p">]</span> <span class="o">=</span> <span class="n">v</span>
<span class="n">out_grads</span> <span class="o">=</span> <span class="n">outg</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">assert</span> <span class="n">out_grads</span> <span class="ow">is</span> <span class="kc">None</span>
<span class="n">executor</span><span class="o">.</span><span class="n">backward</span><span class="p">(</span><span class="n">out_grads</span><span class="p">)</span>
<span class="n">grads</span> <span class="o">=</span> <span class="n">args_grad_data</span>
<span class="k">for</span> <span class="n">name</span> <span class="ow">in</span> <span class="n">expected</span><span class="p">:</span>
<span class="k">if</span> <span class="n">grad_req</span><span class="p">[</span><span class="n">name</span><span class="p">]</span> <span class="o">==</span> <span class="s1">&#39;write&#39;</span><span class="p">:</span>
<span class="n">assert_almost_equal</span><span class="p">(</span><span class="n">expected</span><span class="p">[</span><span class="n">name</span><span class="p">],</span> <span class="n">grads</span><span class="p">[</span><span class="n">name</span><span class="p">],</span> <span class="n">rtol</span><span class="p">,</span> <span class="n">atol</span><span class="p">,</span>
<span class="p">(</span><span class="sa">f</span><span class="s2">&quot;EXPECTED_</span><span class="si">{</span><span class="n">name</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">,</span> <span class="sa">f</span><span class="s2">&quot;BACKWARD_</span><span class="si">{</span><span class="n">name</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">),</span>
<span class="n">equal_nan</span><span class="o">=</span><span class="n">equal_nan</span><span class="p">)</span>
<span class="k">elif</span> <span class="n">grad_req</span><span class="p">[</span><span class="n">name</span><span class="p">]</span> <span class="o">==</span> <span class="s1">&#39;add&#39;</span><span class="p">:</span>
<span class="n">grad</span> <span class="o">=</span> <span class="n">grads</span><span class="p">[</span><span class="n">name</span><span class="p">]</span><span class="o">.</span><span class="n">asnumpy</span><span class="p">()</span> <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">grads</span><span class="p">[</span><span class="n">name</span><span class="p">],</span> <span class="n">mx</span><span class="o">.</span><span class="n">nd</span><span class="o">.</span><span class="n">NDArray</span><span class="p">)</span> <span class="k">else</span> <span class="n">grads</span><span class="p">[</span><span class="n">name</span><span class="p">]</span>
<span class="n">assert_almost_equal</span><span class="p">(</span><span class="n">expected</span><span class="p">[</span><span class="n">name</span><span class="p">],</span> <span class="n">grad</span> <span class="o">-</span> <span class="n">args_grad_npy</span><span class="p">[</span><span class="n">name</span><span class="p">],</span>
<span class="n">rtol</span><span class="p">,</span> <span class="n">atol</span><span class="p">,</span> <span class="p">(</span><span class="sa">f</span><span class="s2">&quot;EXPECTED_</span><span class="si">{</span><span class="n">name</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">,</span> <span class="sa">f</span><span class="s2">&quot;BACKWARD_</span><span class="si">{</span><span class="n">name</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">),</span>
<span class="n">equal_nan</span><span class="o">=</span><span class="n">equal_nan</span><span class="p">)</span>
<span class="k">elif</span> <span class="n">grad_req</span><span class="p">[</span><span class="n">name</span><span class="p">]</span> <span class="o">==</span> <span class="s1">&#39;null&#39;</span><span class="p">:</span>
<span class="n">assert_almost_equal</span><span class="p">(</span><span class="n">args_grad_npy</span><span class="p">[</span><span class="n">name</span><span class="p">],</span> <span class="n">grads</span><span class="p">[</span><span class="n">name</span><span class="p">],</span>
<span class="n">rtol</span><span class="p">,</span> <span class="n">atol</span><span class="p">,</span> <span class="p">(</span><span class="sa">f</span><span class="s2">&quot;EXPECTED_</span><span class="si">{</span><span class="n">name</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">,</span> <span class="sa">f</span><span class="s2">&quot;BACKWARD_</span><span class="si">{</span><span class="n">name</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">),</span>
<span class="n">equal_nan</span><span class="o">=</span><span class="n">equal_nan</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;Invalid grad_req </span><span class="si">{</span><span class="n">grad_req</span><span class="p">[</span><span class="n">name</span><span class="p">]</span><span class="si">}</span><span class="s2"> for argument </span><span class="si">{</span><span class="n">name</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">)</span>
<span class="k">return</span> <span class="n">args_grad_data</span></div>
<div class="viewcode-block" id="check_speed"><a class="viewcode-back" href="../../api/test_utils/index.html#mxnet.test_utils.check_speed">[docs]</a><span class="k">def</span> <span class="nf">check_speed</span><span class="p">(</span><span class="n">sym</span><span class="p">,</span> <span class="n">location</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">ctx</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">N</span><span class="o">=</span><span class="mi">20</span><span class="p">,</span> <span class="n">grad_req</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">typ</span><span class="o">=</span><span class="s2">&quot;whole&quot;</span><span class="p">,</span>
<span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Check the running speed of a symbol.</span>
<span class="sd"> Parameters</span>
<span class="sd"> ----------</span>
<span class="sd"> sym : Symbol</span>
<span class="sd"> Symbol to run the speed test.</span>
<span class="sd"> location : none or dict of str to np.ndarray</span>
<span class="sd"> Location to evaluate the inner executor.</span>
<span class="sd"> ctx : Context</span>
<span class="sd"> Running context.</span>
<span class="sd"> N : int, optional</span>
<span class="sd"> Repeat times.</span>
<span class="sd"> grad_req : None or str or list of str or dict of str to str, optional</span>
<span class="sd"> Gradient requirements.</span>
<span class="sd"> typ : str, optional</span>
<span class="sd"> &quot;whole&quot; or &quot;forward&quot;</span>
<span class="sd"> - &quot;whole&quot;</span>
<span class="sd"> Test the forward_backward speed.</span>
<span class="sd"> - &quot;forward&quot;</span>
<span class="sd"> Only test the forward speed.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">if</span> <span class="n">ctx</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">ctx</span> <span class="o">=</span> <span class="n">default_device</span><span class="p">()</span>
<span class="k">if</span> <span class="n">grad_req</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">grad_req</span> <span class="o">=</span> <span class="s1">&#39;write&#39;</span>
<span class="k">if</span> <span class="n">location</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">exe</span> <span class="o">=</span> <span class="n">sym</span><span class="o">.</span><span class="n">_simple_bind</span><span class="p">(</span><span class="n">grad_req</span><span class="o">=</span><span class="n">grad_req</span><span class="p">,</span> <span class="n">ctx</span><span class="o">=</span><span class="n">ctx</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
<span class="n">location</span> <span class="o">=</span> <span class="p">{</span><span class="n">k</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">normal</span><span class="p">(</span><span class="n">size</span><span class="o">=</span><span class="n">arr</span><span class="o">.</span><span class="n">shape</span><span class="p">,</span> <span class="n">scale</span><span class="o">=</span><span class="mf">1.0</span><span class="p">)</span> <span class="k">for</span> <span class="n">k</span><span class="p">,</span> <span class="n">arr</span> <span class="ow">in</span>
<span class="n">exe</span><span class="o">.</span><span class="n">arg_dict</span><span class="o">.</span><span class="n">items</span><span class="p">()}</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">assert</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">location</span><span class="p">,</span> <span class="nb">dict</span><span class="p">),</span> <span class="sa">f</span><span class="s1">&#39;Expect dict, get &quot;location&quot;=</span><span class="si">{</span><span class="nb">str</span><span class="p">(</span><span class="n">location</span><span class="p">)</span><span class="si">}</span><span class="s1">&#39;</span>
<span class="n">exe</span> <span class="o">=</span> <span class="n">sym</span><span class="o">.</span><span class="n">_simple_bind</span><span class="p">(</span><span class="n">grad_req</span><span class="o">=</span><span class="n">grad_req</span><span class="p">,</span> <span class="n">ctx</span><span class="o">=</span><span class="n">ctx</span><span class="p">,</span>
<span class="o">**</span><span class="p">{</span><span class="n">k</span><span class="p">:</span> <span class="n">v</span><span class="o">.</span><span class="n">shape</span> <span class="k">for</span> <span class="n">k</span><span class="p">,</span> <span class="n">v</span> <span class="ow">in</span> <span class="n">location</span><span class="o">.</span><span class="n">items</span><span class="p">()})</span>
<span class="k">for</span> <span class="n">name</span><span class="p">,</span> <span class="n">iarr</span> <span class="ow">in</span> <span class="n">location</span><span class="o">.</span><span class="n">items</span><span class="p">():</span>
<span class="n">exe</span><span class="o">.</span><span class="n">arg_dict</span><span class="p">[</span><span class="n">name</span><span class="p">][:]</span> <span class="o">=</span> <span class="n">iarr</span><span class="o">.</span><span class="n">astype</span><span class="p">(</span><span class="n">exe</span><span class="o">.</span><span class="n">arg_dict</span><span class="p">[</span><span class="n">name</span><span class="p">]</span><span class="o">.</span><span class="n">dtype</span><span class="p">)</span>
<span class="k">if</span> <span class="n">typ</span> <span class="o">==</span> <span class="s2">&quot;whole&quot;</span><span class="p">:</span>
<span class="c1"># Warm up</span>
<span class="n">exe</span><span class="o">.</span><span class="n">forward</span><span class="p">(</span><span class="n">is_train</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
<span class="n">exe</span><span class="o">.</span><span class="n">backward</span><span class="p">(</span><span class="n">out_grads</span><span class="o">=</span><span class="n">exe</span><span class="o">.</span><span class="n">outputs</span><span class="p">)</span>
<span class="k">for</span> <span class="n">output</span> <span class="ow">in</span> <span class="n">exe</span><span class="o">.</span><span class="n">outputs</span><span class="p">:</span>
<span class="n">output</span><span class="o">.</span><span class="n">wait_to_read</span><span class="p">()</span>
<span class="c1"># Test forward + backward</span>
<span class="n">tic</span> <span class="o">=</span> <span class="n">time</span><span class="o">.</span><span class="n">time</span><span class="p">()</span>
<span class="k">for</span> <span class="n">_</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="n">N</span><span class="p">):</span>
<span class="n">exe</span><span class="o">.</span><span class="n">forward</span><span class="p">(</span><span class="n">is_train</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
<span class="n">exe</span><span class="o">.</span><span class="n">backward</span><span class="p">(</span><span class="n">out_grads</span><span class="o">=</span><span class="n">exe</span><span class="o">.</span><span class="n">outputs</span><span class="p">)</span>
<span class="n">mx</span><span class="o">.</span><span class="n">nd</span><span class="o">.</span><span class="n">waitall</span><span class="p">()</span>
<span class="n">toc</span> <span class="o">=</span> <span class="n">time</span><span class="o">.</span><span class="n">time</span><span class="p">()</span>
<span class="n">forward_backward_time</span> <span class="o">=</span> <span class="p">(</span><span class="n">toc</span> <span class="o">-</span> <span class="n">tic</span><span class="p">)</span> <span class="o">*</span> <span class="mf">1.0</span> <span class="o">/</span> <span class="n">N</span>
<span class="k">return</span> <span class="n">forward_backward_time</span>
<span class="k">elif</span> <span class="n">typ</span> <span class="o">==</span> <span class="s2">&quot;forward&quot;</span><span class="p">:</span>
<span class="c1"># Warm up</span>
<span class="n">exe</span><span class="o">.</span><span class="n">forward</span><span class="p">(</span><span class="n">is_train</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span>
<span class="k">for</span> <span class="n">output</span> <span class="ow">in</span> <span class="n">exe</span><span class="o">.</span><span class="n">outputs</span><span class="p">:</span>
<span class="n">output</span><span class="o">.</span><span class="n">wait_to_read</span><span class="p">()</span>
<span class="c1"># Test forward only</span>
<span class="n">tic</span> <span class="o">=</span> <span class="n">time</span><span class="o">.</span><span class="n">time</span><span class="p">()</span>
<span class="k">for</span> <span class="n">_</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="n">N</span><span class="p">):</span>
<span class="n">exe</span><span class="o">.</span><span class="n">forward</span><span class="p">(</span><span class="n">is_train</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span>
<span class="n">mx</span><span class="o">.</span><span class="n">nd</span><span class="o">.</span><span class="n">waitall</span><span class="p">()</span>
<span class="n">toc</span> <span class="o">=</span> <span class="n">time</span><span class="o">.</span><span class="n">time</span><span class="p">()</span>
<span class="n">forward_time</span> <span class="o">=</span> <span class="p">(</span><span class="n">toc</span> <span class="o">-</span> <span class="n">tic</span><span class="p">)</span> <span class="o">*</span> <span class="mf">1.0</span> <span class="o">/</span> <span class="n">N</span>
<span class="k">return</span> <span class="n">forward_time</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s1">&#39;typ can only be &quot;whole&quot; or &quot;forward&quot;.&#39;</span><span class="p">)</span></div>
<div class="viewcode-block" id="check_consistency"><a class="viewcode-back" href="../../api/test_utils/index.html#mxnet.test_utils.check_consistency">[docs]</a><span class="k">def</span> <span class="nf">check_consistency</span><span class="p">(</span><span class="n">sym</span><span class="p">,</span> <span class="n">ctx_list</span><span class="p">,</span> <span class="n">scale</span><span class="o">=</span><span class="mf">1.0</span><span class="p">,</span> <span class="n">grad_req</span><span class="o">=</span><span class="s1">&#39;write&#39;</span><span class="p">,</span>
<span class="n">arg_params</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">aux_params</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">rtol</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">atol</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
<span class="n">raise_on_err</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">ground_truth</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">equal_nan</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span>
<span class="n">use_uniform</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">rand_type</span><span class="o">=</span><span class="n">np</span><span class="o">.</span><span class="n">float64</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Check symbol gives the same output for different running context</span>
<span class="sd"> Parameters</span>
<span class="sd"> ----------</span>
<span class="sd"> sym : Symbol or list of Symbols</span>
<span class="sd"> Symbol(s) to run the consistency test.</span>
<span class="sd"> ctx_list : list</span>
<span class="sd"> Running context. See example for more detail.</span>
<span class="sd"> scale : float, optional</span>
<span class="sd"> Standard deviation of the inner normal distribution. Used in initialization.</span>
<span class="sd"> grad_req : str or list of str or dict of str to str</span>
<span class="sd"> Gradient requirement.</span>
<span class="sd"> arg_params : dict of input name -&gt; input data</span>
<span class="sd"> data to use for non-aux inputs</span>
<span class="sd"> aux_params : dict of input name -&gt; input data</span>
<span class="sd"> data to use for aux inputs</span>
<span class="sd"> rtol : float or dictionary dtype-&gt;float, optional</span>
<span class="sd"> The relative error tolerance.</span>
<span class="sd"> atol : float or dictionary dtype-&gt;float, optional</span>
<span class="sd"> The absolute error tolerance.</span>
<span class="sd"> raise_on_err : bool, optional, defaults to True</span>
<span class="sd"> Should an error raise an exception (or just output exception message)</span>
<span class="sd"> ground_truth : dict of output name -&gt; data, optional</span>
<span class="sd"> Provided ideal result to be compared against</span>
<span class="sd"> equal_nan : bool, optional, defaults to False</span>
<span class="sd"> Should nans be treated as equal in the comparison</span>
<span class="sd"> use_uniform: bool</span>
<span class="sd"> Optional, When flag set to true,</span>
<span class="sd"> random input data generated follows uniform distribution,</span>
<span class="sd"> not normal distribution</span>
<span class="sd"> rand_type: np.dtype</span>
<span class="sd"> casts the randomly generated data to this type</span>
<span class="sd"> Optional, when input data is passed via arg_params,</span>
<span class="sd"> defaults to np.float64 (numpy float default)</span>
<span class="sd"> Examples</span>
<span class="sd"> --------</span>
<span class="sd"> &gt;&gt;&gt; # create the symbol</span>
<span class="sd"> &gt;&gt;&gt; sym = mx.sym.Convolution(num_filter=3, kernel=(3,3), name=&#39;conv&#39;)</span>
<span class="sd"> &gt;&gt;&gt; # initialize the running context</span>
<span class="sd"> &gt;&gt;&gt; ctx_list =\</span>
<span class="sd">[{&#39;ctx&#39;: mx.gpu(0), &#39;conv_data&#39;: (2, 2, 10, 10), &#39;type_dict&#39;: {&#39;conv_data&#39;: np.float64}},\</span>
<span class="sd"> {&#39;ctx&#39;: mx.gpu(0), &#39;conv_data&#39;: (2, 2, 10, 10), &#39;type_dict&#39;: {&#39;conv_data&#39;: np.float32}},\</span>
<span class="sd"> {&#39;ctx&#39;: mx.gpu(0), &#39;conv_data&#39;: (2, 2, 10, 10), &#39;type_dict&#39;: {&#39;conv_data&#39;: np.float16}},\</span>
<span class="sd"> {&#39;ctx&#39;: mx.cpu(0), &#39;conv_data&#39;: (2, 2, 10, 10), &#39;type_dict&#39;: {&#39;conv_data&#39;: np.float64}},\</span>
<span class="sd"> {&#39;ctx&#39;: mx.cpu(0), &#39;conv_data&#39;: (2, 2, 10, 10), &#39;type_dict&#39;: {&#39;conv_data&#39;: np.float32}}]</span>
<span class="sd"> &gt;&gt;&gt; check_consistency(sym, ctx_list)</span>
<span class="sd"> &gt;&gt;&gt; sym = mx.sym.Concat(name=&#39;concat&#39;, num_args=2)</span>
<span class="sd"> &gt;&gt;&gt; ctx_list = \</span>
<span class="sd">[{&#39;ctx&#39;: mx.gpu(0), &#39;concat_arg1&#39;: (2, 10), &#39;concat_arg0&#39;: (2, 10),\</span>
<span class="sd"> &#39;type_dict&#39;: {&#39;concat_arg0&#39;: np.float64, &#39;concat_arg1&#39;: np.float64}},\</span>
<span class="sd"> {&#39;ctx&#39;: mx.gpu(0), &#39;concat_arg1&#39;: (2, 10), &#39;concat_arg0&#39;: (2, 10),\</span>
<span class="sd"> &#39;type_dict&#39;: {&#39;concat_arg0&#39;: np.float32, &#39;concat_arg1&#39;: np.float32}},\</span>
<span class="sd"> {&#39;ctx&#39;: mx.gpu(0), &#39;concat_arg1&#39;: (2, 10), &#39;concat_arg0&#39;: (2, 10),\</span>
<span class="sd"> &#39;type_dict&#39;: {&#39;concat_arg0&#39;: np.float16, &#39;concat_arg1&#39;: np.float16}},\</span>
<span class="sd"> {&#39;ctx&#39;: mx.cpu(0), &#39;concat_arg1&#39;: (2, 10), &#39;concat_arg0&#39;: (2, 10),\</span>
<span class="sd"> &#39;type_dict&#39;: {&#39;concat_arg0&#39;: np.float64, &#39;concat_arg1&#39;: np.float64}},\</span>
<span class="sd"> {&#39;ctx&#39;: mx.cpu(0), &#39;concat_arg1&#39;: (2, 10), &#39;concat_arg0&#39;: (2, 10),\</span>
<span class="sd"> &#39;type_dict&#39;: {&#39;concat_arg0&#39;: np.float32, &#39;concat_arg1&#39;: np.float32}}]</span>
<span class="sd"> &gt;&gt;&gt; check_consistency(sym, ctx_list)</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">assert</span> <span class="nb">len</span><span class="p">(</span><span class="n">ctx_list</span><span class="p">)</span> <span class="o">&gt;</span> <span class="mi">1</span>
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">sym</span><span class="p">,</span> <span class="n">Symbol</span><span class="p">):</span>
<span class="n">sym</span> <span class="o">=</span> <span class="p">[</span><span class="n">sym</span><span class="p">]</span><span class="o">*</span><span class="nb">len</span><span class="p">(</span><span class="n">ctx_list</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">assert</span> <span class="nb">len</span><span class="p">(</span><span class="n">sym</span><span class="p">)</span> <span class="o">==</span> <span class="nb">len</span><span class="p">(</span><span class="n">ctx_list</span><span class="p">)</span>
<span class="n">output_names</span> <span class="o">=</span> <span class="n">sym</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span><span class="o">.</span><span class="n">list_outputs</span><span class="p">()</span>
<span class="n">arg_names</span> <span class="o">=</span> <span class="n">sym</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span><span class="o">.</span><span class="n">list_arguments</span><span class="p">()</span>
<span class="n">exe_list</span> <span class="o">=</span> <span class="p">[]</span>
<span class="k">for</span> <span class="n">s</span><span class="p">,</span> <span class="n">ctx</span> <span class="ow">in</span> <span class="nb">zip</span><span class="p">(</span><span class="n">sym</span><span class="p">,</span> <span class="n">ctx_list</span><span class="p">):</span>
<span class="k">assert</span> <span class="n">s</span><span class="o">.</span><span class="n">list_arguments</span><span class="p">()</span> <span class="o">==</span> <span class="n">arg_names</span>
<span class="k">assert</span> <span class="n">s</span><span class="o">.</span><span class="n">list_outputs</span><span class="p">()</span> <span class="o">==</span> <span class="n">output_names</span>
<span class="n">exe_list</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">s</span><span class="o">.</span><span class="n">_simple_bind</span><span class="p">(</span><span class="n">grad_req</span><span class="o">=</span><span class="n">grad_req</span><span class="p">,</span> <span class="o">**</span><span class="n">ctx</span><span class="p">))</span>
<span class="n">arg_params</span> <span class="o">=</span> <span class="p">{}</span> <span class="k">if</span> <span class="n">arg_params</span> <span class="ow">is</span> <span class="kc">None</span> <span class="k">else</span> <span class="n">arg_params</span>
<span class="n">aux_params</span> <span class="o">=</span> <span class="p">{}</span> <span class="k">if</span> <span class="n">aux_params</span> <span class="ow">is</span> <span class="kc">None</span> <span class="k">else</span> <span class="n">aux_params</span>
<span class="c1"># returns the least precise of two dtypes</span>
<span class="k">def</span> <span class="nf">smaller_dtype</span><span class="p">(</span><span class="n">dt1</span><span class="p">,</span> <span class="n">dt2</span><span class="p">):</span>
<span class="k">return</span> <span class="n">dt1</span> <span class="k">if</span> <span class="n">dt2</span> <span class="ow">is</span> <span class="kc">None</span> <span class="ow">or</span> <span class="n">np</span><span class="o">.</span><span class="n">dtype</span><span class="p">(</span><span class="n">dt1</span><span class="p">)</span><span class="o">.</span><span class="n">itemsize</span> <span class="o">&lt;</span> <span class="n">np</span><span class="o">.</span><span class="n">dtype</span><span class="p">(</span><span class="n">dt2</span><span class="p">)</span><span class="o">.</span><span class="n">itemsize</span> <span class="k">else</span> <span class="n">dt2</span>
<span class="c1"># It&#39;s important to assign random inputs in a deterministic order, for reproducibility.</span>
<span class="k">for</span> <span class="n">n</span><span class="p">,</span> <span class="n">arr</span> <span class="ow">in</span> <span class="n">_sorted_items</span><span class="p">(</span><span class="n">exe_list</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span><span class="o">.</span><span class="n">arg_dict</span><span class="p">):</span>
<span class="k">if</span> <span class="n">n</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">arg_params</span><span class="p">:</span>
<span class="k">if</span> <span class="n">use_uniform</span><span class="p">:</span>
<span class="n">arg_params</span><span class="p">[</span><span class="n">n</span><span class="p">]</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">random</span><span class="o">.</span><span class="n">uniform</span><span class="p">(</span><span class="n">low</span><span class="o">=-</span><span class="mf">0.92</span> <span class="o">*</span> <span class="n">scale</span><span class="p">,</span> <span class="n">high</span><span class="o">=</span><span class="mf">0.92</span> <span class="o">*</span> <span class="n">scale</span><span class="p">,</span>
<span class="n">size</span><span class="o">=</span><span class="n">arr</span><span class="o">.</span><span class="n">shape</span><span class="p">)</span><span class="o">.</span><span class="n">astype</span><span class="p">(</span><span class="n">rand_type</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">arg_params</span><span class="p">[</span><span class="n">n</span><span class="p">]</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">random</span><span class="o">.</span><span class="n">normal</span><span class="p">(</span><span class="n">size</span><span class="o">=</span><span class="n">arr</span><span class="o">.</span><span class="n">shape</span><span class="p">,</span>
<span class="n">scale</span><span class="o">=</span><span class="n">scale</span><span class="p">)</span><span class="o">.</span><span class="n">astype</span><span class="p">(</span><span class="n">rand_type</span><span class="p">)</span>
<span class="k">for</span> <span class="n">n</span> <span class="ow">in</span> <span class="n">exe_list</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span><span class="o">.</span><span class="n">aux_dict</span><span class="p">:</span>
<span class="k">if</span> <span class="n">n</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">aux_params</span><span class="p">:</span>
<span class="n">aux_params</span><span class="p">[</span><span class="n">n</span><span class="p">]</span> <span class="o">=</span> <span class="mi">0</span>
<span class="k">for</span> <span class="n">exe</span> <span class="ow">in</span> <span class="n">exe_list</span><span class="p">:</span>
<span class="k">for</span> <span class="n">name</span><span class="p">,</span> <span class="n">arr</span> <span class="ow">in</span> <span class="n">exe</span><span class="o">.</span><span class="n">arg_dict</span><span class="o">.</span><span class="n">items</span><span class="p">():</span>
<span class="n">arr</span><span class="p">[:]</span> <span class="o">=</span> <span class="n">arg_params</span><span class="p">[</span><span class="n">name</span><span class="p">]</span>
<span class="k">for</span> <span class="n">name</span><span class="p">,</span> <span class="n">arr</span> <span class="ow">in</span> <span class="n">exe</span><span class="o">.</span><span class="n">aux_dict</span><span class="o">.</span><span class="n">items</span><span class="p">():</span>
<span class="n">arr</span><span class="p">[:]</span> <span class="o">=</span> <span class="n">aux_params</span><span class="p">[</span><span class="n">name</span><span class="p">]</span>
<span class="c1"># We need to initialize the gradient arrays if it&#39;s add.</span>
<span class="k">if</span> <span class="p">(</span><span class="n">grad_req</span> <span class="o">==</span> <span class="s2">&quot;add&quot;</span><span class="p">):</span>
<span class="k">for</span> <span class="n">arr</span> <span class="ow">in</span> <span class="n">exe</span><span class="o">.</span><span class="n">grad_arrays</span><span class="p">:</span>
<span class="n">arr</span><span class="p">[:]</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">zeros</span><span class="p">(</span><span class="n">arr</span><span class="o">.</span><span class="n">shape</span><span class="p">,</span> <span class="n">dtype</span><span class="o">=</span><span class="n">arr</span><span class="o">.</span><span class="n">dtype</span><span class="p">)</span>
<span class="c1"># test</span>
<span class="k">for</span> <span class="n">exe</span> <span class="ow">in</span> <span class="n">exe_list</span><span class="p">:</span>
<span class="n">exe</span><span class="o">.</span><span class="n">forward</span><span class="p">(</span><span class="n">is_train</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span>
<span class="n">dtypes</span> <span class="o">=</span> <span class="p">[</span><span class="n">np</span><span class="o">.</span><span class="n">dtype</span><span class="p">(</span><span class="n">exe</span><span class="o">.</span><span class="n">outputs</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span><span class="o">.</span><span class="n">dtype</span><span class="p">)</span> <span class="k">for</span> <span class="n">exe</span> <span class="ow">in</span> <span class="n">exe_list</span><span class="p">]</span>
<span class="c1"># Select the ground truth as the first model having the highest precision output[0]</span>
<span class="n">gt_idx</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">argmax</span><span class="p">(</span><span class="n">dtypes</span><span class="p">)</span>
<span class="n">gt</span> <span class="o">=</span> <span class="n">ground_truth</span>
<span class="k">if</span> <span class="n">gt</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">gt</span> <span class="o">=</span> <span class="n">exe_list</span><span class="p">[</span><span class="n">gt_idx</span><span class="p">]</span><span class="o">.</span><span class="n">output_dict</span><span class="o">.</span><span class="n">copy</span><span class="p">()</span>
<span class="k">for</span> <span class="n">i</span><span class="p">,</span> <span class="n">exe</span> <span class="ow">in</span> <span class="nb">enumerate</span><span class="p">(</span><span class="n">exe_list</span><span class="p">):</span>
<span class="k">if</span> <span class="n">i</span> <span class="o">==</span> <span class="n">gt_idx</span><span class="p">:</span>
<span class="k">continue</span>
<span class="k">for</span> <span class="n">name</span><span class="p">,</span> <span class="n">arr</span> <span class="ow">in</span> <span class="nb">zip</span><span class="p">(</span><span class="n">output_names</span><span class="p">,</span> <span class="n">exe</span><span class="o">.</span><span class="n">outputs</span><span class="p">):</span>
<span class="n">gtarr</span> <span class="o">=</span> <span class="n">gt</span><span class="p">[</span><span class="n">name</span><span class="p">]</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">assert_almost_equal</span><span class="p">(</span><span class="n">arr</span><span class="p">,</span> <span class="n">gtarr</span><span class="p">,</span> <span class="n">rtol</span><span class="o">=</span><span class="n">rtol</span><span class="p">,</span> <span class="n">atol</span><span class="o">=</span><span class="n">atol</span><span class="p">,</span> <span class="n">equal_nan</span><span class="o">=</span><span class="n">equal_nan</span><span class="p">)</span>
<span class="k">except</span> <span class="ne">AssertionError</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span>
<span class="nb">print</span><span class="p">(</span><span class="sa">f</span><span class="s1">&#39;Predict Err: ctx </span><span class="si">{</span><span class="n">i</span><span class="si">}</span><span class="s1"> vs ctx </span><span class="si">{</span><span class="n">gt_idx</span><span class="si">}</span><span class="s1"> at </span><span class="si">{</span><span class="n">name</span><span class="si">}</span><span class="s1">&#39;</span><span class="p">)</span>
<span class="n">traceback</span><span class="o">.</span><span class="n">print_exc</span><span class="p">()</span>
<span class="k">if</span> <span class="n">raise_on_err</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">e</span>
<span class="nb">print</span><span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="n">e</span><span class="p">))</span>
<span class="c1"># train</span>
<span class="k">if</span> <span class="n">grad_req</span> <span class="o">!=</span> <span class="s1">&#39;null&#39;</span><span class="p">:</span>
<span class="c1"># Perform forward()</span>
<span class="k">for</span> <span class="n">exe</span> <span class="ow">in</span> <span class="n">exe_list</span><span class="p">:</span>
<span class="n">exe</span><span class="o">.</span><span class="n">forward</span><span class="p">(</span><span class="n">is_train</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
<span class="c1"># Use the first executor&#39;s output data, cast to the least precise dtype,</span>
<span class="c1"># as the gradient data to pass to all executor&#39;s backward() call.</span>
<span class="n">least_precise_dtype</span> <span class="o">=</span> <span class="p">[</span><span class="n">out</span><span class="o">.</span><span class="n">dtype</span> <span class="k">for</span> <span class="n">out</span> <span class="ow">in</span> <span class="n">exe_list</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span><span class="o">.</span><span class="n">outputs</span><span class="p">]</span>
<span class="k">for</span> <span class="n">exe</span> <span class="ow">in</span> <span class="n">exe_list</span><span class="p">:</span>
<span class="n">least_precise_dtype</span> <span class="o">=</span> <span class="p">[</span><span class="n">smaller_dtype</span><span class="p">(</span><span class="n">out1</span><span class="o">.</span><span class="n">dtype</span><span class="p">,</span> <span class="n">dt</span><span class="p">)</span> \
<span class="k">for</span> <span class="p">(</span><span class="n">out1</span><span class="p">,</span> <span class="n">dt</span><span class="p">)</span> <span class="ow">in</span> <span class="nb">zip</span><span class="p">(</span><span class="n">exe</span><span class="o">.</span><span class="n">outputs</span><span class="p">,</span> <span class="n">least_precise_dtype</span><span class="p">)]</span>
<span class="n">golden_data_np</span> <span class="o">=</span> <span class="p">[</span><span class="n">out</span><span class="o">.</span><span class="n">astype</span><span class="p">(</span><span class="n">dt</span><span class="p">)</span><span class="o">.</span><span class="n">asnumpy</span><span class="p">()</span> \
<span class="k">for</span> <span class="p">(</span><span class="n">out</span><span class="p">,</span> <span class="n">dt</span><span class="p">)</span> <span class="ow">in</span> <span class="nb">zip</span><span class="p">(</span><span class="n">exe_list</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span><span class="o">.</span><span class="n">outputs</span><span class="p">,</span> <span class="n">least_precise_dtype</span><span class="p">)]</span>
<span class="c1"># Perform backward()</span>
<span class="k">for</span> <span class="n">exe</span> <span class="ow">in</span> <span class="n">exe_list</span><span class="p">:</span>
<span class="n">out_grads</span> <span class="o">=</span> <span class="p">[</span><span class="n">mx</span><span class="o">.</span><span class="n">nd</span><span class="o">.</span><span class="n">array</span><span class="p">(</span><span class="n">golden_np</span><span class="p">,</span> <span class="n">ctx</span><span class="o">=</span><span class="n">exe</span><span class="o">.</span><span class="n">_device</span><span class="p">,</span>
<span class="n">dtype</span><span class="o">=</span><span class="n">out</span><span class="o">.</span><span class="n">dtype</span><span class="p">)</span><span class="o">.</span><span class="n">tostype</span><span class="p">(</span><span class="n">out</span><span class="o">.</span><span class="n">stype</span><span class="p">)</span>
<span class="k">for</span> <span class="p">(</span><span class="n">golden_np</span><span class="p">,</span> <span class="n">out</span><span class="p">)</span> <span class="ow">in</span> <span class="nb">zip</span><span class="p">(</span><span class="n">golden_data_np</span><span class="p">,</span> <span class="n">exe</span><span class="o">.</span><span class="n">outputs</span><span class="p">)]</span>
<span class="n">exe</span><span class="o">.</span><span class="n">backward</span><span class="p">(</span><span class="n">out_grads</span><span class="p">)</span>
<span class="n">gt</span> <span class="o">=</span> <span class="n">ground_truth</span>
<span class="k">if</span> <span class="n">gt</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">gt</span> <span class="o">=</span> <span class="n">exe_list</span><span class="p">[</span><span class="n">gt_idx</span><span class="p">]</span><span class="o">.</span><span class="n">output_dict</span><span class="o">.</span><span class="n">copy</span><span class="p">()</span>
<span class="k">if</span> <span class="n">grad_req</span> <span class="o">!=</span> <span class="s1">&#39;null&#39;</span><span class="p">:</span>
<span class="n">gt</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="n">exe_list</span><span class="p">[</span><span class="n">gt_idx</span><span class="p">]</span><span class="o">.</span><span class="n">grad_dict</span><span class="p">)</span>
<span class="k">for</span> <span class="n">i</span><span class="p">,</span> <span class="n">exe</span> <span class="ow">in</span> <span class="nb">enumerate</span><span class="p">(</span><span class="n">exe_list</span><span class="p">):</span>
<span class="k">if</span> <span class="n">i</span> <span class="o">==</span> <span class="n">gt_idx</span><span class="p">:</span>
<span class="k">continue</span>
<span class="n">curr</span> <span class="o">=</span> <span class="nb">zip</span><span class="p">(</span><span class="n">output_names</span> <span class="o">+</span> <span class="n">arg_names</span><span class="p">,</span> <span class="n">exe</span><span class="o">.</span><span class="n">outputs</span> <span class="o">+</span> <span class="n">exe</span><span class="o">.</span><span class="n">grad_arrays</span><span class="p">)</span>
<span class="k">for</span> <span class="n">name</span><span class="p">,</span> <span class="n">arr</span> <span class="ow">in</span> <span class="n">curr</span><span class="p">:</span>
<span class="k">if</span> <span class="n">gt</span><span class="p">[</span><span class="n">name</span><span class="p">]</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="k">assert</span> <span class="n">arr</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">,</span> <span class="n">name</span>
<span class="k">continue</span>
<span class="n">gtarr</span> <span class="o">=</span> <span class="n">gt</span><span class="p">[</span><span class="n">name</span><span class="p">]</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">rt</span><span class="p">,</span> <span class="n">at</span> <span class="o">=</span> <span class="n">rtol</span><span class="p">,</span> <span class="n">atol</span>
<span class="c1"># If the primary data i/o type is float16, then the tolerance used when</span>
<span class="c1"># comparing a float32 input gradient (e.g. batchnorm gamma) should be float16.</span>
<span class="n">smaller_arr_dtype</span> <span class="o">=</span> <span class="n">smaller_dtype</span><span class="p">(</span><span class="n">arr</span><span class="o">.</span><span class="n">dtype</span><span class="p">,</span> <span class="n">dtypes</span><span class="p">[</span><span class="n">i</span><span class="p">])</span>
<span class="n">smaller_gt_dtype</span> <span class="o">=</span> <span class="n">smaller_dtype</span><span class="p">(</span><span class="n">gtarr</span><span class="o">.</span><span class="n">dtype</span><span class="p">,</span> <span class="n">dtypes</span><span class="p">[</span><span class="n">gt_idx</span><span class="p">])</span>
<span class="k">if</span> <span class="n">smaller_arr_dtype</span> <span class="o">!=</span> <span class="n">arr</span><span class="o">.</span><span class="n">dtype</span> <span class="ow">or</span> \
<span class="n">smaller_gt_dtype</span> <span class="o">!=</span> <span class="n">gtarr</span><span class="o">.</span><span class="n">dtype</span><span class="p">:</span>
<span class="n">rt</span><span class="p">,</span> <span class="n">at</span> <span class="o">=</span> <span class="n">get_tols</span><span class="p">(</span><span class="n">arr</span><span class="o">.</span><span class="n">astype</span><span class="p">(</span><span class="n">smaller_arr_dtype</span><span class="p">),</span>
<span class="n">gtarr</span><span class="o">.</span><span class="n">astype</span><span class="p">(</span><span class="n">smaller_gt_dtype</span><span class="p">),</span> <span class="n">rtol</span><span class="p">,</span> <span class="n">atol</span><span class="p">)</span>
<span class="n">assert_almost_equal</span><span class="p">(</span><span class="n">arr</span><span class="p">,</span> <span class="n">gtarr</span><span class="p">,</span> <span class="n">rtol</span><span class="o">=</span><span class="n">rt</span><span class="p">,</span> <span class="n">atol</span><span class="o">=</span><span class="n">at</span><span class="p">,</span> <span class="n">equal_nan</span><span class="o">=</span><span class="n">equal_nan</span><span class="p">)</span>
<span class="k">except</span> <span class="ne">AssertionError</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span>
<span class="nb">print</span><span class="p">(</span><span class="s1">&#39;Train Err: </span><span class="si">{}</span><span class="s1"> </span><span class="si">{}</span><span class="s1"> ctx </span><span class="si">{}</span><span class="s1"> vs </span><span class="si">{}</span><span class="s1"> </span><span class="si">{}</span><span class="s1"> ctx </span><span class="si">{}</span><span class="s1"> at </span><span class="si">{}</span><span class="s1">&#39;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
<span class="n">get_dtype_name</span><span class="p">(</span><span class="n">arr</span><span class="o">.</span><span class="n">dtype</span><span class="p">),</span> <span class="n">arr</span><span class="o">.</span><span class="n">device</span><span class="p">,</span> <span class="n">i</span><span class="p">,</span>
<span class="n">get_dtype_name</span><span class="p">(</span><span class="n">gtarr</span><span class="o">.</span><span class="n">dtype</span><span class="p">),</span> <span class="n">gtarr</span><span class="o">.</span><span class="n">device</span><span class="p">,</span> <span class="n">gt_idx</span><span class="p">,</span> <span class="n">name</span><span class="p">))</span>
<span class="n">traceback</span><span class="o">.</span><span class="n">print_exc</span><span class="p">()</span>
<span class="k">if</span> <span class="n">raise_on_err</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">e</span>
<span class="nb">print</span><span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="n">e</span><span class="p">))</span>
<span class="k">return</span> <span class="n">gt</span></div>
<div class="viewcode-block" id="list_gpus"><a class="viewcode-back" href="../../api/test_utils/index.html#mxnet.test_utils.list_gpus">[docs]</a><span class="k">def</span> <span class="nf">list_gpus</span><span class="p">():</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Return a list of GPUs</span>
<span class="sd"> Returns</span>
<span class="sd"> -------</span>
<span class="sd"> list of int:</span>
<span class="sd"> If there are n GPUs, then return a list [0,1,...,n-1]. Otherwise returns</span>
<span class="sd"> [].</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">return</span> <span class="nb">range</span><span class="p">(</span><span class="n">mx</span><span class="o">.</span><span class="n">util</span><span class="o">.</span><span class="n">get_gpu_count</span><span class="p">())</span></div>
<div class="viewcode-block" id="download"><a class="viewcode-back" href="../../api/test_utils/index.html#mxnet.test_utils.download">[docs]</a><span class="k">def</span> <span class="nf">download</span><span class="p">(</span><span class="n">url</span><span class="p">,</span> <span class="n">fname</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">dirname</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">overwrite</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">retries</span><span class="o">=</span><span class="mi">5</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Download an given URL</span>
<span class="sd"> Parameters</span>
<span class="sd"> ----------</span>
<span class="sd"> url : str</span>
<span class="sd"> URL to download</span>
<span class="sd"> fname : str, optional</span>
<span class="sd"> filename of the downloaded file. If None, then will guess a filename</span>
<span class="sd"> from url.</span>
<span class="sd"> dirname : str, optional</span>
<span class="sd"> output directory name. If None, then guess from fname or use the current</span>
<span class="sd"> directory</span>
<span class="sd"> overwrite : bool, optional</span>
<span class="sd"> Default is false, which means skipping download if the local file</span>
<span class="sd"> exists. If true, then download the url to overwrite the local file if</span>
<span class="sd"> exists.</span>
<span class="sd"> retries : integer, default 5</span>
<span class="sd"> The number of times to attempt the download in case of failure or non 200 return codes</span>
<span class="sd"> Returns</span>
<span class="sd"> -------</span>
<span class="sd"> str</span>
<span class="sd"> The filename of the downloaded file</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">assert</span> <span class="n">retries</span> <span class="o">&gt;=</span> <span class="mi">0</span><span class="p">,</span> <span class="s2">&quot;Number of retries should be at least 0&quot;</span>
<span class="k">if</span> <span class="n">fname</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">fname</span> <span class="o">=</span> <span class="n">url</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s1">&#39;/&#39;</span><span class="p">)[</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span>
<span class="k">if</span> <span class="n">dirname</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">dirname</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">dirname</span><span class="p">(</span><span class="n">fname</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">fname</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">dirname</span><span class="p">,</span> <span class="n">fname</span><span class="p">)</span>
<span class="k">if</span> <span class="n">dirname</span> <span class="o">!=</span> <span class="s2">&quot;&quot;</span><span class="p">:</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">exists</span><span class="p">(</span><span class="n">dirname</span><span class="p">):</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">logging</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s1">&#39;create directory </span><span class="si">%s</span><span class="s1">&#39;</span><span class="p">,</span> <span class="n">dirname</span><span class="p">)</span>
<span class="n">os</span><span class="o">.</span><span class="n">makedirs</span><span class="p">(</span><span class="n">dirname</span><span class="p">)</span>
<span class="k">except</span> <span class="ne">OSError</span> <span class="k">as</span> <span class="n">exc</span><span class="p">:</span>
<span class="k">if</span> <span class="n">exc</span><span class="o">.</span><span class="n">errno</span> <span class="o">!=</span> <span class="n">errno</span><span class="o">.</span><span class="n">EEXIST</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">OSError</span><span class="p">(</span><span class="s1">&#39;failed to create &#39;</span> <span class="o">+</span> <span class="n">dirname</span><span class="p">)</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">overwrite</span> <span class="ow">and</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">exists</span><span class="p">(</span><span class="n">fname</span><span class="p">):</span>
<span class="n">logging</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s2">&quot;</span><span class="si">%s</span><span class="s2"> exists, skipping download&quot;</span><span class="p">,</span> <span class="n">fname</span><span class="p">)</span>
<span class="k">return</span> <span class="n">fname</span>
<span class="k">while</span> <span class="n">retries</span><span class="o">+</span><span class="mi">1</span> <span class="o">&gt;</span> <span class="mi">0</span><span class="p">:</span>
<span class="c1"># Disable pyling too broad Exception</span>
<span class="c1"># pylint: disable=W0703</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">r</span> <span class="o">=</span> <span class="n">requests</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">url</span><span class="p">,</span> <span class="n">stream</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
<span class="k">assert</span> <span class="n">r</span><span class="o">.</span><span class="n">status_code</span> <span class="o">==</span> <span class="mi">200</span><span class="p">,</span> <span class="sa">f</span><span class="s2">&quot;failed to open </span><span class="si">{</span><span class="n">url</span><span class="si">}</span><span class="s2">&quot;</span>
<span class="k">with</span> <span class="nb">open</span><span class="p">(</span><span class="n">fname</span><span class="p">,</span> <span class="s1">&#39;wb&#39;</span><span class="p">)</span> <span class="k">as</span> <span class="n">f</span><span class="p">:</span>
<span class="k">for</span> <span class="n">chunk</span> <span class="ow">in</span> <span class="n">r</span><span class="o">.</span><span class="n">iter_content</span><span class="p">(</span><span class="n">chunk_size</span><span class="o">=</span><span class="mi">1024</span><span class="p">):</span>
<span class="k">if</span> <span class="n">chunk</span><span class="p">:</span> <span class="c1"># filter out keep-alive new chunks</span>
<span class="n">f</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">chunk</span><span class="p">)</span>
<span class="k">break</span>
<span class="k">except</span> <span class="ne">Exception</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span>
<span class="n">retries</span> <span class="o">-=</span> <span class="mi">1</span>
<span class="k">if</span> <span class="n">retries</span> <span class="o">&lt;=</span> <span class="mi">0</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">e</span>
<span class="nb">print</span><span class="p">(</span><span class="s2">&quot;download failed, retrying, </span><span class="si">{}</span><span class="s2"> attempt</span><span class="si">{}</span><span class="s2"> left&quot;</span>
<span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">retries</span><span class="p">,</span> <span class="s1">&#39;s&#39;</span> <span class="k">if</span> <span class="n">retries</span> <span class="o">&gt;</span> <span class="mi">1</span> <span class="k">else</span> <span class="s1">&#39;&#39;</span><span class="p">))</span>
<span class="n">logging</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s2">&quot;downloaded </span><span class="si">%s</span><span class="s2"> into </span><span class="si">%s</span><span class="s2"> successfully&quot;</span><span class="p">,</span> <span class="n">url</span><span class="p">,</span> <span class="n">fname</span><span class="p">)</span>
<span class="k">return</span> <span class="n">fname</span></div>
<div class="viewcode-block" id="get_mnist"><a class="viewcode-back" href="../../api/test_utils/index.html#mxnet.test_utils.get_mnist">[docs]</a><span class="k">def</span> <span class="nf">get_mnist</span><span class="p">(</span><span class="n">path</span><span class="o">=</span><span class="s1">&#39;data&#39;</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Download and load the MNIST dataset</span>
<span class="sd"> Parameters</span>
<span class="sd"> ----------</span>
<span class="sd"> path : str</span>
<span class="sd"> Path in which to save the files.</span>
<span class="sd"> Returns</span>
<span class="sd"> -------</span>
<span class="sd"> dict</span>
<span class="sd"> A dict containing the data.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">def</span> <span class="nf">read_data</span><span class="p">(</span><span class="n">label_url</span><span class="p">,</span> <span class="n">image_url</span><span class="p">):</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">isdir</span><span class="p">(</span><span class="n">path</span><span class="p">):</span>
<span class="n">os</span><span class="o">.</span><span class="n">makedirs</span><span class="p">(</span><span class="n">path</span><span class="p">)</span>
<span class="k">with</span> <span class="n">gzip</span><span class="o">.</span><span class="n">open</span><span class="p">(</span><span class="n">mx</span><span class="o">.</span><span class="n">gluon</span><span class="o">.</span><span class="n">utils</span><span class="o">.</span><span class="n">download</span><span class="p">(</span><span class="n">label_url</span><span class="p">,</span> <span class="n">path</span><span class="o">=</span><span class="n">path</span><span class="p">))</span> <span class="k">as</span> <span class="n">flbl</span><span class="p">:</span>
<span class="n">struct</span><span class="o">.</span><span class="n">unpack</span><span class="p">(</span><span class="s2">&quot;&gt;II&quot;</span><span class="p">,</span> <span class="n">flbl</span><span class="o">.</span><span class="n">read</span><span class="p">(</span><span class="mi">8</span><span class="p">))</span>
<span class="n">label</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">frombuffer</span><span class="p">(</span><span class="n">flbl</span><span class="o">.</span><span class="n">read</span><span class="p">(),</span> <span class="n">dtype</span><span class="o">=</span><span class="n">np</span><span class="o">.</span><span class="n">int8</span><span class="p">)</span>
<span class="k">with</span> <span class="n">gzip</span><span class="o">.</span><span class="n">open</span><span class="p">(</span><span class="n">mx</span><span class="o">.</span><span class="n">gluon</span><span class="o">.</span><span class="n">utils</span><span class="o">.</span><span class="n">download</span><span class="p">(</span><span class="n">image_url</span><span class="p">,</span> <span class="n">path</span><span class="o">=</span><span class="n">path</span><span class="p">),</span> <span class="s1">&#39;rb&#39;</span><span class="p">)</span> <span class="k">as</span> <span class="n">fimg</span><span class="p">:</span>
<span class="n">_</span><span class="p">,</span> <span class="n">_</span><span class="p">,</span> <span class="n">rows</span><span class="p">,</span> <span class="n">cols</span> <span class="o">=</span> <span class="n">struct</span><span class="o">.</span><span class="n">unpack</span><span class="p">(</span><span class="s2">&quot;&gt;IIII&quot;</span><span class="p">,</span> <span class="n">fimg</span><span class="o">.</span><span class="n">read</span><span class="p">(</span><span class="mi">16</span><span class="p">))</span>
<span class="n">image</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">frombuffer</span><span class="p">(</span><span class="n">fimg</span><span class="o">.</span><span class="n">read</span><span class="p">(),</span> <span class="n">dtype</span><span class="o">=</span><span class="n">np</span><span class="o">.</span><span class="n">uint8</span><span class="p">)</span><span class="o">.</span><span class="n">reshape</span><span class="p">(</span><span class="nb">len</span><span class="p">(</span><span class="n">label</span><span class="p">),</span> <span class="n">rows</span><span class="p">,</span> <span class="n">cols</span><span class="p">)</span>
<span class="n">image</span> <span class="o">=</span> <span class="n">image</span><span class="o">.</span><span class="n">reshape</span><span class="p">(</span><span class="n">image</span><span class="o">.</span><span class="n">shape</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">28</span><span class="p">,</span> <span class="mi">28</span><span class="p">)</span><span class="o">.</span><span class="n">astype</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">float32</span><span class="p">)</span><span class="o">/</span><span class="mi">255</span>
<span class="k">return</span> <span class="p">(</span><span class="n">label</span><span class="p">,</span> <span class="n">image</span><span class="p">)</span>
<span class="c1"># changed to mxnet.io for more stable hosting</span>
<span class="n">url_path</span> <span class="o">=</span> <span class="s1">&#39;https://repo.mxnet.io/gluon/dataset/mnist/&#39;</span>
<span class="p">(</span><span class="n">train_lbl</span><span class="p">,</span> <span class="n">train_img</span><span class="p">)</span> <span class="o">=</span> <span class="n">read_data</span><span class="p">(</span>
<span class="n">url_path</span><span class="o">+</span><span class="s1">&#39;train-labels-idx1-ubyte.gz&#39;</span><span class="p">,</span> <span class="n">url_path</span><span class="o">+</span><span class="s1">&#39;train-images-idx3-ubyte.gz&#39;</span><span class="p">)</span>
<span class="p">(</span><span class="n">test_lbl</span><span class="p">,</span> <span class="n">test_img</span><span class="p">)</span> <span class="o">=</span> <span class="n">read_data</span><span class="p">(</span>
<span class="n">url_path</span><span class="o">+</span><span class="s1">&#39;t10k-labels-idx1-ubyte.gz&#39;</span><span class="p">,</span> <span class="n">url_path</span><span class="o">+</span><span class="s1">&#39;t10k-images-idx3-ubyte.gz&#39;</span><span class="p">)</span>
<span class="k">return</span> <span class="p">{</span><span class="s1">&#39;train_data&#39;</span><span class="p">:</span><span class="n">train_img</span><span class="p">,</span> <span class="s1">&#39;train_label&#39;</span><span class="p">:</span><span class="n">train_lbl</span><span class="p">,</span>
<span class="s1">&#39;test_data&#39;</span><span class="p">:</span><span class="n">test_img</span><span class="p">,</span> <span class="s1">&#39;test_label&#39;</span><span class="p">:</span><span class="n">test_lbl</span><span class="p">}</span></div>
<div class="viewcode-block" id="get_mnist_ubyte"><a class="viewcode-back" href="../../api/test_utils/index.html#mxnet.test_utils.get_mnist_ubyte">[docs]</a><span class="k">def</span> <span class="nf">get_mnist_ubyte</span><span class="p">(</span><span class="n">path</span><span class="o">=</span><span class="s1">&#39;data&#39;</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Downloads ubyte version of the MNIST dataset into a directory in the current directory</span>
<span class="sd"> with the name `data` and extracts all files in the zip archive to this directory.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">isdir</span><span class="p">(</span><span class="n">path</span><span class="p">):</span>
<span class="n">os</span><span class="o">.</span><span class="n">makedirs</span><span class="p">(</span><span class="n">path</span><span class="p">)</span>
<span class="n">files</span> <span class="o">=</span> <span class="p">[</span><span class="s1">&#39;train-images-idx3-ubyte&#39;</span><span class="p">,</span> <span class="s1">&#39;train-labels-idx1-ubyte&#39;</span><span class="p">,</span>
<span class="s1">&#39;t10k-images-idx3-ubyte&#39;</span><span class="p">,</span> <span class="s1">&#39;t10k-labels-idx1-ubyte&#39;</span><span class="p">]</span>
<span class="k">if</span> <span class="ow">not</span> <span class="nb">all</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">exists</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="n">f</span><span class="p">))</span> <span class="k">for</span> <span class="n">f</span> <span class="ow">in</span> <span class="n">files</span><span class="p">):</span>
<span class="n">get_mnist</span><span class="p">(</span><span class="n">path</span><span class="p">)</span>
<span class="k">for</span> <span class="n">f</span> <span class="ow">in</span> <span class="n">files</span><span class="p">:</span>
<span class="n">ubyte_file_path</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="n">f</span><span class="p">)</span>
<span class="n">zip_file_path</span> <span class="o">=</span> <span class="n">ubyte_file_path</span> <span class="o">+</span> <span class="s1">&#39;.gz&#39;</span>
<span class="k">with</span> <span class="n">gzip</span><span class="o">.</span><span class="n">GzipFile</span><span class="p">(</span><span class="n">zip_file_path</span><span class="p">)</span> <span class="k">as</span> <span class="n">zf</span><span class="p">:</span>
<span class="k">with</span> <span class="nb">open</span><span class="p">(</span><span class="n">ubyte_file_path</span><span class="p">,</span> <span class="s1">&#39;wb&#39;</span><span class="p">)</span> <span class="k">as</span> <span class="n">ubyte_file</span><span class="p">:</span>
<span class="n">ubyte_file</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">zf</span><span class="o">.</span><span class="n">read</span><span class="p">())</span></div>
<div class="viewcode-block" id="get_cifar10"><a class="viewcode-back" href="../../api/test_utils/index.html#mxnet.test_utils.get_cifar10">[docs]</a><span class="k">def</span> <span class="nf">get_cifar10</span><span class="p">(</span><span class="n">path</span><span class="o">=</span><span class="s1">&#39;data&#39;</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Downloads CIFAR10 dataset into a directory in the current directory with the name `data`,</span>
<span class="sd"> and then extracts all files into the directory `data/cifar`.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">isdir</span><span class="p">(</span><span class="n">path</span><span class="p">):</span>
<span class="n">os</span><span class="o">.</span><span class="n">makedirs</span><span class="p">(</span><span class="n">path</span><span class="p">)</span>
<span class="k">if</span> <span class="p">(</span><span class="ow">not</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">exists</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="s1">&#39;cifar&#39;</span><span class="p">,</span> <span class="s1">&#39;train.rec&#39;</span><span class="p">)))</span> <span class="ow">or</span> \
<span class="p">(</span><span class="ow">not</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">exists</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="s1">&#39;cifar&#39;</span><span class="p">,</span> <span class="s1">&#39;test.rec&#39;</span><span class="p">)))</span> <span class="ow">or</span> \
<span class="p">(</span><span class="ow">not</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">exists</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="s1">&#39;cifar&#39;</span><span class="p">,</span> <span class="s1">&#39;train.lst&#39;</span><span class="p">)))</span> <span class="ow">or</span> \
<span class="p">(</span><span class="ow">not</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">exists</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="s1">&#39;cifar&#39;</span><span class="p">,</span> <span class="s1">&#39;test.lst&#39;</span><span class="p">))):</span>
<span class="n">url</span> <span class="o">=</span> <span class="s1">&#39;https://repo.mxnet.io/gluon/dataset/cifar10/cifar10-b9ac2870.zip&#39;</span>
<span class="n">sha1</span> <span class="o">=</span> <span class="s1">&#39;b9ac287012f2dad9dfb49d8271c39ecdd7db376c&#39;</span>
<span class="n">zip_file_path</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">utils</span><span class="o">.</span><span class="n">download</span><span class="p">(</span><span class="n">url</span><span class="p">,</span> <span class="n">path</span><span class="o">=</span><span class="n">path</span><span class="p">,</span> <span class="n">sha1_hash</span><span class="o">=</span><span class="n">sha1</span><span class="p">,</span>
<span class="n">verify_ssl</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span>
<span class="k">with</span> <span class="n">zipfile</span><span class="o">.</span><span class="n">ZipFile</span><span class="p">(</span><span class="n">zip_file_path</span><span class="p">)</span> <span class="k">as</span> <span class="n">zf</span><span class="p">:</span>
<span class="n">zf</span><span class="o">.</span><span class="n">extractall</span><span class="p">(</span><span class="n">path</span><span class="p">)</span></div>
<div class="viewcode-block" id="get_mnist_iterator"><a class="viewcode-back" href="../../api/test_utils/index.html#mxnet.test_utils.get_mnist_iterator">[docs]</a><span class="k">def</span> <span class="nf">get_mnist_iterator</span><span class="p">(</span><span class="n">batch_size</span><span class="p">,</span> <span class="n">input_shape</span><span class="p">,</span> <span class="n">num_parts</span><span class="o">=</span><span class="mi">1</span><span class="p">,</span> <span class="n">part_index</span><span class="o">=</span><span class="mi">0</span><span class="p">,</span> <span class="n">path</span><span class="o">=</span><span class="s1">&#39;data&#39;</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Returns training and validation iterators for MNIST dataset</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">get_mnist_ubyte</span><span class="p">(</span><span class="n">path</span><span class="p">)</span>
<span class="n">flat</span> <span class="o">=</span> <span class="nb">len</span><span class="p">(</span><span class="n">input_shape</span><span class="p">)</span> <span class="o">!=</span> <span class="mi">3</span>
<span class="n">train_dataiter</span> <span class="o">=</span> <span class="n">mx</span><span class="o">.</span><span class="n">io</span><span class="o">.</span><span class="n">MNISTIter</span><span class="p">(</span>
<span class="n">image</span><span class="o">=</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="s2">&quot;train-images-idx3-ubyte&quot;</span><span class="p">),</span>
<span class="n">label</span><span class="o">=</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="s2">&quot;train-labels-idx1-ubyte&quot;</span><span class="p">),</span>
<span class="n">input_shape</span><span class="o">=</span><span class="n">input_shape</span><span class="p">,</span>
<span class="n">batch_size</span><span class="o">=</span><span class="n">batch_size</span><span class="p">,</span>
<span class="n">shuffle</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span>
<span class="n">flat</span><span class="o">=</span><span class="n">flat</span><span class="p">,</span>
<span class="n">num_parts</span><span class="o">=</span><span class="n">num_parts</span><span class="p">,</span>
<span class="n">part_index</span><span class="o">=</span><span class="n">part_index</span><span class="p">)</span>
<span class="n">val_dataiter</span> <span class="o">=</span> <span class="n">mx</span><span class="o">.</span><span class="n">io</span><span class="o">.</span><span class="n">MNISTIter</span><span class="p">(</span>
<span class="n">image</span><span class="o">=</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="s2">&quot;t10k-images-idx3-ubyte&quot;</span><span class="p">),</span>
<span class="n">label</span><span class="o">=</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="s2">&quot;t10k-labels-idx1-ubyte&quot;</span><span class="p">),</span>
<span class="n">input_shape</span><span class="o">=</span><span class="n">input_shape</span><span class="p">,</span>
<span class="n">batch_size</span><span class="o">=</span><span class="n">batch_size</span><span class="p">,</span>
<span class="n">flat</span><span class="o">=</span><span class="n">flat</span><span class="p">,</span>
<span class="n">num_parts</span><span class="o">=</span><span class="n">num_parts</span><span class="p">,</span>
<span class="n">part_index</span><span class="o">=</span><span class="n">part_index</span><span class="p">)</span>
<span class="k">return</span> <span class="p">(</span><span class="n">train_dataiter</span><span class="p">,</span> <span class="n">val_dataiter</span><span class="p">)</span></div>
<div class="viewcode-block" id="get_bz2_data"><a class="viewcode-back" href="../../api/test_utils/index.html#mxnet.test_utils.get_bz2_data">[docs]</a><span class="k">def</span> <span class="nf">get_bz2_data</span><span class="p">(</span><span class="n">data_dir</span><span class="p">,</span> <span class="n">data_name</span><span class="p">,</span> <span class="n">url</span><span class="p">,</span> <span class="n">data_origin_name</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Download and extract bz2 data.</span>
<span class="sd"> Parameters</span>
<span class="sd"> ----------</span>
<span class="sd"> data_dir : str</span>
<span class="sd"> Absolute or relative path of the directory name to store bz2 files</span>
<span class="sd"> data_name : str</span>
<span class="sd"> Name of the output file in which bz2 contents will be extracted</span>
<span class="sd"> url : str</span>
<span class="sd"> URL to download data from</span>
<span class="sd"> data_origin_name : str</span>
<span class="sd"> Name of the downloaded b2 file</span>
<span class="sd"> Examples</span>
<span class="sd"> --------</span>
<span class="sd"> &gt;&gt;&gt; get_bz2_data(&quot;data_dir&quot;, &quot;kdda.t&quot;,</span>
<span class="sd"> &quot;https://www.csie.ntu.edu.tw/~cjlin/libsvmtools/datasets/binary/kdda.t.bz2&quot;,</span>
<span class="sd"> &quot;kdda.t.bz2&quot;)</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">data_name</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">data_dir</span><span class="p">,</span> <span class="n">data_name</span><span class="p">)</span>
<span class="n">data_origin_name</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">data_dir</span><span class="p">,</span> <span class="n">data_origin_name</span><span class="p">)</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">exists</span><span class="p">(</span><span class="n">data_name</span><span class="p">):</span>
<span class="n">download</span><span class="p">(</span><span class="n">url</span><span class="p">,</span> <span class="n">fname</span><span class="o">=</span><span class="n">data_origin_name</span><span class="p">,</span> <span class="n">dirname</span><span class="o">=</span><span class="n">data_dir</span><span class="p">,</span> <span class="n">overwrite</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span>
<span class="n">bz_file</span> <span class="o">=</span> <span class="n">bz2</span><span class="o">.</span><span class="n">BZ2File</span><span class="p">(</span><span class="n">data_origin_name</span><span class="p">,</span> <span class="s1">&#39;rb&#39;</span><span class="p">)</span>
<span class="k">with</span> <span class="nb">open</span><span class="p">(</span><span class="n">data_name</span><span class="p">,</span> <span class="s1">&#39;wb&#39;</span><span class="p">)</span> <span class="k">as</span> <span class="n">fout</span><span class="p">:</span>
<span class="k">for</span> <span class="n">line</span> <span class="ow">in</span> <span class="n">bz_file</span><span class="p">:</span>
<span class="n">fout</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">line</span><span class="p">)</span>
<span class="n">bz_file</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>
<span class="n">os</span><span class="o">.</span><span class="n">remove</span><span class="p">(</span><span class="n">data_origin_name</span><span class="p">)</span></div>
<div class="viewcode-block" id="same_array"><a class="viewcode-back" href="../../api/test_utils/index.html#mxnet.test_utils.same_array">[docs]</a><span class="k">def</span> <span class="nf">same_array</span><span class="p">(</span><span class="n">array1</span><span class="p">,</span> <span class="n">array2</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Check whether two NDArrays sharing the same memory block</span>
<span class="sd"> Parameters</span>
<span class="sd"> ----------</span>
<span class="sd"> array1 : NDArray</span>
<span class="sd"> First NDArray to be checked</span>
<span class="sd"> array2 : NDArray</span>
<span class="sd"> Second NDArray to be checked</span>
<span class="sd"> Returns</span>
<span class="sd"> -------</span>
<span class="sd"> bool</span>
<span class="sd"> Whether two NDArrays share the same memory</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">array1</span><span class="p">[:]</span> <span class="o">+=</span> <span class="mi">1</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">same</span><span class="p">(</span><span class="n">array1</span><span class="o">.</span><span class="n">asnumpy</span><span class="p">(),</span> <span class="n">array2</span><span class="o">.</span><span class="n">asnumpy</span><span class="p">()):</span>
<span class="n">array1</span><span class="p">[:]</span> <span class="o">-=</span> <span class="mi">1</span>
<span class="k">return</span> <span class="kc">False</span>
<span class="n">array1</span><span class="p">[:]</span> <span class="o">-=</span> <span class="mi">1</span>
<span class="k">return</span> <span class="n">same</span><span class="p">(</span><span class="n">array1</span><span class="o">.</span><span class="n">asnumpy</span><span class="p">(),</span> <span class="n">array2</span><span class="o">.</span><span class="n">asnumpy</span><span class="p">())</span></div>
<div class="viewcode-block" id="discard_stderr"><a class="viewcode-back" href="../../api/test_utils/index.html#mxnet.test_utils.discard_stderr">[docs]</a><span class="nd">@contextmanager</span>
<span class="k">def</span> <span class="nf">discard_stderr</span><span class="p">():</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Discards error output of a routine if invoked as:</span>
<span class="sd"> with discard_stderr():</span>
<span class="sd"> ...</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">with</span> <span class="nb">open</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">devnull</span><span class="p">,</span> <span class="s1">&#39;w&#39;</span><span class="p">)</span> <span class="k">as</span> <span class="n">bit_bucket</span><span class="p">:</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">stderr_fileno</span> <span class="o">=</span> <span class="n">sys</span><span class="o">.</span><span class="n">stderr</span><span class="o">.</span><span class="n">fileno</span><span class="p">()</span>
<span class="n">old_stderr</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">dup</span><span class="p">(</span><span class="n">stderr_fileno</span><span class="p">)</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">os</span><span class="o">.</span><span class="n">dup2</span><span class="p">(</span><span class="n">bit_bucket</span><span class="o">.</span><span class="n">fileno</span><span class="p">(),</span> <span class="n">stderr_fileno</span><span class="p">)</span>
<span class="k">yield</span>
<span class="k">finally</span><span class="p">:</span>
<span class="n">os</span><span class="o">.</span><span class="n">dup2</span><span class="p">(</span><span class="n">old_stderr</span><span class="p">,</span> <span class="n">stderr_fileno</span><span class="p">)</span>
<span class="k">except</span> <span class="ne">AttributeError</span><span class="p">:</span>
<span class="c1"># On some systems is stderr not a file descriptor but actually a virtual pipeline</span>
<span class="c1"># that can not be copied</span>
<span class="k">yield</span></div>
<div class="viewcode-block" id="DummyIter"><a class="viewcode-back" href="../../api/test_utils/index.html#mxnet.test_utils.DummyIter">[docs]</a><span class="k">class</span> <span class="nc">DummyIter</span><span class="p">(</span><span class="n">mx</span><span class="o">.</span><span class="n">io</span><span class="o">.</span><span class="n">DataIter</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;A dummy iterator that always returns the same batch of data</span>
<span class="sd"> (the first data batch of the real data iter). This is usually used for speed testing.</span>
<span class="sd"> Parameters</span>
<span class="sd"> ----------</span>
<span class="sd"> real_iter: mx.io.DataIter</span>
<span class="sd"> The real data iterator where the first batch of data comes from</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">real_iter</span><span class="p">):</span>
<span class="nb">super</span><span class="p">(</span><span class="n">DummyIter</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="fm">__init__</span><span class="p">()</span>
<span class="bp">self</span><span class="o">.</span><span class="n">real_iter</span> <span class="o">=</span> <span class="n">real_iter</span>
<span class="bp">self</span><span class="o">.</span><span class="n">provide_data</span> <span class="o">=</span> <span class="n">real_iter</span><span class="o">.</span><span class="n">provide_data</span>
<span class="bp">self</span><span class="o">.</span><span class="n">provide_label</span> <span class="o">=</span> <span class="n">real_iter</span><span class="o">.</span><span class="n">provide_label</span>
<span class="bp">self</span><span class="o">.</span><span class="n">batch_size</span> <span class="o">=</span> <span class="n">real_iter</span><span class="o">.</span><span class="n">batch_size</span>
<span class="bp">self</span><span class="o">.</span><span class="n">the_batch</span> <span class="o">=</span> <span class="nb">next</span><span class="p">(</span><span class="n">real_iter</span><span class="p">)</span>
<span class="k">def</span> <span class="fm">__iter__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">return</span> <span class="bp">self</span>
<div class="viewcode-block" id="DummyIter.next"><a class="viewcode-back" href="../../api/test_utils/index.html#mxnet.test_utils.DummyIter.next">[docs]</a> <span class="k">def</span> <span class="nf">next</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Get a data batch from iterator. The first data batch of real iter is always returned.</span>
<span class="sd"> StopIteration will never be raised.</span>
<span class="sd"> Returns</span>
<span class="sd"> -------</span>
<span class="sd"> DataBatch</span>
<span class="sd"> The data of next batch.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">the_batch</span></div></div>
<div class="viewcode-block" id="gen_buckets_probs_with_ppf"><a class="viewcode-back" href="../../api/test_utils/index.html#mxnet.test_utils.gen_buckets_probs_with_ppf">[docs]</a><span class="k">def</span> <span class="nf">gen_buckets_probs_with_ppf</span><span class="p">(</span><span class="n">ppf</span><span class="p">,</span> <span class="n">nbuckets</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Generate the buckets and probabilities for chi_square test when the ppf (Quantile function)</span>
<span class="sd"> is specified.</span>
<span class="sd"> Parameters</span>
<span class="sd"> ----------</span>
<span class="sd"> ppf : function</span>
<span class="sd"> The Quantile function that takes a probability and maps it back to a value.</span>
<span class="sd"> It&#39;s the inverse of the cdf function</span>
<span class="sd"> nbuckets : int</span>
<span class="sd"> size of the buckets</span>
<span class="sd"> Returns</span>
<span class="sd"> -------</span>
<span class="sd"> buckets : list of tuple</span>
<span class="sd"> The generated buckets</span>
<span class="sd"> probs : list</span>
<span class="sd"> The generate probabilities</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">assert</span> <span class="n">nbuckets</span> <span class="o">&gt;</span> <span class="mi">0</span>
<span class="n">probs</span> <span class="o">=</span> <span class="p">[</span><span class="mf">1.0</span> <span class="o">/</span> <span class="n">nbuckets</span> <span class="k">for</span> <span class="n">_</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="n">nbuckets</span><span class="p">)]</span>
<span class="n">buckets</span> <span class="o">=</span> <span class="p">[(</span><span class="n">ppf</span><span class="p">(</span><span class="n">i</span> <span class="o">/</span> <span class="nb">float</span><span class="p">(</span><span class="n">nbuckets</span><span class="p">)),</span> <span class="n">ppf</span><span class="p">((</span><span class="n">i</span> <span class="o">+</span> <span class="mi">1</span><span class="p">)</span> <span class="o">/</span> <span class="nb">float</span><span class="p">(</span><span class="n">nbuckets</span><span class="p">)))</span> <span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="n">nbuckets</span><span class="p">)]</span>
<span class="k">return</span> <span class="n">buckets</span><span class="p">,</span> <span class="n">probs</span></div>
<div class="viewcode-block" id="mean_check"><a class="viewcode-back" href="../../api/test_utils/index.html#mxnet.test_utils.mean_check">[docs]</a><span class="k">def</span> <span class="nf">mean_check</span><span class="p">(</span><span class="n">generator</span><span class="p">,</span> <span class="n">mu</span><span class="p">,</span> <span class="n">sigma</span><span class="p">,</span> <span class="n">nsamples</span><span class="o">=</span><span class="mi">1000000</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Test the generator by matching the mean.</span>
<span class="sd"> We test the sample mean by checking if it falls inside the range</span>
<span class="sd"> (mu - 3 * sigma / sqrt(n), mu + 3 * sigma / sqrt(n))</span>
<span class="sd"> References::</span>
<span class="sd"> @incollection{goucher2009beautiful,</span>
<span class="sd"> title={Beautiful Testing: Leading Professionals Reveal How They Improve Software},</span>
<span class="sd"> author={Goucher, Adam and Riley, Tim},</span>
<span class="sd"> year={2009},</span>
<span class="sd"> chapter=10</span>
<span class="sd"> }</span>
<span class="sd"> Examples::</span>
<span class="sd"> generator = lambda x: np.random.normal(0, 1.0, size=x)</span>
<span class="sd"> mean_check_ret = mean_check(generator, 0, 1.0)</span>
<span class="sd"> Parameters</span>
<span class="sd"> ----------</span>
<span class="sd"> generator : function</span>
<span class="sd"> The generator function. It&#39;s expected to generate N i.i.d samples by calling generator(N).</span>
<span class="sd"> mu : float</span>
<span class="sd"> sigma : float</span>
<span class="sd"> nsamples : int</span>
<span class="sd"> Returns</span>
<span class="sd"> -------</span>
<span class="sd"> ret : bool</span>
<span class="sd"> Whether the mean test succeeds</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">samples</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">generator</span><span class="p">(</span><span class="n">nsamples</span><span class="p">))</span>
<span class="n">sample_mean</span> <span class="o">=</span> <span class="n">samples</span><span class="o">.</span><span class="n">mean</span><span class="p">()</span>
<span class="n">ret</span> <span class="o">=</span> <span class="p">(</span><span class="n">sample_mean</span> <span class="o">&gt;</span> <span class="n">mu</span> <span class="o">-</span> <span class="mi">3</span> <span class="o">*</span> <span class="n">sigma</span> <span class="o">/</span> <span class="n">np</span><span class="o">.</span><span class="n">sqrt</span><span class="p">(</span><span class="n">nsamples</span><span class="p">))</span> <span class="ow">and</span>\
<span class="p">(</span><span class="n">sample_mean</span> <span class="o">&lt;</span> <span class="n">mu</span> <span class="o">+</span> <span class="mi">3</span> <span class="o">*</span> <span class="n">sigma</span> <span class="o">/</span> <span class="n">np</span><span class="o">.</span><span class="n">sqrt</span><span class="p">(</span><span class="n">nsamples</span><span class="p">))</span>
<span class="k">return</span> <span class="n">ret</span></div>
<div class="viewcode-block" id="get_im2rec_path"><a class="viewcode-back" href="../../api/test_utils/index.html#mxnet.test_utils.get_im2rec_path">[docs]</a><span class="k">def</span> <span class="nf">get_im2rec_path</span><span class="p">(</span><span class="n">home_env</span><span class="o">=</span><span class="s2">&quot;MXNET_HOME&quot;</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Get path to the im2rec.py tool</span>
<span class="sd"> Parameters</span>
<span class="sd"> ----------</span>
<span class="sd"> home_env : str</span>
<span class="sd"> Env variable that holds the path to the MXNET folder</span>
<span class="sd"> Returns</span>
<span class="sd"> -------</span>
<span class="sd"> str</span>
<span class="sd"> The path to im2rec.py</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="c1"># Check first if the path to MXNET is passed as an env variable</span>
<span class="k">if</span> <span class="n">home_env</span> <span class="ow">in</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="p">:</span>
<span class="n">mxnet_path</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="p">[</span><span class="n">home_env</span><span class="p">]</span>
<span class="k">else</span><span class="p">:</span>
<span class="c1"># Else use currently imported mxnet as reference</span>
<span class="n">mxnet_path</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">dirname</span><span class="p">(</span><span class="n">mx</span><span class="o">.</span><span class="vm">__file__</span><span class="p">)</span>
<span class="c1"># If MXNet was installed through pip, the location of im2rec.py</span>
<span class="n">im2rec_path</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">mxnet_path</span><span class="p">,</span> <span class="s1">&#39;tools&#39;</span><span class="p">,</span> <span class="s1">&#39;im2rec.py&#39;</span><span class="p">)</span>
<span class="k">if</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">isfile</span><span class="p">(</span><span class="n">im2rec_path</span><span class="p">):</span>
<span class="k">return</span> <span class="n">im2rec_path</span>
<span class="c1"># If MXNet has been built locally</span>
<span class="n">im2rec_path</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">mxnet_path</span><span class="p">,</span> <span class="s1">&#39;..&#39;</span><span class="p">,</span> <span class="s1">&#39;..&#39;</span><span class="p">,</span> <span class="s1">&#39;tools&#39;</span><span class="p">,</span> <span class="s1">&#39;im2rec.py&#39;</span><span class="p">)</span>
<span class="k">if</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">isfile</span><span class="p">(</span><span class="n">im2rec_path</span><span class="p">):</span>
<span class="k">return</span> <span class="n">im2rec_path</span>
<span class="k">raise</span> <span class="ne">IOError</span><span class="p">(</span><span class="s1">&#39;Could not find path to tools/im2rec.py&#39;</span><span class="p">)</span></div>
<div class="viewcode-block" id="var_check"><a class="viewcode-back" href="../../api/test_utils/index.html#mxnet.test_utils.var_check">[docs]</a><span class="k">def</span> <span class="nf">var_check</span><span class="p">(</span><span class="n">generator</span><span class="p">,</span> <span class="n">sigma</span><span class="p">,</span> <span class="n">nsamples</span><span class="o">=</span><span class="mi">1000000</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Test the generator by matching the variance.</span>
<span class="sd"> It will need a large number of samples and is not recommended to use</span>
<span class="sd"> We test the sample variance by checking if it falls inside the range</span>
<span class="sd"> (sigma^2 - 3 * sqrt(2 * sigma^4 / (n-1)), sigma^2 + 3 * sqrt(2 * sigma^4 / (n-1)))</span>
<span class="sd"> References::</span>
<span class="sd"> @incollection{goucher2009beautiful,</span>
<span class="sd"> title={Beautiful Testing: Leading Professionals Reveal How They Improve Software},</span>
<span class="sd"> author={Goucher, Adam and Riley, Tim},</span>
<span class="sd"> year={2009},</span>
<span class="sd"> chapter=10</span>
<span class="sd"> }</span>
<span class="sd"> Examples::</span>
<span class="sd"> generator = lambda x: np.random.normal(0, 1.0, size=x)</span>
<span class="sd"> var_check_ret = var_check(generator, 0, 1.0)</span>
<span class="sd"> Parameters</span>
<span class="sd"> ----------</span>
<span class="sd"> generator : function</span>
<span class="sd"> The generator function. It&#39;s expected to generate N i.i.d samples by calling generator(N).</span>
<span class="sd"> sigma : float</span>
<span class="sd"> nsamples : int</span>
<span class="sd"> Returns</span>
<span class="sd"> -------</span>
<span class="sd"> ret : bool</span>
<span class="sd"> Whether the variance test succeeds</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">samples</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">generator</span><span class="p">(</span><span class="n">nsamples</span><span class="p">))</span>
<span class="n">sample_var</span> <span class="o">=</span> <span class="n">samples</span><span class="o">.</span><span class="n">var</span><span class="p">(</span><span class="n">ddof</span><span class="o">=</span><span class="mi">1</span><span class="p">)</span>
<span class="n">ret</span> <span class="o">=</span> <span class="p">(</span><span class="n">sample_var</span> <span class="o">&gt;</span> <span class="n">sigma</span> <span class="o">**</span> <span class="mi">2</span> <span class="o">-</span> <span class="mi">3</span> <span class="o">*</span> <span class="n">np</span><span class="o">.</span><span class="n">sqrt</span><span class="p">(</span><span class="mi">2</span> <span class="o">*</span> <span class="n">sigma</span> <span class="o">**</span> <span class="mi">4</span> <span class="o">/</span> <span class="p">(</span><span class="n">nsamples</span> <span class="o">-</span> <span class="mi">1</span><span class="p">)))</span> <span class="ow">and</span>\
<span class="p">(</span><span class="n">sample_var</span> <span class="o">&lt;</span> <span class="n">sigma</span> <span class="o">**</span> <span class="mi">2</span> <span class="o">+</span> <span class="mi">3</span> <span class="o">*</span> <span class="n">np</span><span class="o">.</span><span class="n">sqrt</span><span class="p">(</span><span class="mi">2</span> <span class="o">*</span> <span class="n">sigma</span> <span class="o">**</span> <span class="mi">4</span> <span class="o">/</span> <span class="p">(</span><span class="n">nsamples</span> <span class="o">-</span> <span class="mi">1</span><span class="p">)))</span>
<span class="k">return</span> <span class="n">ret</span></div>
<div class="viewcode-block" id="chi_square_check"><a class="viewcode-back" href="../../api/test_utils/index.html#mxnet.test_utils.chi_square_check">[docs]</a><span class="k">def</span> <span class="nf">chi_square_check</span><span class="p">(</span><span class="n">generator</span><span class="p">,</span> <span class="n">buckets</span><span class="p">,</span> <span class="n">probs</span><span class="p">,</span> <span class="n">nsamples</span><span class="o">=</span><span class="mi">1000000</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Run the chi-square test for the generator. The generator can be both continuous and discrete.</span>
<span class="sd"> If the generator is continuous, the buckets should contain tuples of (range_min, range_max) \</span>
<span class="sd"> and the probs should be the corresponding ideal probability within the specific ranges. \</span>
<span class="sd"> Otherwise, the buckets should contain all the possible values generated over the discrete distribution and the \</span>
<span class="sd"> probs should be groud-truth probability.</span>
<span class="sd"> Usually the user is required to specify the probs parameter.</span>
<span class="sd"> After obtaining the p value, we could further use the standard p &gt; 0.05 (alpha) threshold to get \</span>
<span class="sd"> the final result.</span>
<span class="sd"> Examples::</span>
<span class="sd"> buckets, probs = gen_buckets_probs_with_ppf(lambda x: ss.norm.ppf(x, 0, 1), 5)</span>
<span class="sd"> generator = lambda x: np.random.normal(0, 1.0, size=x)</span>
<span class="sd"> p = chi_square_check(generator=generator, buckets=buckets, probs=probs)</span>
<span class="sd"> assert(p &gt; 0.05)</span>
<span class="sd"> Parameters</span>
<span class="sd"> ----------</span>
<span class="sd"> generator: function</span>
<span class="sd"> A function that is assumed to generate i.i.d samples from a specific distribution.</span>
<span class="sd"> generator(N) should generate N random samples.</span>
<span class="sd"> buckets: list of tuple or list of number</span>
<span class="sd"> The buckets to run the chi-square the test. Make sure that the buckets cover</span>
<span class="sd"> the whole range of the distribution. Also, the buckets must be in ascending order and have</span>
<span class="sd"> no intersection</span>
<span class="sd"> probs: list or tuple</span>
<span class="sd"> The ground-truth probability of the random value fall in a specific bucket.</span>
<span class="sd"> nsamples:int</span>
<span class="sd"> The number of samples to generate for the testing</span>
<span class="sd"> Returns</span>
<span class="sd"> -------</span>
<span class="sd"> p : float</span>
<span class="sd"> p value that the generator has the expected distribution.</span>
<span class="sd"> A higher value indicates a larger confidence</span>
<span class="sd"> obs_freq : list</span>
<span class="sd"> Observed frequency of buckets</span>
<span class="sd"> expected_freq : list</span>
<span class="sd"> The expected (ground-truth) frequency of the buckets</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">ss</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ImportError</span><span class="p">(</span><span class="s2">&quot;scipy is not available.&quot;</span>
<span class="s2">&quot; Please check if the scipy python bindings are installed.&quot;</span><span class="p">)</span>
<span class="k">assert</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">buckets</span><span class="p">,</span> <span class="nb">list</span><span class="p">)</span>
<span class="n">samples</span> <span class="o">=</span> <span class="n">generator</span><span class="p">(</span><span class="n">nsamples</span><span class="p">)</span>
<span class="k">assert</span> <span class="nb">len</span><span class="p">(</span><span class="n">probs</span><span class="p">)</span> <span class="o">==</span> <span class="nb">len</span><span class="p">(</span><span class="n">buckets</span><span class="p">)</span>
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">buckets</span><span class="p">[</span><span class="mi">0</span><span class="p">],</span> <span class="p">(</span><span class="nb">list</span><span class="p">,</span> <span class="nb">tuple</span><span class="p">)):</span>
<span class="c1"># Check whether the buckets are valid and fill them into a npy array</span>
<span class="n">continuous_dist</span> <span class="o">=</span> <span class="kc">True</span>
<span class="n">buckets_npy</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">zeros</span><span class="p">((</span><span class="nb">len</span><span class="p">(</span><span class="n">buckets</span><span class="p">)</span> <span class="o">*</span> <span class="mi">2</span><span class="p">,</span> <span class="p">),</span> <span class="n">dtype</span><span class="o">=</span><span class="n">np</span><span class="o">.</span><span class="n">float32</span><span class="p">)</span>
<span class="k">for</span> <span class="n">i</span><span class="p">,</span> <span class="n">_</span> <span class="ow">in</span> <span class="nb">enumerate</span><span class="p">(</span><span class="n">buckets</span><span class="p">):</span>
<span class="k">assert</span><span class="p">(</span><span class="n">buckets</span><span class="p">[</span><span class="n">i</span><span class="p">][</span><span class="mi">0</span><span class="p">]</span> <span class="o">&lt;=</span> <span class="n">buckets</span><span class="p">[</span><span class="n">i</span><span class="p">][</span><span class="mi">1</span><span class="p">])</span>
<span class="k">if</span> <span class="n">i</span> <span class="o">&lt;</span> <span class="nb">len</span><span class="p">(</span><span class="n">buckets</span><span class="p">)</span> <span class="o">-</span> <span class="mi">1</span><span class="p">:</span>
<span class="k">assert</span><span class="p">(</span><span class="n">buckets</span><span class="p">[</span><span class="n">i</span><span class="p">][</span><span class="mi">1</span><span class="p">]</span> <span class="o">&lt;=</span> <span class="n">buckets</span><span class="p">[</span><span class="n">i</span> <span class="o">+</span> <span class="mi">1</span><span class="p">][</span><span class="mi">0</span><span class="p">])</span>
<span class="n">buckets_npy</span><span class="p">[</span><span class="n">i</span> <span class="o">*</span> <span class="mi">2</span><span class="p">]</span> <span class="o">=</span> <span class="n">buckets</span><span class="p">[</span><span class="n">i</span><span class="p">][</span><span class="mi">0</span><span class="p">]</span>
<span class="n">buckets_npy</span><span class="p">[</span><span class="n">i</span> <span class="o">*</span> <span class="mi">2</span> <span class="o">+</span> <span class="mi">1</span><span class="p">]</span> <span class="o">=</span> <span class="n">buckets</span><span class="p">[</span><span class="n">i</span><span class="p">][</span><span class="mi">1</span><span class="p">]</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">continuous_dist</span> <span class="o">=</span> <span class="kc">False</span>
<span class="n">expected_freq</span> <span class="o">=</span> <span class="p">(</span><span class="n">nsamples</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">probs</span><span class="p">,</span> <span class="n">dtype</span><span class="o">=</span><span class="n">np</span><span class="o">.</span><span class="n">float32</span><span class="p">))</span><span class="o">.</span><span class="n">astype</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">int32</span><span class="p">)</span>
<span class="k">if</span> <span class="n">continuous_dist</span><span class="p">:</span>
<span class="n">sample_bucket_ids</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">searchsorted</span><span class="p">(</span><span class="n">buckets_npy</span><span class="p">,</span> <span class="n">samples</span><span class="p">,</span> <span class="n">side</span><span class="o">=</span><span class="s1">&#39;right&#39;</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">sample_bucket_ids</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">samples</span><span class="p">)</span>
<span class="k">if</span> <span class="n">continuous_dist</span><span class="p">:</span>
<span class="n">sample_bucket_ids</span> <span class="o">=</span> <span class="n">sample_bucket_ids</span> <span class="o">//</span> <span class="mi">2</span>
<span class="n">obs_freq</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">zeros</span><span class="p">(</span><span class="n">shape</span><span class="o">=</span><span class="nb">len</span><span class="p">(</span><span class="n">buckets</span><span class="p">),</span> <span class="n">dtype</span><span class="o">=</span><span class="n">np</span><span class="o">.</span><span class="n">int</span><span class="p">)</span>
<span class="k">for</span> <span class="n">i</span><span class="p">,</span> <span class="n">_</span> <span class="ow">in</span> <span class="nb">enumerate</span><span class="p">(</span><span class="n">buckets</span><span class="p">):</span>
<span class="k">if</span> <span class="n">continuous_dist</span><span class="p">:</span>
<span class="n">obs_freq</span><span class="p">[</span><span class="n">i</span><span class="p">]</span> <span class="o">=</span> <span class="p">(</span><span class="n">sample_bucket_ids</span> <span class="o">==</span> <span class="n">i</span><span class="p">)</span><span class="o">.</span><span class="n">sum</span><span class="p">()</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">obs_freq</span><span class="p">[</span><span class="n">i</span><span class="p">]</span> <span class="o">=</span> <span class="p">(</span><span class="n">sample_bucket_ids</span> <span class="o">==</span> <span class="n">buckets</span><span class="p">[</span><span class="n">i</span><span class="p">])</span><span class="o">.</span><span class="n">sum</span><span class="p">()</span>
<span class="n">_</span><span class="p">,</span> <span class="n">p</span> <span class="o">=</span> <span class="n">ss</span><span class="o">.</span><span class="n">chisquare</span><span class="p">(</span><span class="n">f_obs</span><span class="o">=</span><span class="n">obs_freq</span><span class="p">,</span> <span class="n">f_exp</span><span class="o">=</span><span class="n">expected_freq</span><span class="p">)</span>
<span class="k">return</span> <span class="n">p</span><span class="p">,</span> <span class="n">obs_freq</span><span class="p">,</span> <span class="n">expected_freq</span></div>
<div class="viewcode-block" id="verify_generator"><a class="viewcode-back" href="../../api/test_utils/index.html#mxnet.test_utils.verify_generator">[docs]</a><span class="k">def</span> <span class="nf">verify_generator</span><span class="p">(</span><span class="n">generator</span><span class="p">,</span> <span class="n">buckets</span><span class="p">,</span> <span class="n">probs</span><span class="p">,</span> <span class="n">nsamples</span><span class="o">=</span><span class="mi">1000000</span><span class="p">,</span> <span class="n">nrepeat</span><span class="o">=</span><span class="mi">5</span><span class="p">,</span> <span class="n">success_rate</span><span class="o">=</span><span class="mf">0.2</span><span class="p">,</span> <span class="n">alpha</span><span class="o">=</span><span class="mf">0.05</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Verify whether the generator is correct using chi-square testing.</span>
<span class="sd"> The test is repeated for &quot;nrepeat&quot; times and we check if the success rate is</span>
<span class="sd"> above the threshold (25% by default).</span>
<span class="sd"> Parameters</span>
<span class="sd"> ----------</span>
<span class="sd"> generator: function</span>
<span class="sd"> A function that is assumed to generate i.i.d samples from a specific distribution.</span>
<span class="sd"> generator(N) should generate N random samples.</span>
<span class="sd"> buckets: list of tuple or list of number</span>
<span class="sd"> The buckets to run the chi-square the test. Make sure that the buckets cover</span>
<span class="sd"> the whole range of the distribution. Also, the buckets must be in ascending order and</span>
<span class="sd"> have no intersection</span>
<span class="sd"> probs: list or tuple</span>
<span class="sd"> The ground-truth probability of the random value fall in a specific bucket.</span>
<span class="sd"> nsamples: int</span>
<span class="sd"> The number of samples to generate for the testing</span>
<span class="sd"> nrepeat: int</span>
<span class="sd"> The times to repeat the test</span>
<span class="sd"> success_rate: float</span>
<span class="sd"> The desired success rate</span>
<span class="sd"> alpha: float</span>
<span class="sd"> The desired threshold for type-I error i.e. when a true null hypothesis is rejected</span>
<span class="sd"> Returns</span>
<span class="sd"> -------</span>
<span class="sd"> cs_ret_l: list</span>
<span class="sd"> The p values of the chi-square test.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">cs_ret_l</span> <span class="o">=</span> <span class="p">[]</span>
<span class="n">obs_freq_l</span> <span class="o">=</span> <span class="p">[]</span>
<span class="n">expected_freq_l</span> <span class="o">=</span> <span class="p">[]</span>
<span class="k">for</span> <span class="n">_</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="n">nrepeat</span><span class="p">):</span>
<span class="n">cs_ret</span><span class="p">,</span> <span class="n">obs_freq</span><span class="p">,</span> <span class="n">expected_freq</span> <span class="o">=</span> <span class="n">chi_square_check</span><span class="p">(</span><span class="n">generator</span><span class="o">=</span><span class="n">generator</span><span class="p">,</span> <span class="n">buckets</span><span class="o">=</span><span class="n">buckets</span><span class="p">,</span>
<span class="n">probs</span><span class="o">=</span><span class="n">probs</span><span class="p">,</span> <span class="n">nsamples</span><span class="o">=</span><span class="n">nsamples</span><span class="p">)</span>
<span class="n">cs_ret_l</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">cs_ret</span><span class="p">)</span>
<span class="n">obs_freq_l</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">obs_freq</span><span class="p">)</span>
<span class="n">expected_freq_l</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">expected_freq</span><span class="p">)</span>
<span class="n">success_num</span> <span class="o">=</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="n">cs_ret_l</span><span class="p">)</span> <span class="o">&gt;</span> <span class="n">alpha</span><span class="p">)</span><span class="o">.</span><span class="n">sum</span><span class="p">()</span>
<span class="k">if</span> <span class="n">success_num</span> <span class="o">&lt;</span> <span class="n">nrepeat</span> <span class="o">*</span> <span class="n">success_rate</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">AssertionError</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;Generator test fails, Chi-square p=</span><span class="si">{</span><span class="nb">str</span><span class="p">(</span><span class="n">cs_ret_l</span><span class="p">)</span><span class="si">}</span><span class="s2">, &quot;</span>
<span class="sa">f</span><span class="s2">&quot;obs_freq=</span><span class="si">{</span><span class="nb">str</span><span class="p">(</span><span class="n">obs_freq_l</span><span class="p">)</span><span class="si">}</span><span class="s2">, expected_freq=</span><span class="si">{</span><span class="nb">str</span><span class="p">(</span><span class="n">expected_freq_l</span><span class="p">)</span><span class="si">}</span><span class="s2">.&quot;</span>
<span class="sa">f</span><span class="s2">&quot;</span><span class="se">\n</span><span class="s2">buckets=</span><span class="si">{</span><span class="nb">str</span><span class="p">(</span><span class="n">buckets</span><span class="p">)</span><span class="si">}</span><span class="s2">, probs=</span><span class="si">{</span><span class="nb">str</span><span class="p">(</span><span class="n">probs</span><span class="p">)</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">)</span>
<span class="k">return</span> <span class="n">cs_ret_l</span></div>
<div class="viewcode-block" id="compare_ndarray_tuple"><a class="viewcode-back" href="../../api/test_utils/index.html#mxnet.test_utils.compare_ndarray_tuple">[docs]</a><span class="k">def</span> <span class="nf">compare_ndarray_tuple</span><span class="p">(</span><span class="n">t1</span><span class="p">,</span> <span class="n">t2</span><span class="p">,</span> <span class="n">rtol</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">atol</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Compare ndarray tuple.&quot;&quot;&quot;</span>
<span class="k">if</span> <span class="n">t1</span> <span class="ow">is</span> <span class="kc">None</span> <span class="ow">or</span> <span class="n">t2</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="k">return</span>
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">t1</span><span class="p">,</span> <span class="nb">tuple</span><span class="p">):</span>
<span class="k">for</span> <span class="n">s1</span><span class="p">,</span> <span class="n">s2</span> <span class="ow">in</span> <span class="nb">zip</span><span class="p">(</span><span class="n">t1</span><span class="p">,</span> <span class="n">t2</span><span class="p">):</span>
<span class="n">compare_ndarray_tuple</span><span class="p">(</span><span class="n">s1</span><span class="p">,</span> <span class="n">s2</span><span class="p">,</span> <span class="n">rtol</span><span class="p">,</span> <span class="n">atol</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">assert_almost_equal</span><span class="p">(</span><span class="n">t1</span><span class="p">,</span> <span class="n">t2</span><span class="p">,</span> <span class="n">rtol</span><span class="o">=</span><span class="n">rtol</span><span class="p">,</span> <span class="n">atol</span><span class="o">=</span><span class="n">atol</span><span class="p">)</span></div>
<div class="viewcode-block" id="compare_optimizer"><a class="viewcode-back" href="../../api/test_utils/index.html#mxnet.test_utils.compare_optimizer">[docs]</a><span class="k">def</span> <span class="nf">compare_optimizer</span><span class="p">(</span><span class="n">opt1</span><span class="p">,</span> <span class="n">opt2</span><span class="p">,</span> <span class="n">shapes</span><span class="p">,</span> <span class="n">dtype</span><span class="p">,</span> <span class="n">w_stype</span><span class="o">=</span><span class="s1">&#39;default&#39;</span><span class="p">,</span> <span class="n">g_stype</span><span class="o">=</span><span class="s1">&#39;default&#39;</span><span class="p">,</span>
<span class="n">rtol</span><span class="o">=</span><span class="mf">1e-4</span><span class="p">,</span> <span class="n">atol</span><span class="o">=</span><span class="mf">1e-5</span><span class="p">,</span> <span class="n">compare_states</span><span class="o">=</span><span class="kc">True</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Compare opt1 and opt2.&quot;&quot;&quot;</span>
<span class="n">w1_list</span><span class="p">,</span> <span class="n">w2_list</span> <span class="o">=</span> <span class="p">[],</span> <span class="p">[]</span>
<span class="n">g1_list</span><span class="p">,</span> <span class="n">g2_list</span> <span class="o">=</span> <span class="p">[],</span> <span class="p">[]</span>
<span class="n">s1_list</span><span class="p">,</span> <span class="n">s2_list</span> <span class="o">=</span> <span class="p">[],</span> <span class="p">[]</span>
<span class="k">for</span> <span class="n">i</span><span class="p">,</span> <span class="n">shape</span> <span class="ow">in</span> <span class="nb">enumerate</span><span class="p">(</span><span class="n">shapes</span><span class="p">):</span>
<span class="k">if</span> <span class="n">w_stype</span> <span class="o">==</span> <span class="s1">&#39;default&#39;</span><span class="p">:</span>
<span class="n">w2</span> <span class="o">=</span> <span class="n">mx</span><span class="o">.</span><span class="n">random</span><span class="o">.</span><span class="n">uniform</span><span class="p">(</span><span class="n">shape</span><span class="o">=</span><span class="n">shape</span><span class="p">,</span> <span class="n">ctx</span><span class="o">=</span><span class="n">default_device</span><span class="p">(),</span> <span class="n">dtype</span><span class="o">=</span><span class="n">dtype</span><span class="p">)</span>
<span class="n">w1</span> <span class="o">=</span> <span class="n">w2</span><span class="o">.</span><span class="n">copyto</span><span class="p">(</span><span class="n">default_device</span><span class="p">())</span>
<span class="k">elif</span> <span class="n">w_stype</span> <span class="ow">in</span> <span class="p">(</span><span class="s1">&#39;row_sparse&#39;</span><span class="p">,</span> <span class="s1">&#39;csr&#39;</span><span class="p">):</span>
<span class="n">w2</span> <span class="o">=</span> <span class="n">rand_ndarray</span><span class="p">(</span><span class="n">shape</span><span class="p">,</span> <span class="n">w_stype</span><span class="p">,</span> <span class="n">density</span><span class="o">=</span><span class="mi">1</span><span class="p">,</span> <span class="n">dtype</span><span class="o">=</span><span class="n">dtype</span><span class="p">)</span>
<span class="n">w1</span> <span class="o">=</span> <span class="n">w2</span><span class="o">.</span><span class="n">copyto</span><span class="p">(</span><span class="n">default_device</span><span class="p">())</span><span class="o">.</span><span class="n">tostype</span><span class="p">(</span><span class="s1">&#39;default&#39;</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">Exception</span><span class="p">(</span><span class="s2">&quot;type not supported yet&quot;</span><span class="p">)</span>
<span class="k">if</span> <span class="n">g_stype</span> <span class="o">==</span> <span class="s1">&#39;default&#39;</span><span class="p">:</span>
<span class="n">g2</span> <span class="o">=</span> <span class="n">mx</span><span class="o">.</span><span class="n">random</span><span class="o">.</span><span class="n">uniform</span><span class="p">(</span><span class="n">shape</span><span class="o">=</span><span class="n">shape</span><span class="p">,</span> <span class="n">ctx</span><span class="o">=</span><span class="n">default_device</span><span class="p">(),</span> <span class="n">dtype</span><span class="o">=</span><span class="n">dtype</span><span class="p">)</span>
<span class="n">g1</span> <span class="o">=</span> <span class="n">g2</span><span class="o">.</span><span class="n">copyto</span><span class="p">(</span><span class="n">default_device</span><span class="p">())</span>
<span class="k">elif</span> <span class="n">g_stype</span> <span class="ow">in</span> <span class="p">(</span><span class="s1">&#39;row_sparse&#39;</span><span class="p">,</span> <span class="s1">&#39;csr&#39;</span><span class="p">):</span>
<span class="n">g2</span> <span class="o">=</span> <span class="n">rand_ndarray</span><span class="p">(</span><span class="n">shape</span><span class="p">,</span> <span class="n">g_stype</span><span class="p">,</span> <span class="n">dtype</span><span class="o">=</span><span class="n">dtype</span><span class="p">)</span>
<span class="n">g1</span> <span class="o">=</span> <span class="n">g2</span><span class="o">.</span><span class="n">copyto</span><span class="p">(</span><span class="n">default_device</span><span class="p">())</span><span class="o">.</span><span class="n">tostype</span><span class="p">(</span><span class="s1">&#39;default&#39;</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">Exception</span><span class="p">(</span><span class="s2">&quot;type not supported yet&quot;</span><span class="p">)</span>
<span class="n">s1</span> <span class="o">=</span> <span class="n">opt1</span><span class="o">.</span><span class="n">create_state_multi_precision</span><span class="p">(</span><span class="n">i</span><span class="p">,</span> <span class="n">w1</span><span class="p">)</span>
<span class="n">s2</span> <span class="o">=</span> <span class="n">opt2</span><span class="o">.</span><span class="n">create_state_multi_precision</span><span class="p">(</span><span class="n">i</span><span class="p">,</span> <span class="n">w2</span><span class="p">)</span>
<span class="k">if</span> <span class="n">compare_states</span><span class="p">:</span>
<span class="n">compare_ndarray_tuple</span><span class="p">(</span><span class="n">s1</span><span class="p">,</span> <span class="n">s2</span><span class="p">)</span>
<span class="n">w1_list</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">w1</span><span class="p">)</span>
<span class="n">w2_list</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">w2</span><span class="p">)</span>
<span class="n">g1_list</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">g1</span><span class="p">)</span>
<span class="n">g2_list</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">g2</span><span class="p">)</span>
<span class="n">s1_list</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">s1</span><span class="p">)</span>
<span class="n">s2_list</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">s2</span><span class="p">)</span>
<span class="n">indices</span> <span class="o">=</span> <span class="nb">list</span><span class="p">(</span><span class="nb">range</span><span class="p">(</span><span class="nb">len</span><span class="p">(</span><span class="n">shapes</span><span class="p">)))</span>
<span class="n">opt1</span><span class="o">.</span><span class="n">update_multi_precision</span><span class="p">(</span><span class="n">indices</span><span class="p">,</span> <span class="n">w1_list</span><span class="p">,</span> <span class="n">g1_list</span><span class="p">,</span> <span class="n">s1_list</span><span class="p">)</span>
<span class="n">opt2</span><span class="o">.</span><span class="n">update_multi_precision</span><span class="p">(</span><span class="n">indices</span><span class="p">,</span> <span class="n">w2_list</span><span class="p">,</span> <span class="n">g2_list</span><span class="p">,</span> <span class="n">s2_list</span><span class="p">)</span>
<span class="k">if</span> <span class="n">compare_states</span><span class="p">:</span>
<span class="n">compare_ndarray_tuple</span><span class="p">(</span><span class="nb">tuple</span><span class="p">(</span><span class="n">s1_list</span><span class="p">),</span> <span class="nb">tuple</span><span class="p">(</span><span class="n">s2_list</span><span class="p">),</span> <span class="n">rtol</span><span class="o">=</span><span class="n">rtol</span><span class="p">,</span> <span class="n">atol</span><span class="o">=</span><span class="n">atol</span><span class="p">)</span>
<span class="n">compare_ndarray_tuple</span><span class="p">(</span><span class="nb">tuple</span><span class="p">(</span><span class="n">w1_list</span><span class="p">),</span> <span class="nb">tuple</span><span class="p">(</span><span class="n">w2_list</span><span class="p">),</span> <span class="n">rtol</span><span class="o">=</span><span class="n">rtol</span><span class="p">,</span> <span class="n">atol</span><span class="o">=</span><span class="n">atol</span><span class="p">)</span></div>
<div class="viewcode-block" id="compare_optimizer_noise_seeded"><a class="viewcode-back" href="../../api/test_utils/index.html#mxnet.test_utils.compare_optimizer_noise_seeded">[docs]</a><span class="k">def</span> <span class="nf">compare_optimizer_noise_seeded</span><span class="p">(</span><span class="n">opt1</span><span class="p">,</span> <span class="n">opt2</span><span class="p">,</span> <span class="n">shapes</span><span class="p">,</span> <span class="n">dtype</span><span class="p">,</span> <span class="n">noise_seed</span><span class="p">,</span>
<span class="n">w_stype</span><span class="o">=</span><span class="s1">&#39;default&#39;</span><span class="p">,</span> <span class="n">g_stype</span><span class="o">=</span><span class="s1">&#39;default&#39;</span><span class="p">,</span>
<span class="n">rtol</span><span class="o">=</span><span class="mf">1e-4</span><span class="p">,</span> <span class="n">atol</span><span class="o">=</span><span class="mf">1e-5</span><span class="p">,</span> <span class="n">compare_states</span><span class="o">=</span><span class="kc">True</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Compare opt1 and opt2 with the added functionality that the seed for generating random noise</span>
<span class="sd"> in the SGLD optimizer update is set so that the same noise is used in opt1 and opt2.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">w1_list</span><span class="p">,</span> <span class="n">w2_list</span> <span class="o">=</span> <span class="p">[],</span> <span class="p">[]</span>
<span class="n">g1_list</span><span class="p">,</span> <span class="n">g2_list</span> <span class="o">=</span> <span class="p">[],</span> <span class="p">[]</span>
<span class="n">s1_list</span><span class="p">,</span> <span class="n">s2_list</span> <span class="o">=</span> <span class="p">[],</span> <span class="p">[]</span>
<span class="k">for</span> <span class="n">i</span><span class="p">,</span> <span class="n">shape</span> <span class="ow">in</span> <span class="nb">enumerate</span><span class="p">(</span><span class="n">shapes</span><span class="p">):</span>
<span class="k">if</span> <span class="n">w_stype</span> <span class="o">==</span> <span class="s1">&#39;default&#39;</span><span class="p">:</span>
<span class="n">w2</span> <span class="o">=</span> <span class="n">mx</span><span class="o">.</span><span class="n">random</span><span class="o">.</span><span class="n">uniform</span><span class="p">(</span><span class="n">shape</span><span class="o">=</span><span class="n">shape</span><span class="p">,</span> <span class="n">ctx</span><span class="o">=</span><span class="n">default_device</span><span class="p">(),</span> <span class="n">dtype</span><span class="o">=</span><span class="n">dtype</span><span class="p">)</span>
<span class="n">w1</span> <span class="o">=</span> <span class="n">w2</span><span class="o">.</span><span class="n">copyto</span><span class="p">(</span><span class="n">default_device</span><span class="p">())</span>
<span class="k">elif</span> <span class="n">w_stype</span> <span class="ow">in</span> <span class="p">(</span><span class="s1">&#39;row_sparse&#39;</span><span class="p">,</span> <span class="s1">&#39;csr&#39;</span><span class="p">):</span>
<span class="n">w2</span> <span class="o">=</span> <span class="n">rand_ndarray</span><span class="p">(</span><span class="n">shape</span><span class="p">,</span> <span class="n">w_stype</span><span class="p">,</span> <span class="n">density</span><span class="o">=</span><span class="mi">1</span><span class="p">,</span> <span class="n">dtype</span><span class="o">=</span><span class="n">dtype</span><span class="p">)</span>
<span class="n">w1</span> <span class="o">=</span> <span class="n">w2</span><span class="o">.</span><span class="n">copyto</span><span class="p">(</span><span class="n">default_device</span><span class="p">())</span><span class="o">.</span><span class="n">tostype</span><span class="p">(</span><span class="s1">&#39;default&#39;</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">Exception</span><span class="p">(</span><span class="s2">&quot;type not supported yet&quot;</span><span class="p">)</span>
<span class="k">if</span> <span class="n">g_stype</span> <span class="o">==</span> <span class="s1">&#39;default&#39;</span><span class="p">:</span>
<span class="n">g2</span> <span class="o">=</span> <span class="n">mx</span><span class="o">.</span><span class="n">random</span><span class="o">.</span><span class="n">uniform</span><span class="p">(</span><span class="n">shape</span><span class="o">=</span><span class="n">shape</span><span class="p">,</span> <span class="n">ctx</span><span class="o">=</span><span class="n">default_device</span><span class="p">(),</span> <span class="n">dtype</span><span class="o">=</span><span class="n">dtype</span><span class="p">)</span>
<span class="n">g1</span> <span class="o">=</span> <span class="n">g2</span><span class="o">.</span><span class="n">copyto</span><span class="p">(</span><span class="n">default_device</span><span class="p">())</span>
<span class="k">elif</span> <span class="n">g_stype</span> <span class="ow">in</span> <span class="p">(</span><span class="s1">&#39;row_sparse&#39;</span><span class="p">,</span> <span class="s1">&#39;csr&#39;</span><span class="p">):</span>
<span class="n">g2</span> <span class="o">=</span> <span class="n">rand_ndarray</span><span class="p">(</span><span class="n">shape</span><span class="p">,</span> <span class="n">g_stype</span><span class="p">,</span> <span class="n">dtype</span><span class="o">=</span><span class="n">dtype</span><span class="p">)</span>
<span class="n">g1</span> <span class="o">=</span> <span class="n">g2</span><span class="o">.</span><span class="n">copyto</span><span class="p">(</span><span class="n">default_device</span><span class="p">())</span><span class="o">.</span><span class="n">tostype</span><span class="p">(</span><span class="s1">&#39;default&#39;</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">Exception</span><span class="p">(</span><span class="s2">&quot;type not supported yet&quot;</span><span class="p">)</span>
<span class="n">s1</span> <span class="o">=</span> <span class="n">opt1</span><span class="o">.</span><span class="n">create_state_multi_precision</span><span class="p">(</span><span class="n">i</span><span class="p">,</span> <span class="n">w1</span><span class="p">)</span>
<span class="n">s2</span> <span class="o">=</span> <span class="n">opt2</span><span class="o">.</span><span class="n">create_state_multi_precision</span><span class="p">(</span><span class="n">i</span><span class="p">,</span> <span class="n">w2</span><span class="p">)</span>
<span class="k">if</span> <span class="n">compare_states</span><span class="p">:</span>
<span class="n">compare_ndarray_tuple</span><span class="p">(</span><span class="n">s1</span><span class="p">,</span> <span class="n">s2</span><span class="p">)</span>
<span class="n">w1_list</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">w1</span><span class="p">)</span>
<span class="n">w2_list</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">w2</span><span class="p">)</span>
<span class="n">g1_list</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">g1</span><span class="p">)</span>
<span class="n">g2_list</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">g2</span><span class="p">)</span>
<span class="n">s1_list</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">s1</span><span class="p">)</span>
<span class="n">s2_list</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">s2</span><span class="p">)</span>
<span class="n">indices</span> <span class="o">=</span> <span class="nb">list</span><span class="p">(</span><span class="nb">range</span><span class="p">(</span><span class="nb">len</span><span class="p">(</span><span class="n">shapes</span><span class="p">)))</span>
<span class="c1"># set seed for Gaussian noise replication</span>
<span class="n">mx</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="n">noise_seed</span><span class="p">)</span>
<span class="n">opt1</span><span class="o">.</span><span class="n">update_multi_precision</span><span class="p">(</span><span class="n">indices</span><span class="p">,</span> <span class="n">w1_list</span><span class="p">,</span> <span class="n">g1_list</span><span class="p">,</span> <span class="n">s1_list</span><span class="p">)</span>
<span class="n">mx</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="n">noise_seed</span><span class="p">)</span>
<span class="n">opt2</span><span class="o">.</span><span class="n">update_multi_precision</span><span class="p">(</span><span class="n">indices</span><span class="p">,</span> <span class="n">w2_list</span><span class="p">,</span> <span class="n">g2_list</span><span class="p">,</span> <span class="n">s2_list</span><span class="p">)</span>
<span class="k">if</span> <span class="n">compare_states</span><span class="p">:</span>
<span class="n">compare_ndarray_tuple</span><span class="p">(</span><span class="nb">tuple</span><span class="p">(</span><span class="n">s1_list</span><span class="p">),</span> <span class="nb">tuple</span><span class="p">(</span><span class="n">s2_list</span><span class="p">),</span> <span class="n">rtol</span><span class="o">=</span><span class="n">rtol</span><span class="p">,</span> <span class="n">atol</span><span class="o">=</span><span class="n">atol</span><span class="p">)</span>
<span class="n">compare_ndarray_tuple</span><span class="p">(</span><span class="nb">tuple</span><span class="p">(</span><span class="n">w1_list</span><span class="p">),</span> <span class="nb">tuple</span><span class="p">(</span><span class="n">w2_list</span><span class="p">),</span> <span class="n">rtol</span><span class="o">=</span><span class="n">rtol</span><span class="p">,</span> <span class="n">atol</span><span class="o">=</span><span class="n">atol</span><span class="p">)</span></div>
<div class="viewcode-block" id="same_symbol_structure"><a class="viewcode-back" href="../../api/test_utils/index.html#mxnet.test_utils.same_symbol_structure">[docs]</a><span class="k">def</span> <span class="nf">same_symbol_structure</span><span class="p">(</span><span class="n">sym1</span><span class="p">,</span> <span class="n">sym2</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Compare two symbols to check if they have the same computation graph structure.</span>
<span class="sd"> Returns true if operator corresponding to a particular node id is same in both</span>
<span class="sd"> symbols for all nodes</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">conf</span> <span class="o">=</span> <span class="n">json</span><span class="o">.</span><span class="n">loads</span><span class="p">(</span><span class="n">sym1</span><span class="o">.</span><span class="n">tojson</span><span class="p">())</span>
<span class="n">nodes</span> <span class="o">=</span> <span class="n">conf</span><span class="p">[</span><span class="s2">&quot;nodes&quot;</span><span class="p">]</span>
<span class="n">conf2</span> <span class="o">=</span> <span class="n">json</span><span class="o">.</span><span class="n">loads</span><span class="p">(</span><span class="n">sym2</span><span class="o">.</span><span class="n">tojson</span><span class="p">())</span>
<span class="n">nodes2</span> <span class="o">=</span> <span class="n">conf2</span><span class="p">[</span><span class="s2">&quot;nodes&quot;</span><span class="p">]</span>
<span class="k">for</span> <span class="n">node1</span><span class="p">,</span> <span class="n">node2</span> <span class="ow">in</span> <span class="nb">zip</span><span class="p">(</span><span class="n">nodes</span><span class="p">,</span> <span class="n">nodes2</span><span class="p">):</span>
<span class="k">if</span> <span class="n">node1</span><span class="p">[</span><span class="s2">&quot;op&quot;</span><span class="p">]</span> <span class="o">!=</span> <span class="n">node2</span><span class="p">[</span><span class="s2">&quot;op&quot;</span><span class="p">]:</span>
<span class="k">return</span> <span class="kc">False</span>
<span class="k">return</span> <span class="kc">True</span></div>
<div class="viewcode-block" id="environment"><a class="viewcode-back" href="../../api/test_utils/index.html#mxnet.test_utils.environment">[docs]</a><span class="nd">@contextmanager</span>
<span class="k">def</span> <span class="nf">environment</span><span class="p">(</span><span class="o">*</span><span class="n">args</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Environment variable setter and unsetter via `with` idiom.</span>
<span class="sd"> Takes a specification of env var names and desired values and adds those</span>
<span class="sd"> settings to the environment in advance of running the body of the `with`</span>
<span class="sd"> statement. The original environment state is restored afterwards, even</span>
<span class="sd"> if exceptions are raised in the `with` body.</span>
<span class="sd"> Parameters</span>
<span class="sd"> ----------</span>
<span class="sd"> args:</span>
<span class="sd"> if 2 args are passed:</span>
<span class="sd"> name, desired_value strings of the single env var to update, or</span>
<span class="sd"> if 1 arg is passed:</span>
<span class="sd"> a dict of name:desired_value for env var&#39;s to update</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="c1"># On Linux, env var changes made through python&#39;s os.environ are seen</span>
<span class="c1"># by the backend. On Windows though, the C runtime gets a snapshot</span>
<span class="c1"># of the environment that cannot be altered by os.environ. Here we</span>
<span class="c1"># check, using a wrapped version of the backend&#39;s getenv(), that</span>
<span class="c1"># the desired env var value is seen by the backend, and otherwise use</span>
<span class="c1"># a wrapped setenv() to establish that value in the backend.</span>
<span class="c1"># Also on Windows, a set env var can never have the value &#39;&#39;, since</span>
<span class="c1"># the command &#39;set FOO= &#39; is used to unset the variable. Perhaps</span>
<span class="c1"># as a result, the wrapped dmlc::GetEnv() routine returns the same</span>
<span class="c1"># value for unset variables and those set to &#39;&#39;. As a result, we</span>
<span class="c1"># ignore discrepancy.</span>
<span class="k">def</span> <span class="nf">validate_backend_setting</span><span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="n">value</span><span class="p">,</span> <span class="n">can_use_setenv</span><span class="o">=</span><span class="kc">True</span><span class="p">):</span>
<span class="n">backend_value</span> <span class="o">=</span> <span class="n">getenv</span><span class="p">(</span><span class="n">name</span><span class="p">)</span>
<span class="k">if</span> <span class="n">value</span> <span class="o">==</span> <span class="n">backend_value</span> <span class="ow">or</span> \
<span class="n">value</span> <span class="o">==</span> <span class="s1">&#39;&#39;</span> <span class="ow">and</span> <span class="n">backend_value</span> <span class="ow">is</span> <span class="kc">None</span> <span class="ow">and</span> <span class="n">platform</span><span class="o">.</span><span class="n">system</span><span class="p">()</span> <span class="o">==</span> <span class="s1">&#39;Windows&#39;</span><span class="p">:</span>
<span class="k">return</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">can_use_setenv</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">RuntimeError</span><span class="p">(</span><span class="s1">&#39;Could not set env var </span><span class="si">{}</span><span class="s1">=</span><span class="si">{}</span><span class="s1"> within C Runtime&#39;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="n">value</span><span class="p">))</span>
<span class="n">setenv</span><span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="n">value</span><span class="p">)</span>
<span class="n">validate_backend_setting</span><span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="n">value</span><span class="p">,</span> <span class="n">can_use_setenv</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span>
<span class="c1"># Core routine to alter environment from a dict of env_var_name, env_var_value pairs</span>
<span class="k">def</span> <span class="nf">set_environ</span><span class="p">(</span><span class="n">env_var_dict</span><span class="p">):</span>
<span class="k">for</span> <span class="n">env_var_name</span><span class="p">,</span> <span class="n">env_var_value</span> <span class="ow">in</span> <span class="n">env_var_dict</span><span class="o">.</span><span class="n">items</span><span class="p">():</span>
<span class="k">if</span> <span class="n">env_var_value</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">pop</span><span class="p">(</span><span class="n">env_var_name</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="p">[</span><span class="n">env_var_name</span><span class="p">]</span> <span class="o">=</span> <span class="n">env_var_value</span>
<span class="n">validate_backend_setting</span><span class="p">(</span><span class="n">env_var_name</span><span class="p">,</span> <span class="n">env_var_value</span><span class="p">)</span>
<span class="c1"># Create env_var name:value dict from the two calling methods of this routine</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">args</span><span class="p">)</span> <span class="o">==</span> <span class="mi">1</span> <span class="ow">and</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">args</span><span class="p">[</span><span class="mi">0</span><span class="p">],</span> <span class="nb">dict</span><span class="p">):</span>
<span class="n">env_vars</span> <span class="o">=</span> <span class="n">args</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">assert</span> <span class="nb">len</span><span class="p">(</span><span class="n">args</span><span class="p">)</span> <span class="o">==</span> <span class="mi">2</span><span class="p">,</span> <span class="s1">&#39;Expecting one dict arg or two args: env var name and value&#39;</span>
<span class="n">env_vars</span> <span class="o">=</span> <span class="p">{</span><span class="n">args</span><span class="p">[</span><span class="mi">0</span><span class="p">]:</span> <span class="n">args</span><span class="p">[</span><span class="mi">1</span><span class="p">]}</span>
<span class="c1"># Take a snapshot of the existing environment variable state</span>
<span class="c1"># for those variables to be changed. get() return None for unset keys.</span>
<span class="n">snapshot</span> <span class="o">=</span> <span class="p">{</span><span class="n">x</span><span class="p">:</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">x</span><span class="p">)</span> <span class="k">for</span> <span class="n">x</span> <span class="ow">in</span> <span class="n">env_vars</span><span class="o">.</span><span class="n">keys</span><span class="p">()}</span>
<span class="c1"># Alter the environment per the env_vars dict</span>
<span class="n">set_environ</span><span class="p">(</span><span class="n">env_vars</span><span class="p">)</span>
<span class="c1"># Now run the wrapped code</span>
<span class="k">try</span><span class="p">:</span>
<span class="k">yield</span>
<span class="k">finally</span><span class="p">:</span>
<span class="c1"># the backend engines may still be referencing the changed env var state</span>
<span class="n">mx</span><span class="o">.</span><span class="n">nd</span><span class="o">.</span><span class="n">waitall</span><span class="p">()</span>
<span class="c1"># reinstate original env_var state per the snapshot taken earlier</span>
<span class="n">set_environ</span><span class="p">(</span><span class="n">snapshot</span><span class="p">)</span></div>
<div class="viewcode-block" id="collapse_sum_like"><a class="viewcode-back" href="../../api/test_utils/index.html#mxnet.test_utils.collapse_sum_like">[docs]</a><span class="k">def</span> <span class="nf">collapse_sum_like</span><span class="p">(</span><span class="n">a</span><span class="p">,</span> <span class="n">shape</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Given `a` as a numpy ndarray, perform reduce_sum on `a` over the axes that do not</span>
<span class="sd"> exist in `shape`. Note that an ndarray with `shape` must be broadcastable to `a`.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">assert</span> <span class="nb">len</span><span class="p">(</span><span class="n">a</span><span class="o">.</span><span class="n">shape</span><span class="p">)</span> <span class="o">&gt;=</span> <span class="nb">len</span><span class="p">(</span><span class="n">shape</span><span class="p">)</span>
<span class="k">if</span> <span class="n">np</span><span class="o">.</span><span class="n">prod</span><span class="p">(</span><span class="n">shape</span><span class="p">)</span> <span class="o">==</span> <span class="mi">0</span> <span class="ow">or</span> <span class="n">a</span><span class="o">.</span><span class="n">size</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>
<span class="k">return</span> <span class="n">np</span><span class="o">.</span><span class="n">zeros</span><span class="p">(</span><span class="n">shape</span><span class="p">,</span> <span class="n">dtype</span><span class="o">=</span><span class="n">a</span><span class="o">.</span><span class="n">dtype</span><span class="p">)</span>
<span class="n">axes</span> <span class="o">=</span> <span class="p">[]</span>
<span class="n">ndim_diff</span> <span class="o">=</span> <span class="nb">len</span><span class="p">(</span><span class="n">a</span><span class="o">.</span><span class="n">shape</span><span class="p">)</span> <span class="o">-</span> <span class="nb">len</span><span class="p">(</span><span class="n">shape</span><span class="p">)</span>
<span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="n">ndim_diff</span><span class="p">):</span>
<span class="n">axes</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">i</span><span class="p">)</span>
<span class="k">for</span> <span class="n">i</span><span class="p">,</span> <span class="n">s</span> <span class="ow">in</span> <span class="nb">enumerate</span><span class="p">(</span><span class="n">shape</span><span class="p">):</span>
<span class="k">if</span> <span class="n">s</span> <span class="o">!=</span> <span class="n">a</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="n">i</span><span class="o">+</span><span class="n">ndim_diff</span><span class="p">]:</span>
<span class="k">assert</span> <span class="n">s</span> <span class="o">==</span> <span class="mi">1</span>
<span class="n">axes</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">i</span><span class="o">+</span><span class="n">ndim_diff</span><span class="p">)</span>
<span class="k">return</span> <span class="n">np</span><span class="o">.</span><span class="n">sum</span><span class="p">(</span><span class="n">a</span><span class="p">,</span> <span class="n">axis</span><span class="o">=</span><span class="nb">tuple</span><span class="p">(</span><span class="n">axes</span><span class="p">))</span><span class="o">.</span><span class="n">reshape</span><span class="p">(</span><span class="n">shape</span><span class="p">)</span></div>
<div class="viewcode-block" id="is_cd_run"><a class="viewcode-back" href="../../api/test_utils/index.html#mxnet.test_utils.is_cd_run">[docs]</a><span class="k">def</span> <span class="nf">is_cd_run</span><span class="p">():</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Checks if the test is running as part of a Continuous Delivery run&quot;&quot;&quot;</span>
<span class="k">return</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">&quot;CD_JOB&quot;</span><span class="p">,</span> <span class="mi">0</span><span class="p">)</span> <span class="o">==</span> <span class="s2">&quot;1&quot;</span></div>
<span class="n">_features</span> <span class="o">=</span> <span class="n">Features</span><span class="p">()</span>
<div class="viewcode-block" id="has_tvm_ops"><a class="viewcode-back" href="../../api/test_utils/index.html#mxnet.test_utils.has_tvm_ops">[docs]</a><span class="k">def</span> <span class="nf">has_tvm_ops</span><span class="p">():</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Returns True if MXNet is compiled with TVM generated operators. If current ctx</span>
<span class="sd"> is GPU, it only returns True for CUDA compute capability &gt; 52 where FP16 is supported.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">built_with_tvm_op</span> <span class="o">=</span> <span class="n">_features</span><span class="o">.</span><span class="n">is_enabled</span><span class="p">(</span><span class="s2">&quot;TVM_OP&quot;</span><span class="p">)</span>
<span class="n">device</span> <span class="o">=</span> <span class="n">current_device</span><span class="p">()</span>
<span class="k">if</span> <span class="n">device</span><span class="o">.</span><span class="n">device_type</span> <span class="o">==</span> <span class="s1">&#39;gpu&#39;</span><span class="p">:</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">cc</span> <span class="o">=</span> <span class="n">get_cuda_compute_capability</span><span class="p">(</span><span class="n">device</span><span class="p">)</span>
<span class="k">except</span><span class="p">:</span> <span class="c1"># pylint: disable=bare-except</span>
<span class="nb">print</span><span class="p">(</span><span class="s1">&#39;Failed to get CUDA compute capability for context </span><span class="si">{}</span><span class="s1">. The operators &#39;</span>
<span class="s1">&#39;built with USE_TVM_OP=1 will not be run in unit tests.&#39;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">device</span><span class="p">))</span>
<span class="k">return</span> <span class="kc">False</span>
<span class="nb">print</span><span class="p">(</span><span class="s1">&#39;Cuda arch compute capability: sm_</span><span class="si">{}</span><span class="s1">&#39;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="n">cc</span><span class="p">)))</span>
<span class="k">return</span> <span class="n">built_with_tvm_op</span> <span class="ow">and</span> <span class="n">cc</span> <span class="o">&gt;=</span> <span class="mi">53</span>
<span class="k">return</span> <span class="n">built_with_tvm_op</span></div>
<div class="viewcode-block" id="is_op_runnable"><a class="viewcode-back" href="../../api/test_utils/index.html#mxnet.test_utils.is_op_runnable">[docs]</a><span class="k">def</span> <span class="nf">is_op_runnable</span><span class="p">():</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Returns True for all CPU tests. Returns True for GPU tests that are either of the following.</span>
<span class="sd"> 1. Built with USE_TVM_OP=0.</span>
<span class="sd"> 2. Built with USE_TVM_OP=1, but with compute capability &gt;= 53.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">device</span> <span class="o">=</span> <span class="n">current_device</span><span class="p">()</span>
<span class="k">if</span> <span class="n">device</span><span class="o">.</span><span class="n">device_type</span> <span class="o">==</span> <span class="s1">&#39;gpu&#39;</span><span class="p">:</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">_features</span><span class="o">.</span><span class="n">is_enabled</span><span class="p">(</span><span class="s2">&quot;TVM_OP&quot;</span><span class="p">):</span>
<span class="k">return</span> <span class="kc">True</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">cc</span> <span class="o">=</span> <span class="n">get_cuda_compute_capability</span><span class="p">(</span><span class="n">device</span><span class="p">)</span>
<span class="k">except</span><span class="p">:</span> <span class="c1"># pylint: disable=bare-except</span>
<span class="nb">print</span><span class="p">(</span><span class="s1">&#39;Failed to get CUDA compute capability for context </span><span class="si">{}</span><span class="s1">. The operators &#39;</span>
<span class="s1">&#39;built with USE_TVM_OP=1 will not be run in unit tests.&#39;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">device</span><span class="p">))</span>
<span class="k">return</span> <span class="kc">False</span>
<span class="nb">print</span><span class="p">(</span><span class="s1">&#39;Cuda arch compute capability: sm_</span><span class="si">{}</span><span class="s1">&#39;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="n">cc</span><span class="p">)))</span>
<span class="k">return</span> <span class="n">cc</span> <span class="o">&gt;=</span> <span class="mi">53</span>
<span class="k">return</span> <span class="kc">True</span></div>
<div class="viewcode-block" id="check_gluon_hybridize_consistency"><a class="viewcode-back" href="../../api/test_utils/index.html#mxnet.test_utils.check_gluon_hybridize_consistency">[docs]</a><span class="nd">@use_np</span>
<span class="k">def</span> <span class="nf">check_gluon_hybridize_consistency</span><span class="p">(</span><span class="n">net_builder</span><span class="p">,</span> <span class="n">data_l</span><span class="p">,</span> <span class="n">numpy_func</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">test_grad</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span>
<span class="n">rtol</span><span class="o">=</span><span class="mf">1E-4</span><span class="p">,</span> <span class="n">atol</span><span class="o">=</span><span class="mf">1E-4</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Check whether a HybridBlock has consistent output when hybridized or not hybridized</span>
<span class="sd"> The network should not contain any random number generators.</span>
<span class="sd"> Parameters</span>
<span class="sd"> ----------</span>
<span class="sd"> net_builder : function</span>
<span class="sd"> The builder of the HybridBlock that we are going to check the consistency.</span>
<span class="sd"> Inside the implementation, we will call net_builder() to construct the hybrid block.</span>
<span class="sd"> Also, the net_builder will need to support specifying the params</span>
<span class="sd"> data_l : list of mx.np.ndarray</span>
<span class="sd"> List of input ndarrays.</span>
<span class="sd"> numpy_func : function, optional</span>
<span class="sd"> The ground truth numpy function that has the same functionality as net_builder().</span>
<span class="sd"> Default None.</span>
<span class="sd"> test_grad : bool, optional</span>
<span class="sd"> Whether to test the consistency of the gradient. Default True.</span>
<span class="sd"> rtol : float, optional</span>
<span class="sd"> The relative error tolerance, default 1E-4. Default 1E-4.</span>
<span class="sd"> atol : float, optional</span>
<span class="sd"> The absolute error tolerance, default 1E-4. Default 1E-4.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">saved_out_np</span> <span class="o">=</span> <span class="kc">None</span>
<span class="n">saved_grad_np_l</span> <span class="o">=</span> <span class="kc">None</span>
<span class="n">params_init</span> <span class="o">=</span> <span class="kc">None</span>
<span class="n">use_autograd_flags</span> <span class="o">=</span> <span class="p">[</span><span class="kc">False</span><span class="p">,</span> <span class="kc">True</span><span class="p">]</span> <span class="k">if</span> <span class="n">test_grad</span> <span class="k">else</span> <span class="p">[</span><span class="kc">False</span><span class="p">]</span>
<span class="k">for</span> <span class="n">hybridize</span> <span class="ow">in</span> <span class="p">[</span><span class="kc">False</span><span class="p">,</span> <span class="kc">True</span><span class="p">]:</span>
<span class="k">for</span> <span class="n">use_autograd</span> <span class="ow">in</span> <span class="n">use_autograd_flags</span><span class="p">:</span>
<span class="n">net</span> <span class="o">=</span> <span class="n">net_builder</span><span class="p">()</span>
<span class="k">if</span> <span class="n">params_init</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">net</span><span class="o">.</span><span class="n">initialize</span><span class="p">()</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">net</span><span class="o">.</span><span class="n">load_dict</span><span class="p">(</span><span class="n">params_init</span><span class="p">)</span>
<span class="k">if</span> <span class="n">hybridize</span><span class="p">:</span>
<span class="n">net</span><span class="o">.</span><span class="n">hybridize</span><span class="p">()</span>
<span class="n">in_data_l</span> <span class="o">=</span> <span class="p">[</span><span class="n">ele</span><span class="o">.</span><span class="n">copy</span><span class="p">()</span> <span class="k">for</span> <span class="n">ele</span> <span class="ow">in</span> <span class="n">data_l</span><span class="p">]</span>
<span class="k">if</span> <span class="n">use_autograd</span><span class="p">:</span>
<span class="k">for</span> <span class="n">ele</span> <span class="ow">in</span> <span class="n">in_data_l</span><span class="p">:</span>
<span class="n">ele</span><span class="o">.</span><span class="n">attach_grad</span><span class="p">()</span>
<span class="k">with</span> <span class="n">mx</span><span class="o">.</span><span class="n">autograd</span><span class="o">.</span><span class="n">record</span><span class="p">():</span>
<span class="n">out</span> <span class="o">=</span> <span class="n">net</span><span class="p">(</span><span class="o">*</span><span class="n">in_data_l</span><span class="p">)</span>
<span class="n">out</span><span class="o">.</span><span class="n">backward</span><span class="p">(</span><span class="n">out</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">out</span> <span class="o">=</span> <span class="n">net</span><span class="p">(</span><span class="o">*</span><span class="n">in_data_l</span><span class="p">)</span>
<span class="k">if</span> <span class="n">params_init</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span> <span class="c1"># Deferred initialization finished</span>
<span class="n">params_init</span> <span class="o">=</span> <span class="p">{</span><span class="n">k</span><span class="p">:</span> <span class="n">v</span><span class="o">.</span><span class="n">data</span><span class="p">()</span><span class="o">.</span><span class="n">asnumpy</span><span class="p">()</span> <span class="k">for</span> <span class="n">k</span><span class="p">,</span> <span class="n">v</span> <span class="ow">in</span> <span class="n">net</span><span class="o">.</span><span class="n">collect_params</span><span class="p">()</span><span class="o">.</span><span class="n">items</span><span class="p">()}</span>
<span class="k">if</span> <span class="n">saved_out_np</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">saved_out_np</span> <span class="o">=</span> <span class="n">out</span><span class="o">.</span><span class="n">asnumpy</span><span class="p">()</span>
<span class="k">else</span><span class="p">:</span>
<span class="c1"># Check for correctness</span>
<span class="n">assert_almost_equal</span><span class="p">(</span><span class="n">out</span><span class="o">.</span><span class="n">asnumpy</span><span class="p">(),</span> <span class="n">saved_out_np</span><span class="p">,</span> <span class="n">rtol</span><span class="o">=</span><span class="n">rtol</span><span class="p">,</span> <span class="n">atol</span><span class="o">=</span><span class="n">atol</span><span class="p">)</span>
<span class="k">if</span> <span class="n">use_autograd</span><span class="p">:</span>
<span class="k">if</span> <span class="n">saved_grad_np_l</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">saved_grad_np_l</span> <span class="o">=</span> <span class="p">[</span><span class="n">ele</span><span class="o">.</span><span class="n">grad</span><span class="o">.</span><span class="n">asnumpy</span><span class="p">()</span> <span class="k">for</span> <span class="n">ele</span> <span class="ow">in</span> <span class="n">in_data_l</span><span class="p">]</span>
<span class="k">else</span><span class="p">:</span>
<span class="c1"># Check for correctness</span>
<span class="k">for</span> <span class="n">data</span><span class="p">,</span> <span class="n">saved_grad_np</span> <span class="ow">in</span> <span class="nb">zip</span><span class="p">(</span><span class="n">in_data_l</span><span class="p">,</span> <span class="n">saved_grad_np_l</span><span class="p">):</span>
<span class="n">assert_almost_equal</span><span class="p">(</span><span class="n">data</span><span class="o">.</span><span class="n">grad</span><span class="o">.</span><span class="n">asnumpy</span><span class="p">(),</span> <span class="n">saved_grad_np</span><span class="p">,</span>
<span class="n">rtol</span><span class="o">=</span><span class="n">rtol</span><span class="p">,</span> <span class="n">atol</span><span class="o">=</span><span class="n">atol</span><span class="p">)</span>
<span class="k">if</span> <span class="n">numpy_func</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">numpy_out</span> <span class="o">=</span> <span class="n">numpy_func</span><span class="p">(</span><span class="o">*</span><span class="p">[</span><span class="n">ele</span><span class="o">.</span><span class="n">asnumpy</span><span class="p">()</span> <span class="k">for</span> <span class="n">ele</span> <span class="ow">in</span> <span class="n">data_l</span><span class="p">])</span>
<span class="n">assert_almost_equal</span><span class="p">(</span><span class="n">saved_out_np</span><span class="p">,</span> <span class="n">numpy_out</span><span class="p">,</span> <span class="n">rtol</span><span class="o">=</span><span class="n">rtol</span><span class="p">,</span> <span class="n">atol</span><span class="o">=</span><span class="n">atol</span><span class="p">)</span></div>
<div class="viewcode-block" id="new_matrix_with_real_eigvals_2d"><a class="viewcode-back" href="../../api/test_utils/index.html#mxnet.test_utils.new_matrix_with_real_eigvals_2d">[docs]</a><span class="k">def</span> <span class="nf">new_matrix_with_real_eigvals_2d</span><span class="p">(</span><span class="n">n</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Generate a well-conditioned matrix with small real eigenvalues.&quot;&quot;&quot;</span>
<span class="n">shape</span> <span class="o">=</span> <span class="p">(</span><span class="n">n</span><span class="p">,</span> <span class="n">n</span><span class="p">)</span>
<span class="n">q</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">ones</span><span class="p">(</span><span class="n">shape</span><span class="p">)</span>
<span class="k">while</span> <span class="mi">1</span><span class="p">:</span>
<span class="n">D</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">diag</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">uniform</span><span class="p">(</span><span class="o">-</span><span class="mf">1.0</span><span class="p">,</span> <span class="mf">1.0</span><span class="p">,</span> <span class="n">shape</span><span class="p">[</span><span class="o">-</span><span class="mi">1</span><span class="p">]))</span>
<span class="n">I</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">eye</span><span class="p">(</span><span class="n">shape</span><span class="p">[</span><span class="o">-</span><span class="mi">1</span><span class="p">])</span><span class="o">.</span><span class="n">reshape</span><span class="p">(</span><span class="n">shape</span><span class="p">)</span>
<span class="n">v</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">random</span><span class="o">.</span><span class="n">uniform</span><span class="p">(</span><span class="o">-</span><span class="mf">1.</span><span class="p">,</span> <span class="mf">1.</span><span class="p">,</span> <span class="n">shape</span><span class="p">[</span><span class="o">-</span><span class="mi">1</span><span class="p">])</span><span class="o">.</span><span class="n">reshape</span><span class="p">(</span><span class="n">shape</span><span class="p">[:</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span> <span class="o">+</span> <span class="p">(</span><span class="mi">1</span><span class="p">,))</span>
<span class="n">v</span> <span class="o">=</span> <span class="n">v</span> <span class="o">/</span> <span class="n">np</span><span class="o">.</span><span class="n">linalg</span><span class="o">.</span><span class="n">norm</span><span class="p">(</span><span class="n">v</span><span class="p">,</span> <span class="n">axis</span><span class="o">=-</span><span class="mi">2</span><span class="p">,</span> <span class="n">keepdims</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
<span class="n">v_T</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">swapaxes</span><span class="p">(</span><span class="n">v</span><span class="p">,</span> <span class="o">-</span><span class="mi">1</span><span class="p">,</span> <span class="o">-</span><span class="mi">2</span><span class="p">)</span>
<span class="n">U</span> <span class="o">=</span> <span class="n">I</span> <span class="o">-</span> <span class="mi">2</span> <span class="o">*</span> <span class="n">np</span><span class="o">.</span><span class="n">matmul</span><span class="p">(</span><span class="n">v</span><span class="p">,</span> <span class="n">v_T</span><span class="p">)</span>
<span class="n">q</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">matmul</span><span class="p">(</span><span class="n">U</span><span class="p">,</span> <span class="n">D</span><span class="p">)</span>
<span class="k">if</span> <span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">linalg</span><span class="o">.</span><span class="n">cond</span><span class="p">(</span><span class="n">q</span><span class="p">,</span> <span class="mi">2</span><span class="p">)</span> <span class="o">&lt;</span> <span class="mi">3</span><span class="p">):</span>
<span class="k">break</span>
<span class="n">D</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">diag</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">uniform</span><span class="p">(</span><span class="o">-</span><span class="mf">10.0</span><span class="p">,</span> <span class="mf">10.0</span><span class="p">,</span> <span class="n">n</span><span class="p">))</span>
<span class="n">q_inv</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">linalg</span><span class="o">.</span><span class="n">inv</span><span class="p">(</span><span class="n">q</span><span class="p">)</span>
<span class="k">return</span> <span class="n">np</span><span class="o">.</span><span class="n">matmul</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">matmul</span><span class="p">(</span><span class="n">q_inv</span><span class="p">,</span> <span class="n">D</span><span class="p">),</span> <span class="n">q</span><span class="p">)</span></div>
<div class="viewcode-block" id="new_matrix_with_real_eigvals_nd"><a class="viewcode-back" href="../../api/test_utils/index.html#mxnet.test_utils.new_matrix_with_real_eigvals_nd">[docs]</a><span class="k">def</span> <span class="nf">new_matrix_with_real_eigvals_nd</span><span class="p">(</span><span class="n">shape</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Generate well-conditioned matrices with small real eigenvalues.&quot;&quot;&quot;</span>
<span class="n">n</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">prod</span><span class="p">(</span><span class="n">shape</span><span class="p">[:</span><span class="o">-</span><span class="mi">2</span><span class="p">]))</span> <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">shape</span><span class="p">)</span> <span class="o">&gt;</span> <span class="mi">2</span> <span class="k">else</span> <span class="mi">1</span>
<span class="k">return</span> <span class="n">np</span><span class="o">.</span><span class="n">array</span><span class="p">([</span><span class="n">new_matrix_with_real_eigvals_2d</span><span class="p">(</span><span class="n">shape</span><span class="p">[</span><span class="o">-</span><span class="mi">1</span><span class="p">])</span> <span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="n">n</span><span class="p">)])</span><span class="o">.</span><span class="n">reshape</span><span class="p">(</span><span class="n">shape</span><span class="p">)</span></div>
<div class="viewcode-block" id="new_orthonormal_matrix_2d"><a class="viewcode-back" href="../../api/test_utils/index.html#mxnet.test_utils.new_orthonormal_matrix_2d">[docs]</a><span class="k">def</span> <span class="nf">new_orthonormal_matrix_2d</span><span class="p">(</span><span class="n">n</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Generate a orthonormal matrix.&quot;&quot;&quot;</span>
<span class="n">x</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">random</span><span class="o">.</span><span class="n">randn</span><span class="p">(</span><span class="n">n</span><span class="p">,</span> <span class="n">n</span><span class="p">)</span>
<span class="n">x_trans</span> <span class="o">=</span> <span class="n">x</span><span class="o">.</span><span class="n">T</span>
<span class="n">sym_mat</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">matmul</span><span class="p">(</span><span class="n">x_trans</span><span class="p">,</span> <span class="n">x</span><span class="p">)</span>
<span class="k">return</span> <span class="n">np</span><span class="o">.</span><span class="n">linalg</span><span class="o">.</span><span class="n">qr</span><span class="p">(</span><span class="n">sym_mat</span><span class="p">)[</span><span class="mi">0</span><span class="p">]</span></div>
<div class="viewcode-block" id="new_sym_matrix_with_real_eigvals_2d"><a class="viewcode-back" href="../../api/test_utils/index.html#mxnet.test_utils.new_sym_matrix_with_real_eigvals_2d">[docs]</a><span class="k">def</span> <span class="nf">new_sym_matrix_with_real_eigvals_2d</span><span class="p">(</span><span class="n">n</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Generate a sym matrix with real eigenvalues.&quot;&quot;&quot;</span>
<span class="n">q</span> <span class="o">=</span> <span class="n">new_orthonormal_matrix_2d</span><span class="p">(</span><span class="n">n</span><span class="p">)</span>
<span class="n">D</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">diag</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">uniform</span><span class="p">(</span><span class="o">-</span><span class="mf">10.0</span><span class="p">,</span> <span class="mf">10.0</span><span class="p">,</span> <span class="n">n</span><span class="p">))</span>
<span class="k">return</span> <span class="n">np</span><span class="o">.</span><span class="n">matmul</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">matmul</span><span class="p">(</span><span class="n">q</span><span class="o">.</span><span class="n">T</span><span class="p">,</span> <span class="n">D</span><span class="p">),</span> <span class="n">q</span><span class="p">)</span></div>
<div class="viewcode-block" id="new_sym_matrix_with_real_eigvals_nd"><a class="viewcode-back" href="../../api/test_utils/index.html#mxnet.test_utils.new_sym_matrix_with_real_eigvals_nd">[docs]</a><span class="k">def</span> <span class="nf">new_sym_matrix_with_real_eigvals_nd</span><span class="p">(</span><span class="n">shape</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Generate sym matrices with real eigenvalues.&quot;&quot;&quot;</span>
<span class="n">n</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">prod</span><span class="p">(</span><span class="n">shape</span><span class="p">[:</span><span class="o">-</span><span class="mi">2</span><span class="p">]))</span> <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">shape</span><span class="p">)</span> <span class="o">&gt;</span> <span class="mi">2</span> <span class="k">else</span> <span class="mi">1</span>
<span class="k">return</span> <span class="n">np</span><span class="o">.</span><span class="n">array</span><span class="p">([</span><span class="n">new_sym_matrix_with_real_eigvals_2d</span><span class="p">(</span><span class="n">shape</span><span class="p">[</span><span class="o">-</span><span class="mi">1</span><span class="p">])</span> <span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="n">n</span><span class="p">)])</span><span class="o">.</span><span class="n">reshape</span><span class="p">(</span><span class="n">shape</span><span class="p">)</span></div>
</pre></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">
</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>