| <!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; |
| } |
| |
| .dropdown-caret-path { |
| fill: #FFFFFF; |
| } |
| </style> |
| |
| <title>mxnet.gluon.block — 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> |
| <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="/versions/1.9.1/"><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="/versions/1.9.1/get_started">Get Started</a> |
| <a class="page-link" href="/versions/1.9.1/features">Features</a> |
| <a class="page-link" href="/versions/1.9.1/ecosystem">Ecosystem</a> |
| <a class="page-link page-current" href="/versions/1.9.1/api">Docs & Tutorials</a> |
| <a class="page-link" href="/versions/1.9.1/trusted_by">Trusted By</a> |
| <a class="page-link" href="https://github.com/apache/incubator-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">1.9.1 |
| <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" href="/">master</a><br> |
| <a class="dropdown-option-active" 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.gluon.block</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> |
| |
| </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/1-ndarray.html">Manipulate data with <code class="docutils literal notranslate"><span class="pre">ndarray</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="../../../tutorials/getting-started/crash-course/2-nn.html">Create a neural network</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="../../../tutorials/getting-started/crash-course/3-autograd.html">Automatic differentiation with <code class="docutils literal notranslate"><span class="pre">autograd</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="../../../tutorials/getting-started/crash-course/4-train.html">Train the neural network</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="../../../tutorials/getting-started/crash-course/5-predict.html">Predict with a pre-trained model</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="../../../tutorials/getting-started/crash-course/6-use_gpus.html">Use GPUs</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/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/custom_layer_beginners.html">Customer Layers (Beginners)</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/data_augmentation.html#Spatial-Augmentation">Spatial Augmentation</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../../tutorials/packages/gluon/data/data_augmentation.html#Color-Augmentation">Color Augmentation</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../../tutorials/packages/gluon/data/data_augmentation.html#Composed-Augmentations">Composed Augmentations</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/image-augmentation.html">Image Augmentation</a></li> |
| <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> |
| <li class="toctree-l5"><a class="reference internal" href="../../../tutorials/packages/gluon/image/pretrained_models.html">Using pre-trained models in MXNet</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/ndarray/index.html">NDArray</a><ul> |
| <li class="toctree-l4"><a class="reference internal" href="../../../tutorials/packages/ndarray/01-ndarray-intro.html">An Intro: Manipulate Data the MXNet Way with NDArray</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="../../../tutorials/packages/ndarray/02-ndarray-operations.html">NDArray Operations</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="../../../tutorials/packages/ndarray/03-ndarray-contexts.html">NDArray Contexts</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="../../../tutorials/packages/ndarray/gotchas_numpy_in_mxnet.html">Gotchas using NumPy in Apache MXNet</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="../../../tutorials/packages/ndarray/sparse/index.html">Tutorials</a><ul> |
| <li class="toctree-l5"><a class="reference internal" href="../../../tutorials/packages/ndarray/sparse/csr.html">CSRNDArray - NDArray in Compressed Sparse Row Storage Format</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../../tutorials/packages/ndarray/sparse/row_sparse.html">RowSparseNDArray - NDArray for Sparse Gradient Updates</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../../tutorials/packages/ndarray/sparse/train.html">Train a Linear Regression Model with Sparse Symbols</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../../tutorials/packages/ndarray/sparse/train_gluon.html">Sparse NDArrays with Gluon</a></li> |
| </ul> |
| </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 internal" href="../../../tutorials/packages/onnx/super_resolution.html">Importing an ONNX model into MXNet</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/mkldnn/index.html">Intel MKL-DNN</a><ul> |
| <li class="toctree-l5"><a class="reference internal" href="../../../tutorials/performance/backend/mkldnn/mkldnn_quantization.html">Quantize with MKL-DNN backend</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../../tutorials/performance/backend/mkldnn/mkldnn_quantization.html#Improving-accuracy-with-Intel®-Neural-Compressor">Improving accuracy with Intel® Neural Compressor</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../../tutorials/performance/backend/mkldnn/mkldnn_readme.html">Install MXNet with MKL-DNN</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l4"><a class="reference internal" href="../../../tutorials/performance/backend/tensorrt/index.html">TensorRT</a><ul> |
| <li class="toctree-l5"><a class="reference internal" href="../../../tutorials/performance/backend/tensorrt/tensorrt.html">Optimizing Deep Learning Computation Graphs with TensorRT</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> |
| <li class="toctree-l4"><a class="reference internal" href="../../../tutorials/deploy/inference/scala.html">Deploy into a Java or Scala Environment</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="../../../tutorials/deploy/inference/wine_detector.html">Real-time Object Detection with MXNet On The Raspberry Pi</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/custom_layer.html">Custom Layers</a></li> |
| <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> |
| </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/ndarray/index.html">mxnet.ndarray</a><ul> |
| <li class="toctree-l3"><a class="reference internal" href="../../../api/ndarray/ndarray.html">ndarray</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../../api/ndarray/contrib/index.html">ndarray.contrib</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../../api/ndarray/image/index.html">ndarray.image</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../../api/ndarray/linalg/index.html">ndarray.linalg</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../../api/ndarray/op/index.html">ndarray.op</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../../api/ndarray/random/index.html">ndarray.random</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../../api/ndarray/register/index.html">ndarray.register</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../../api/ndarray/sparse/index.html">ndarray.sparse</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../../api/ndarray/utils/index.html">ndarray.utils</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/parameter_dict.html">gluon.ParameterDict</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/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/metric/index.html">mxnet.metric</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../../api/kvstore/index.html">mxnet.kvstore</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../../api/symbol/index.html">mxnet.symbol</a><ul> |
| <li class="toctree-l3"><a class="reference internal" href="../../../api/symbol/symbol.html">symbol</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../../api/symbol/contrib/index.html">symbol.contrib</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../../api/symbol/image/index.html">symbol.image</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../../api/symbol/linalg/index.html">symbol.linalg</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../../api/symbol/op/index.html">symbol.op</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../../api/symbol/random/index.html">symbol.random</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../../api/symbol/register/index.html">symbol.register</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../../api/symbol/sparse/index.html">symbol.sparse</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l2"><a class="reference internal" href="../../../api/module/index.html">mxnet.module</a></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/autograd/index.html">contrib.autograd</a></li> |
| <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/mxnet/index.html">mxnet</a><ul> |
| <li class="toctree-l3"><a class="reference internal" href="../../../api/mxnet/attribute/index.html">mxnet.attribute</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../../api/mxnet/base/index.html">mxnet.base</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../../api/mxnet/callback/index.html">mxnet.callback</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../../api/mxnet/context/index.html">mxnet.context</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../../api/mxnet/engine/index.html">mxnet.engine</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../../api/mxnet/executor/index.html">mxnet.executor</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../../api/mxnet/executor_manager/index.html">mxnet.executor_manager</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../../api/mxnet/image/index.html">mxnet.image</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../../api/mxnet/io/index.html">mxnet.io</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../../api/mxnet/kvstore_server/index.html">mxnet.kvstore_server</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../../api/mxnet/libinfo/index.html">mxnet.libinfo</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../../api/mxnet/log/index.html">mxnet.log</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../../api/mxnet/model/index.html">mxnet.model</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../../api/mxnet/monitor/index.html">mxnet.monitor</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../../api/mxnet/name/index.html">mxnet.name</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../../api/mxnet/notebook/index.html">mxnet.notebook</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../../api/mxnet/operator/index.html">mxnet.operator</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../../api/mxnet/profiler/index.html">mxnet.profiler</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../../api/mxnet/random/index.html">mxnet.random</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../../api/mxnet/recordio/index.html">mxnet.recordio</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../../api/mxnet/registry/index.html">mxnet.registry</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../../api/mxnet/rtc/index.html">mxnet.rtc</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../../api/mxnet/runtime/index.html">mxnet.runtime</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../../api/mxnet/test_utils/index.html">mxnet.test_utils</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../../api/mxnet/torch/index.html">mxnet.torch</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../../api/mxnet/util/index.html">mxnet.util</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../../api/mxnet/visualization/index.html">mxnet.visualization</a></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| |
| </nav> |
| |
| </div> |
| |
| </header> |
| <main class="mdl-layout__content" tabIndex="0"> |
| |
| <script type="text/javascript" src="../../../_static/sphinx_materialdesign_theme.js "></script> |
| <script type="text/javascript" src="../../../_static/feedback.js"></script> |
| <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/1-ndarray.html">Manipulate data with <code class="docutils literal notranslate"><span class="pre">ndarray</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="../../../tutorials/getting-started/crash-course/2-nn.html">Create a neural network</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="../../../tutorials/getting-started/crash-course/3-autograd.html">Automatic differentiation with <code class="docutils literal notranslate"><span class="pre">autograd</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="../../../tutorials/getting-started/crash-course/4-train.html">Train the neural network</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="../../../tutorials/getting-started/crash-course/5-predict.html">Predict with a pre-trained model</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="../../../tutorials/getting-started/crash-course/6-use_gpus.html">Use GPUs</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/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/custom_layer_beginners.html">Customer Layers (Beginners)</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/data_augmentation.html#Spatial-Augmentation">Spatial Augmentation</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../../tutorials/packages/gluon/data/data_augmentation.html#Color-Augmentation">Color Augmentation</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../../tutorials/packages/gluon/data/data_augmentation.html#Composed-Augmentations">Composed Augmentations</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/image-augmentation.html">Image Augmentation</a></li> |
| <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> |
| <li class="toctree-l5"><a class="reference internal" href="../../../tutorials/packages/gluon/image/pretrained_models.html">Using pre-trained models in MXNet</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/ndarray/index.html">NDArray</a><ul> |
| <li class="toctree-l4"><a class="reference internal" href="../../../tutorials/packages/ndarray/01-ndarray-intro.html">An Intro: Manipulate Data the MXNet Way with NDArray</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="../../../tutorials/packages/ndarray/02-ndarray-operations.html">NDArray Operations</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="../../../tutorials/packages/ndarray/03-ndarray-contexts.html">NDArray Contexts</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="../../../tutorials/packages/ndarray/gotchas_numpy_in_mxnet.html">Gotchas using NumPy in Apache MXNet</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="../../../tutorials/packages/ndarray/sparse/index.html">Tutorials</a><ul> |
| <li class="toctree-l5"><a class="reference internal" href="../../../tutorials/packages/ndarray/sparse/csr.html">CSRNDArray - NDArray in Compressed Sparse Row Storage Format</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../../tutorials/packages/ndarray/sparse/row_sparse.html">RowSparseNDArray - NDArray for Sparse Gradient Updates</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../../tutorials/packages/ndarray/sparse/train.html">Train a Linear Regression Model with Sparse Symbols</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../../tutorials/packages/ndarray/sparse/train_gluon.html">Sparse NDArrays with Gluon</a></li> |
| </ul> |
| </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 internal" href="../../../tutorials/packages/onnx/super_resolution.html">Importing an ONNX model into MXNet</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/mkldnn/index.html">Intel MKL-DNN</a><ul> |
| <li class="toctree-l5"><a class="reference internal" href="../../../tutorials/performance/backend/mkldnn/mkldnn_quantization.html">Quantize with MKL-DNN backend</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../../tutorials/performance/backend/mkldnn/mkldnn_quantization.html#Improving-accuracy-with-Intel®-Neural-Compressor">Improving accuracy with Intel® Neural Compressor</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="../../../tutorials/performance/backend/mkldnn/mkldnn_readme.html">Install MXNet with MKL-DNN</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l4"><a class="reference internal" href="../../../tutorials/performance/backend/tensorrt/index.html">TensorRT</a><ul> |
| <li class="toctree-l5"><a class="reference internal" href="../../../tutorials/performance/backend/tensorrt/tensorrt.html">Optimizing Deep Learning Computation Graphs with TensorRT</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> |
| <li class="toctree-l4"><a class="reference internal" href="../../../tutorials/deploy/inference/scala.html">Deploy into a Java or Scala Environment</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="../../../tutorials/deploy/inference/wine_detector.html">Real-time Object Detection with MXNet On The Raspberry Pi</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/custom_layer.html">Custom Layers</a></li> |
| <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> |
| </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/ndarray/index.html">mxnet.ndarray</a><ul> |
| <li class="toctree-l3"><a class="reference internal" href="../../../api/ndarray/ndarray.html">ndarray</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../../api/ndarray/contrib/index.html">ndarray.contrib</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../../api/ndarray/image/index.html">ndarray.image</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../../api/ndarray/linalg/index.html">ndarray.linalg</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../../api/ndarray/op/index.html">ndarray.op</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../../api/ndarray/random/index.html">ndarray.random</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../../api/ndarray/register/index.html">ndarray.register</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../../api/ndarray/sparse/index.html">ndarray.sparse</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../../api/ndarray/utils/index.html">ndarray.utils</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/parameter_dict.html">gluon.ParameterDict</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/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/metric/index.html">mxnet.metric</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../../api/kvstore/index.html">mxnet.kvstore</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../../api/symbol/index.html">mxnet.symbol</a><ul> |
| <li class="toctree-l3"><a class="reference internal" href="../../../api/symbol/symbol.html">symbol</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../../api/symbol/contrib/index.html">symbol.contrib</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../../api/symbol/image/index.html">symbol.image</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../../api/symbol/linalg/index.html">symbol.linalg</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../../api/symbol/op/index.html">symbol.op</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../../api/symbol/random/index.html">symbol.random</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../../api/symbol/register/index.html">symbol.register</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../../api/symbol/sparse/index.html">symbol.sparse</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l2"><a class="reference internal" href="../../../api/module/index.html">mxnet.module</a></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/autograd/index.html">contrib.autograd</a></li> |
| <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/mxnet/index.html">mxnet</a><ul> |
| <li class="toctree-l3"><a class="reference internal" href="../../../api/mxnet/attribute/index.html">mxnet.attribute</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../../api/mxnet/base/index.html">mxnet.base</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../../api/mxnet/callback/index.html">mxnet.callback</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../../api/mxnet/context/index.html">mxnet.context</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../../api/mxnet/engine/index.html">mxnet.engine</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../../api/mxnet/executor/index.html">mxnet.executor</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../../api/mxnet/executor_manager/index.html">mxnet.executor_manager</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../../api/mxnet/image/index.html">mxnet.image</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../../api/mxnet/io/index.html">mxnet.io</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../../api/mxnet/kvstore_server/index.html">mxnet.kvstore_server</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../../api/mxnet/libinfo/index.html">mxnet.libinfo</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../../api/mxnet/log/index.html">mxnet.log</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../../api/mxnet/model/index.html">mxnet.model</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../../api/mxnet/monitor/index.html">mxnet.monitor</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../../api/mxnet/name/index.html">mxnet.name</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../../api/mxnet/notebook/index.html">mxnet.notebook</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../../api/mxnet/operator/index.html">mxnet.operator</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../../api/mxnet/profiler/index.html">mxnet.profiler</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../../api/mxnet/random/index.html">mxnet.random</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../../api/mxnet/recordio/index.html">mxnet.recordio</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../../api/mxnet/registry/index.html">mxnet.registry</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../../api/mxnet/rtc/index.html">mxnet.rtc</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../../api/mxnet/runtime/index.html">mxnet.runtime</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../../api/mxnet/test_utils/index.html">mxnet.test_utils</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../../api/mxnet/torch/index.html">mxnet.torch</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../../api/mxnet/util/index.html">mxnet.util</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../../api/mxnet/visualization/index.html">mxnet.visualization</a></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| |
| </nav> |
| |
| </div> |
| |
| </header> |
| |
| <div class="document"> |
| <div class="page-content" role="main"> |
| |
| <h1>Source code for mxnet.gluon.block</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"># "License"); 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"># "AS IS" 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="c1"># coding: utf-8</span> |
| <span class="c1"># pylint: disable= arguments-differ, too-many-lines, reimported</span> |
| <span class="sd">"""Base container class for all neural network models."""</span> |
| <span class="n">__all__</span> <span class="o">=</span> <span class="p">[</span><span class="s1">'Block'</span><span class="p">,</span> <span class="s1">'HybridBlock'</span><span class="p">,</span> <span class="s1">'SymbolBlock'</span><span class="p">]</span> |
| |
| <span class="kn">import</span> <span class="nn">threading</span> |
| <span class="kn">import</span> <span class="nn">copy</span> |
| <span class="kn">import</span> <span class="nn">warnings</span> |
| <span class="kn">import</span> <span class="nn">re</span> |
| <span class="kn">import</span> <span class="nn">json</span> |
| <span class="kn">from</span> <span class="nn">collections</span> <span class="kn">import</span> <span class="n">OrderedDict</span><span class="p">,</span> <span class="n">defaultdict</span> |
| <span class="kn">import</span> <span class="nn">numpy</span> <span class="k">as</span> <span class="nn">np</span> |
| |
| <span class="kn">from</span> <span class="nn">..base</span> <span class="kn">import</span> <span class="n">mx_real_t</span><span class="p">,</span> <span class="n">MXNetError</span> |
| <span class="kn">from</span> <span class="nn">..</span> <span class="kn">import</span> <span class="n">symbol</span><span class="p">,</span> <span class="n">ndarray</span><span class="p">,</span> <span class="n">initializer</span><span class="p">,</span> <span class="n">np_symbol</span> |
| <span class="kn">from</span> <span class="nn">..symbol</span> <span class="kn">import</span> <span class="n">Symbol</span><span class="p">,</span> <span class="n">load_json</span> |
| <span class="kn">from</span> <span class="nn">..ndarray</span> <span class="kn">import</span> <span class="n">NDArray</span> |
| <span class="kn">from</span> <span class="nn">..</span> <span class="kn">import</span> <span class="n">name</span> <span class="k">as</span> <span class="n">_name</span> |
| <span class="kn">from</span> <span class="nn">.parameter</span> <span class="kn">import</span> <span class="n">Parameter</span><span class="p">,</span> <span class="n">ParameterDict</span><span class="p">,</span> <span class="n">DeferredInitializationError</span> |
| <span class="kn">from</span> <span class="nn">.utils</span> <span class="kn">import</span> <span class="n">_indent</span><span class="p">,</span> <span class="n">_brief_print_list</span><span class="p">,</span> <span class="n">HookHandle</span> |
| <span class="kn">from</span> <span class="nn">.utils</span> <span class="kn">import</span> <span class="n">_check_same_symbol_type</span><span class="p">,</span> <span class="n">_check_all_np_ndarrays</span> |
| <span class="kn">from</span> <span class="nn">..</span> <span class="kn">import</span> <span class="n">numpy_extension</span> <span class="k">as</span> <span class="n">_mx_npx</span> |
| <span class="kn">from</span> <span class="nn">..</span> <span class="kn">import</span> <span class="n">numpy</span> <span class="k">as</span> <span class="n">_mx_np</span> |
| <span class="kn">from</span> <span class="nn">..</span> <span class="n">util</span> <span class="kn">import</span> <span class="nn">is_np_array</span><span class="o">,</span> <span class="nn">np_shape</span><span class="o">,</span> <span class="nn">np_array</span> |
| |
| |
| |
| <span class="k">class</span> <span class="nc">_BlockScope</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span> |
| <span class="sd">"""Scope for collecting child `Block` s."""</span> |
| <span class="n">_current</span> <span class="o">=</span> <span class="n">threading</span><span class="o">.</span><span class="n">local</span><span class="p">()</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">block</span><span class="p">):</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_block</span> <span class="o">=</span> <span class="n">block</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_counter</span> <span class="o">=</span> <span class="p">{}</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_old_scope</span> <span class="o">=</span> <span class="kc">None</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_name_scope</span> <span class="o">=</span> <span class="kc">None</span> |
| |
| <span class="nd">@staticmethod</span> |
| <span class="k">def</span> <span class="nf">create</span><span class="p">(</span><span class="n">prefix</span><span class="p">,</span> <span class="n">params</span><span class="p">,</span> <span class="n">hint</span><span class="p">):</span> |
| <span class="sd">"""Creates prefix and params for new `Block`."""</span> |
| <span class="n">current</span> <span class="o">=</span> <span class="nb">getattr</span><span class="p">(</span><span class="n">_BlockScope</span><span class="o">.</span><span class="n">_current</span><span class="p">,</span> <span class="s2">"value"</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span> |
| <span class="k">if</span> <span class="n">current</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span> |
| <span class="k">if</span> <span class="n">prefix</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span> |
| <span class="k">if</span> <span class="ow">not</span> <span class="nb">hasattr</span><span class="p">(</span><span class="n">_name</span><span class="o">.</span><span class="n">NameManager</span><span class="o">.</span><span class="n">_current</span><span class="p">,</span> <span class="s2">"value"</span><span class="p">):</span> |
| <span class="n">_name</span><span class="o">.</span><span class="n">NameManager</span><span class="o">.</span><span class="n">_current</span><span class="o">.</span><span class="n">value</span> <span class="o">=</span> <span class="n">_name</span><span class="o">.</span><span class="n">NameManager</span><span class="p">()</span> |
| <span class="n">prefix</span> <span class="o">=</span> <span class="n">_name</span><span class="o">.</span><span class="n">NameManager</span><span class="o">.</span><span class="n">_current</span><span class="o">.</span><span class="n">value</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="kc">None</span><span class="p">,</span> <span class="n">hint</span><span class="p">)</span> <span class="o">+</span> <span class="s1">'_'</span> |
| <span class="k">if</span> <span class="n">params</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span> |
| <span class="n">params</span> <span class="o">=</span> <span class="n">ParameterDict</span><span class="p">(</span><span class="n">prefix</span><span class="p">)</span> |
| <span class="k">else</span><span class="p">:</span> |
| <span class="n">params</span> <span class="o">=</span> <span class="n">ParameterDict</span><span class="p">(</span><span class="n">params</span><span class="o">.</span><span class="n">prefix</span><span class="p">,</span> <span class="n">params</span><span class="p">)</span> |
| <span class="k">return</span> <span class="n">prefix</span><span class="p">,</span> <span class="n">params</span> |
| |
| <span class="k">if</span> <span class="n">prefix</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span> |
| <span class="n">count</span> <span class="o">=</span> <span class="n">current</span><span class="o">.</span><span class="n">_counter</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">hint</span><span class="p">,</span> <span class="mi">0</span><span class="p">)</span> |
| <span class="n">prefix</span> <span class="o">=</span> <span class="s1">'</span><span class="si">%s%d</span><span class="s1">_'</span><span class="o">%</span><span class="p">(</span><span class="n">hint</span><span class="p">,</span> <span class="n">count</span><span class="p">)</span> |
| <span class="n">current</span><span class="o">.</span><span class="n">_counter</span><span class="p">[</span><span class="n">hint</span><span class="p">]</span> <span class="o">=</span> <span class="n">count</span> <span class="o">+</span> <span class="mi">1</span> |
| <span class="k">if</span> <span class="n">params</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span> |
| <span class="n">parent</span> <span class="o">=</span> <span class="n">current</span><span class="o">.</span><span class="n">_block</span><span class="o">.</span><span class="n">params</span> |
| <span class="n">params</span> <span class="o">=</span> <span class="n">ParameterDict</span><span class="p">(</span><span class="n">parent</span><span class="o">.</span><span class="n">prefix</span><span class="o">+</span><span class="n">prefix</span><span class="p">,</span> <span class="n">parent</span><span class="o">.</span><span class="n">_shared</span><span class="p">)</span> |
| <span class="k">else</span><span class="p">:</span> |
| <span class="n">params</span> <span class="o">=</span> <span class="n">ParameterDict</span><span class="p">(</span><span class="n">params</span><span class="o">.</span><span class="n">prefix</span><span class="p">,</span> <span class="n">params</span><span class="p">)</span> |
| <span class="k">return</span> <span class="n">current</span><span class="o">.</span><span class="n">_block</span><span class="o">.</span><span class="n">prefix</span><span class="o">+</span><span class="n">prefix</span><span class="p">,</span> <span class="n">params</span> |
| |
| <span class="k">def</span> <span class="fm">__enter__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_block</span><span class="o">.</span><span class="n">_empty_prefix</span><span class="p">:</span> |
| <span class="k">return</span> <span class="bp">self</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_old_scope</span> <span class="o">=</span> <span class="nb">getattr</span><span class="p">(</span><span class="n">_BlockScope</span><span class="o">.</span><span class="n">_current</span><span class="p">,</span> <span class="s2">"value"</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span> |
| <span class="n">_BlockScope</span><span class="o">.</span><span class="n">_current</span><span class="o">.</span><span class="n">value</span> <span class="o">=</span> <span class="bp">self</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_name_scope</span> <span class="o">=</span> <span class="n">_name</span><span class="o">.</span><span class="n">Prefix</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_block</span><span class="o">.</span><span class="n">prefix</span><span class="p">)</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_name_scope</span><span class="o">.</span><span class="fm">__enter__</span><span class="p">()</span> |
| <span class="k">return</span> <span class="bp">self</span> |
| |
| <span class="k">def</span> <span class="fm">__exit__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">ptype</span><span class="p">,</span> <span class="n">value</span><span class="p">,</span> <span class="n">trace</span><span class="p">):</span> |
| <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_block</span><span class="o">.</span><span class="n">_empty_prefix</span><span class="p">:</span> |
| <span class="k">return</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_name_scope</span><span class="o">.</span><span class="fm">__exit__</span><span class="p">(</span><span class="n">ptype</span><span class="p">,</span> <span class="n">value</span><span class="p">,</span> <span class="n">trace</span><span class="p">)</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_name_scope</span> <span class="o">=</span> <span class="kc">None</span> |
| <span class="n">_BlockScope</span><span class="o">.</span><span class="n">_current</span><span class="o">.</span><span class="n">value</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_old_scope</span> |
| |
| |
| <span class="k">def</span> <span class="nf">_gather_type_ctx_info</span><span class="p">(</span><span class="n">args</span><span class="p">):</span> |
| <span class="sd">"""Analyze the elements inside the nested args object and find:</span> |
| <span class="sd"> - If there exists ndarray</span> |
| <span class="sd"> - If there exists symbol</span> |
| <span class="sd"> - All contexts appearing in args</span> |
| |
| <span class="sd"> Parameters</span> |
| <span class="sd"> ----------</span> |
| <span class="sd"> args : list or NDArray or Symbol</span> |
| <span class="sd"> Could be a nested architecture.</span> |
| |
| <span class="sd"> Returns</span> |
| <span class="sd"> -------</span> |
| <span class="sd"> has_symbol : bool</span> |
| <span class="sd"> Whether the elements in args contains symbols</span> |
| <span class="sd"> has_ndarray : bool</span> |
| <span class="sd"> Whether the elements in args contains ndarrays</span> |
| <span class="sd"> ctx_set : set of mxnet.context.Context</span> |
| <span class="sd"> Contains all possible contexts of the inner ndarrays in args. Can be empty if there is no</span> |
| <span class="sd"> ndarray inside args.</span> |
| <span class="sd"> first_ctx : mxnet.context.Context or None</span> |
| <span class="sd"> Context of the first appeared NDArray (for backward-compatibility)</span> |
| <span class="sd"> """</span> |
| <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">args</span><span class="p">,</span> <span class="n">NDArray</span><span class="p">):</span> |
| <span class="k">return</span> <span class="kc">False</span><span class="p">,</span> <span class="kc">True</span><span class="p">,</span> <span class="p">{</span><span class="n">args</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">ctx</span> |
| <span class="k">elif</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">args</span><span class="p">,</span> <span class="n">Symbol</span><span class="p">):</span> |
| <span class="k">return</span> <span class="kc">True</span><span class="p">,</span> <span class="kc">False</span><span class="p">,</span> <span class="nb">set</span><span class="p">(),</span> <span class="kc">None</span> |
| <span class="k">elif</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">args</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">has_symbol</span> <span class="o">=</span> <span class="kc">False</span> |
| <span class="n">has_ndarray</span> <span class="o">=</span> <span class="kc">False</span> |
| <span class="n">ctx_set</span> <span class="o">=</span> <span class="nb">set</span><span class="p">()</span> |
| <span class="n">first_ctx</span> <span class="o">=</span> <span class="kc">None</span> |
| <span class="k">for</span> <span class="n">ele</span> <span class="ow">in</span> <span class="n">args</span><span class="p">:</span> |
| <span class="n">ele_has_sym</span><span class="p">,</span> <span class="n">ele_has_nd</span><span class="p">,</span> <span class="n">ele_ctx_set</span><span class="p">,</span> <span class="n">ele_first_ctx</span> <span class="o">=</span>\ |
| <span class="n">_gather_type_ctx_info</span><span class="p">(</span><span class="n">ele</span><span class="p">)</span> |
| <span class="n">has_symbol</span> <span class="o">=</span> <span class="n">has_symbol</span> <span class="ow">or</span> <span class="n">ele_has_sym</span> |
| <span class="n">has_ndarray</span> <span class="o">=</span> <span class="n">has_ndarray</span> <span class="ow">or</span> <span class="n">ele_has_nd</span> |
| <span class="k">if</span> <span class="n">first_ctx</span> <span class="ow">is</span> <span class="kc">None</span> <span class="ow">and</span> <span class="n">ele_first_ctx</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span> |
| <span class="n">first_ctx</span> <span class="o">=</span> <span class="n">ele_first_ctx</span> |
| <span class="n">ctx_set</span> <span class="o">=</span> <span class="n">ctx_set</span> <span class="o">|</span> <span class="n">ele_ctx_set</span> |
| <span class="k">if</span> <span class="n">has_symbol</span> <span class="ow">and</span> <span class="n">has_ndarray</span><span class="p">:</span> |
| <span class="k">break</span> |
| <span class="k">return</span> <span class="n">has_symbol</span><span class="p">,</span> <span class="n">has_ndarray</span><span class="p">,</span> <span class="n">ctx_set</span><span class="p">,</span> <span class="n">first_ctx</span> |
| <span class="k">else</span><span class="p">:</span> |
| <span class="k">return</span> <span class="kc">False</span><span class="p">,</span> <span class="kc">False</span><span class="p">,</span> <span class="nb">set</span><span class="p">(),</span> <span class="kc">None</span> |
| |
| |
| <span class="k">def</span> <span class="nf">_flatten</span><span class="p">(</span><span class="n">args</span><span class="p">,</span> <span class="n">inout_str</span><span class="p">):</span> |
| <span class="sd">"""Parse the arguments into a flattened list + an additional format array.</span> |
| <span class="sd"> The format array stores the structure of the original arguments to help reconstruct the inputs.</span> |
| |
| <span class="sd"> Parameters</span> |
| <span class="sd"> ----------</span> |
| <span class="sd"> args : NDArray, Symbol, or (nested) list of Symbol or NDArray</span> |
| <span class="sd"> We allow None inside the args.</span> |
| <span class="sd"> inout_str : str</span> |
| <span class="sd"> The name of the HybridBlock</span> |
| |
| <span class="sd"> Returns</span> |
| <span class="sd"> -------</span> |
| <span class="sd"> flat : list of Symbol or NDArray</span> |
| <span class="sd"> The flatten version of the input args.</span> |
| <span class="sd"> fmts : (nested) list of ints</span> |
| <span class="sd"> Stores the format information of the original structured args.</span> |
| <span class="sd"> """</span> |
| <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">args</span><span class="p">,</span> <span class="n">NDArray</span><span class="p">):</span> |
| <span class="k">return</span> <span class="p">[</span><span class="n">args</span><span class="p">],</span> <span class="nb">int</span><span class="p">(</span><span class="mi">0</span><span class="p">)</span> |
| <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">args</span><span class="p">,</span> <span class="n">Symbol</span><span class="p">):</span> |
| <span class="n">length</span> <span class="o">=</span> <span class="nb">len</span><span class="p">(</span><span class="n">args</span><span class="o">.</span><span class="n">list_outputs</span><span class="p">())</span> |
| <span class="n">length</span> <span class="o">=</span> <span class="n">length</span> <span class="k">if</span> <span class="n">length</span> <span class="o">></span> <span class="mi">1</span> <span class="k">else</span> <span class="mi">0</span> |
| <span class="k">return</span> <span class="p">[</span><span class="n">args</span><span class="p">],</span> <span class="nb">int</span><span class="p">(</span><span class="n">length</span><span class="p">)</span> |
| <span class="k">if</span> <span class="n">args</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span> |
| <span class="k">return</span> <span class="p">[</span><span class="kc">None</span><span class="p">],</span> <span class="nb">int</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="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">args</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="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s2">"When hybridized, the input of HybridBlock </span><span class="si">{}</span><span class="s2">"</span> |
| <span class="s2">" must be (nested) list of Symbol"</span> |
| <span class="s2">" or NDArray, "</span> |
| <span class="s2">"but got </span><span class="si">{}</span><span class="s2"> of type </span><span class="si">{}</span><span class="s2">"</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">inout_str</span><span class="p">,</span> <span class="nb">str</span><span class="p">(</span><span class="n">args</span><span class="p">),</span> <span class="nb">str</span><span class="p">(</span><span class="nb">type</span><span class="p">(</span><span class="n">args</span><span class="p">))))</span> |
| <span class="n">flat</span> <span class="o">=</span> <span class="p">[]</span> |
| <span class="n">fmts</span> <span class="o">=</span> <span class="p">[]</span> |
| <span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="n">args</span><span class="p">:</span> |
| <span class="n">arg</span><span class="p">,</span> <span class="n">fmt</span> <span class="o">=</span> <span class="n">_flatten</span><span class="p">(</span><span class="n">i</span><span class="p">,</span> <span class="n">inout_str</span><span class="p">)</span> |
| <span class="n">flat</span><span class="o">.</span><span class="n">extend</span><span class="p">(</span><span class="n">arg</span><span class="p">)</span> |
| <span class="n">fmts</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">fmt</span><span class="p">)</span> |
| <span class="k">return</span> <span class="n">flat</span><span class="p">,</span> <span class="n">fmts</span> |
| |
| |
| <span class="k">def</span> <span class="nf">_regroup</span><span class="p">(</span><span class="n">args</span><span class="p">,</span> <span class="n">fmt</span><span class="p">):</span> |
| <span class="sd">"""Reconstruct the structured arguments based on the flattened version.</span> |
| |
| <span class="sd"> Parameters</span> |
| <span class="sd"> ----------</span> |
| <span class="sd"> args : NDArray, Symbol, or (nested) list of Symbol or NDArray</span> |
| <span class="sd"> We allow None inside the args.</span> |
| <span class="sd"> fmt : (nested) list of ints</span> |
| <span class="sd"> Stores the format information of the original structured args.</span> |
| |
| <span class="sd"> Returns</span> |
| <span class="sd"> -------</span> |
| <span class="sd"> ret : NDArray, Symbol, or (nested) list of Symbol or NDArray</span> |
| |
| <span class="sd"> """</span> |
| <span class="k">def</span> <span class="nf">_merger</span><span class="p">(</span><span class="n">args</span><span class="p">,</span> <span class="n">fmt</span><span class="p">):</span> |
| <span class="sd">"""Recursive call to merge the arguments"""</span> |
| <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">fmt</span><span class="p">,</span> <span class="nb">int</span><span class="p">):</span> |
| <span class="k">if</span> <span class="n">fmt</span> <span class="o"><</span> <span class="o">-</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">"Unsupported encoded format </span><span class="si">{}</span><span class="s2">."</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">fmt</span><span class="p">))</span> |
| <span class="k">if</span> <span class="n">fmt</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span> |
| <span class="k">return</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="k">if</span> <span class="n">fmt</span> <span class="o">==</span> <span class="o">-</span><span class="mi">1</span><span class="p">:</span> |
| <span class="k">if</span> <span class="n">args</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span> |
| <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s1">'We do not support passing types that are not None'</span> |
| <span class="s1">' when the initial HybridBlock has received NoneType and'</span> |
| <span class="s1">' has been hybridized.'</span> |
| <span class="s1">' Received arg = </span><span class="si">{}</span><span class="s1">, fmt = </span><span class="si">{}</span><span class="s1">.'</span><span class="o">.</span><span class="n">format</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">fmt</span><span class="p">))</span> |
| <span class="k">return</span> <span class="kc">None</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="k">else</span><span class="p">:</span> |
| <span class="k">return</span> <span class="n">args</span><span class="p">[:</span><span class="n">fmt</span><span class="p">],</span> <span class="n">args</span><span class="p">[</span><span class="n">fmt</span><span class="p">:]</span> |
| |
| <span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">args</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="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s2">"When hybridized, the output of HybridBlock must be (nested)"</span> |
| <span class="s2">" list of Symbol or NDArray, "</span> |
| <span class="s2">"but got </span><span class="si">{}</span><span class="s2"> of type </span><span class="si">{}</span><span class="s2">"</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">args</span><span class="p">,</span> <span class="nb">type</span><span class="p">(</span><span class="n">args</span><span class="p">)))</span> |
| <span class="n">ret</span> <span class="o">=</span> <span class="p">[]</span> |
| <span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="n">fmt</span><span class="p">:</span> |
| <span class="n">res</span><span class="p">,</span> <span class="n">args</span> <span class="o">=</span> <span class="n">_merger</span><span class="p">(</span><span class="n">args</span><span class="p">,</span> <span class="n">i</span><span class="p">)</span> |
| <span class="n">ret</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">res</span><span class="p">)</span> |
| <span class="k">return</span> <span class="n">ret</span><span class="p">,</span> <span class="n">args</span> |
| <span class="k">return</span> <span class="n">_merger</span><span class="p">(</span><span class="n">args</span><span class="p">,</span> <span class="n">fmt</span><span class="p">)[</span><span class="mi">0</span><span class="p">]</span> |
| |
| |
| <div class="viewcode-block" id="Block"><a class="viewcode-back" href="../../../api/gluon/block.html#mxnet.gluon.Block">[docs]</a><span class="k">class</span> <span class="nc">Block</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span> |
| <span class="sd">"""Base class for all neural network layers and models. Your models should</span> |
| <span class="sd"> subclass this class.</span> |
| |
| <span class="sd"> :py:class:`Block` can be nested recursively in a tree structure. You can create and</span> |
| <span class="sd"> assign child :py:class:`Block` as regular attributes::</span> |
| |
| <span class="sd"> from mxnet.gluon import Block, nn</span> |
| <span class="sd"> from mxnet import ndarray as F</span> |
| |
| <span class="sd"> class Model(Block):</span> |
| <span class="sd"> def __init__(self, **kwargs):</span> |
| <span class="sd"> super(Model, self).__init__(**kwargs)</span> |
| <span class="sd"> # use name_scope to give child Blocks appropriate names.</span> |
| <span class="sd"> with self.name_scope():</span> |
| <span class="sd"> self.dense0 = nn.Dense(20)</span> |
| <span class="sd"> self.dense1 = nn.Dense(20)</span> |
| |
| <span class="sd"> def forward(self, x):</span> |
| <span class="sd"> x = F.relu(self.dense0(x))</span> |
| <span class="sd"> return F.relu(self.dense1(x))</span> |
| |
| <span class="sd"> model = Model()</span> |
| <span class="sd"> model.initialize(ctx=mx.cpu(0))</span> |
| <span class="sd"> model(F.zeros((10, 10), ctx=mx.cpu(0)))</span> |
| |
| |
| <span class="sd"> Child :py:class:`Block` assigned this way will be registered and :py:meth:`collect_params`</span> |
| <span class="sd"> will collect their Parameters recursively. You can also manually register</span> |
| <span class="sd"> child blocks with :py:meth:`register_child`.</span> |
| |
| <span class="sd"> Parameters</span> |
| <span class="sd"> ----------</span> |
| <span class="sd"> prefix : str</span> |
| <span class="sd"> Prefix acts like a name space. All children blocks created in parent block's</span> |
| <span class="sd"> :py:meth:`name_scope` will have parent block's prefix in their name.</span> |
| <span class="sd"> Please refer to</span> |
| <span class="sd"> `naming tutorial </api/python/docs/tutorials/packages/gluon/blocks/naming.html>`_</span> |
| <span class="sd"> for more info on prefix and naming.</span> |
| <span class="sd"> params : ParameterDict or None</span> |
| <span class="sd"> :py:class:`ParameterDict` for sharing weights with the new :py:class:`Block`. For example,</span> |
| <span class="sd"> if you want ``dense1`` to share ``dense0``'s weights, you can do::</span> |
| |
| <span class="sd"> dense0 = nn.Dense(20)</span> |
| <span class="sd"> dense1 = nn.Dense(20, params=dense0.collect_params())</span> |
| <span class="sd"> """</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">prefix</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">params</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_empty_prefix</span> <span class="o">=</span> <span class="n">prefix</span> <span class="o">==</span> <span class="s1">''</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_prefix</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_params</span> <span class="o">=</span> <span class="n">_BlockScope</span><span class="o">.</span><span class="n">create</span><span class="p">(</span><span class="n">prefix</span><span class="p">,</span> <span class="n">params</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_alias</span><span class="p">())</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_name</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_prefix</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="bp">self</span><span class="o">.</span><span class="n">_prefix</span><span class="o">.</span><span class="n">endswith</span><span class="p">(</span><span class="s1">'_'</span><span class="p">)</span> <span class="k">else</span> <span class="bp">self</span><span class="o">.</span><span class="n">_prefix</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_scope</span> <span class="o">=</span> <span class="n">_BlockScope</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_children</span> <span class="o">=</span> <span class="n">OrderedDict</span><span class="p">()</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_reg_params</span> <span class="o">=</span> <span class="p">{}</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_forward_hooks</span> <span class="o">=</span> <span class="n">OrderedDict</span><span class="p">()</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_forward_pre_hooks</span> <span class="o">=</span> <span class="n">OrderedDict</span><span class="p">()</span> |
| |
| <span class="k">def</span> <span class="fm">__repr__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="n">s</span> <span class="o">=</span> <span class="s1">'</span><span class="si">{name}</span><span class="s1">(</span><span class="se">\n</span><span class="si">{modstr}</span><span class="se">\n</span><span class="s1">)'</span> |
| <span class="n">modstr</span> <span class="o">=</span> <span class="s1">'</span><span class="se">\n</span><span class="s1">'</span><span class="o">.</span><span class="n">join</span><span class="p">([</span><span class="s1">' (</span><span class="si">{key}</span><span class="s1">): </span><span class="si">{block}</span><span class="s1">'</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">key</span><span class="o">=</span><span class="n">key</span><span class="p">,</span> |
| <span class="n">block</span><span class="o">=</span><span class="n">_indent</span><span class="p">(</span><span class="n">block</span><span class="o">.</span><span class="fm">__repr__</span><span class="p">(),</span> <span class="mi">2</span><span class="p">))</span> |
| <span class="k">for</span> <span class="n">key</span><span class="p">,</span> <span class="n">block</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="vm">__dict__</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">block</span><span class="p">,</span> <span class="n">Block</span><span class="p">)])</span> |
| <span class="k">return</span> <span class="n">s</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="vm">__class__</span><span class="o">.</span><span class="vm">__name__</span><span class="p">,</span> <span class="n">modstr</span><span class="o">=</span><span class="n">modstr</span><span class="p">)</span> |
| |
| <span class="k">def</span> <span class="fm">__setattr__</span><span class="p">(</span><span class="bp">self</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="sd">"""Registers parameters."""</span> |
| |
| <span class="k">if</span> <span class="nb">hasattr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">):</span> |
| <span class="n">existing</span> <span class="o">=</span> <span class="nb">getattr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">)</span> |
| <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">existing</span><span class="p">,</span> <span class="p">(</span><span class="n">Parameter</span><span class="p">,</span> <span class="n">Block</span><span class="p">))</span> <span class="ow">and</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="nb">type</span><span class="p">(</span><span class="n">existing</span><span class="p">)):</span> |
| <span class="k">raise</span> <span class="ne">TypeError</span><span class="p">(</span><span class="s1">'Changing attribute type for </span><span class="si">{name}</span><span class="s1"> from </span><span class="si">{type1}</span><span class="s1"> to </span><span class="si">{type2}</span><span class="s1">'</span> \ |
| <span class="s1">'is not allowed.'</span><span class="o">.</span><span class="n">format</span><span class="p">(</span> |
| <span class="n">name</span><span class="o">=</span><span class="n">name</span><span class="p">,</span> <span class="n">type1</span><span class="o">=</span><span class="nb">type</span><span class="p">(</span><span class="n">existing</span><span class="p">),</span> <span class="n">type2</span><span class="o">=</span><span class="nb">type</span><span class="p">(</span><span class="n">value</span><span class="p">)))</span> |
| |
| <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="n">Block</span><span class="p">):</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">register_child</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="n">name</span><span class="p">)</span> |
| <span class="k">elif</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="n">Parameter</span><span class="p">):</span> |
| <span class="k">assert</span> <span class="n">name</span> <span class="ow">not</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_reg_params</span><span class="p">,</span> \ |
| <span class="s2">"Overriding Parameter attribute </span><span class="si">%s</span><span class="s2"> is not allowed. "</span> \ |
| <span class="s2">"If you want to share parameters between blocks, please set "</span> \ |
| <span class="s2">"'params' at Block construction instead."</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_reg_params</span><span class="p">[</span><span class="n">name</span><span class="p">]</span> <span class="o">=</span> <span class="n">value</span> |
| |
| <span class="nb">super</span><span class="p">(</span><span class="n">Block</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="fm">__setattr__</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="k">def</span> <span class="nf">_check_container_with_block</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="n">children</span> <span class="o">=</span> <span class="nb">set</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_children</span><span class="o">.</span><span class="n">values</span><span class="p">())</span> |
| <span class="k">def</span> <span class="nf">_find_unregistered_block_in_container</span><span class="p">(</span><span class="n">data</span><span class="p">):</span> |
| <span class="c1"># Find whether a nested container structure contains Blocks</span> |
| <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">data</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="k">for</span> <span class="n">ele</span> <span class="ow">in</span> <span class="n">data</span><span class="p">:</span> |
| <span class="k">if</span> <span class="n">_find_unregistered_block_in_container</span><span class="p">(</span><span class="n">ele</span><span class="p">):</span> |
| <span class="k">return</span> <span class="kc">True</span> |
| <span class="k">return</span> <span class="kc">False</span> |
| <span class="k">elif</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">data</span><span class="p">,</span> <span class="nb">dict</span><span class="p">):</span> |
| <span class="k">for</span> <span class="n">_</span><span class="p">,</span> <span class="n">v</span> <span class="ow">in</span> <span class="n">data</span><span class="o">.</span><span class="n">items</span><span class="p">():</span> |
| <span class="k">if</span> <span class="n">_find_unregistered_block_in_container</span><span class="p">(</span><span class="n">v</span><span class="p">):</span> |
| <span class="k">return</span> <span class="kc">True</span> |
| <span class="k">return</span> <span class="kc">False</span> |
| <span class="k">elif</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">data</span><span class="p">,</span> <span class="n">Block</span><span class="p">):</span> |
| <span class="k">return</span> <span class="ow">not</span> <span class="n">data</span> <span class="ow">in</span> <span class="n">children</span> |
| <span class="k">else</span><span class="p">:</span> |
| <span class="k">return</span> <span class="kc">False</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="bp">self</span><span class="o">.</span><span class="vm">__dict__</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="p">(</span><span class="nb">list</span><span class="p">,</span> <span class="nb">tuple</span><span class="p">,</span> <span class="nb">dict</span><span class="p">))</span> <span class="ow">and</span> <span class="ow">not</span> <span class="p">(</span><span class="n">k</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="s1">'__'</span><span class="p">)</span> <span class="ow">or</span> <span class="n">k</span> <span class="o">==</span> <span class="s1">'_children'</span><span class="p">):</span> |
| <span class="k">if</span> <span class="n">_find_unregistered_block_in_container</span><span class="p">(</span><span class="n">v</span><span class="p">):</span> |
| <span class="n">warnings</span><span class="o">.</span><span class="n">warn</span><span class="p">(</span><span class="s1">'"</span><span class="si">{name}</span><span class="s1">" is an unregistered container with Blocks. '</span> |
| <span class="s1">'Note that Blocks inside the list, tuple or dict will not be '</span> |
| <span class="s1">'registered automatically. Make sure to register them using '</span> |
| <span class="s1">'register_child() or switching to '</span> |
| <span class="s1">'nn.Sequential/nn.HybridSequential instead. '</span> |
| <span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="vm">__class__</span><span class="o">.</span><span class="vm">__name__</span> <span class="o">+</span> <span class="s2">"."</span> <span class="o">+</span> <span class="n">k</span><span class="p">),</span> <span class="n">stacklevel</span><span class="o">=</span><span class="mi">3</span><span class="p">)</span> |
| |
| <span class="k">def</span> <span class="nf">_alias</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="vm">__class__</span><span class="o">.</span><span class="vm">__name__</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span> |
| |
| <span class="nd">@property</span> |
| <span class="k">def</span> <span class="nf">prefix</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="sd">"""Prefix of this :py:class:`Block`."""</span> |
| <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_prefix</span> |
| |
| <span class="nd">@property</span> |
| <span class="k">def</span> <span class="nf">name</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="sd">"""Name of this :py:class:`Block`, without '_' in the end."""</span> |
| <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_name</span> |
| |
| <div class="viewcode-block" id="Block.name_scope"><a class="viewcode-back" href="../../../api/gluon/block.html#mxnet.gluon.Block.name_scope">[docs]</a> <span class="k">def</span> <span class="nf">name_scope</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="sd">"""Returns a name space object managing a child :py:class:`Block` and parameter</span> |
| <span class="sd"> names. Should be used within a ``with`` statement::</span> |
| |
| <span class="sd"> with self.name_scope():</span> |
| <span class="sd"> self.dense = nn.Dense(20)</span> |
| |
| <span class="sd"> Please refer to</span> |
| <span class="sd"> `the naming tutorial </api/python/docs/tutorials/packages/gluon/blocks/naming.html>`_</span> |
| <span class="sd"> for more info on prefix and naming.</span> |
| <span class="sd"> """</span> |
| <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_scope</span></div> |
| |
| <span class="nd">@property</span> |
| <span class="k">def</span> <span class="nf">params</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="sd">"""Returns this :py:class:`Block`'s parameter dictionary (does not include its</span> |
| <span class="sd"> children's parameters)."""</span> |
| <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_params</span> |
| |
| <div class="viewcode-block" id="Block.collect_params"><a class="viewcode-back" href="../../../api/gluon/block.html#mxnet.gluon.Block.collect_params">[docs]</a> <span class="k">def</span> <span class="nf">collect_params</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">select</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span> |
| <span class="sd">"""Returns a :py:class:`ParameterDict` containing this :py:class:`Block` and all of its</span> |
| <span class="sd"> children's Parameters(default), also can returns the select :py:class:`ParameterDict`</span> |
| <span class="sd"> which match some given regular expressions.</span> |
| |
| <span class="sd"> For example, collect the specified parameters in ['conv1_weight', 'conv1_bias', 'fc_weight',</span> |
| <span class="sd"> 'fc_bias']::</span> |
| |
| <span class="sd"> model.collect_params('conv1_weight|conv1_bias|fc_weight|fc_bias')</span> |
| |
| <span class="sd"> or collect all parameters whose names end with 'weight' or 'bias', this can be done</span> |
| <span class="sd"> using regular expressions::</span> |
| |
| <span class="sd"> model.collect_params('.*weight|.*bias')</span> |
| |
| <span class="sd"> Parameters</span> |
| <span class="sd"> ----------</span> |
| <span class="sd"> select : str</span> |
| <span class="sd"> regular expressions</span> |
| |
| <span class="sd"> Returns</span> |
| <span class="sd"> -------</span> |
| <span class="sd"> The selected :py:class:`ParameterDict`</span> |
| <span class="sd"> """</span> |
| <span class="c1"># We need to check here because blocks inside containers are not supported.</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_check_container_with_block</span><span class="p">()</span> |
| <span class="n">ret</span> <span class="o">=</span> <span class="n">ParameterDict</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_params</span><span class="o">.</span><span class="n">prefix</span><span class="p">)</span> |
| <span class="k">if</span> <span class="ow">not</span> <span class="n">select</span><span class="p">:</span> |
| <span class="n">ret</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">params</span><span class="p">)</span> |
| <span class="k">else</span><span class="p">:</span> |
| <span class="n">pattern</span> <span class="o">=</span> <span class="n">re</span><span class="o">.</span><span class="n">compile</span><span class="p">(</span><span class="n">select</span><span class="p">)</span> |
| <span class="n">ret</span><span class="o">.</span><span class="n">update</span><span class="p">({</span><span class="n">name</span><span class="p">:</span><span class="n">value</span> <span class="k">for</span> <span class="n">name</span><span class="p">,</span> <span class="n">value</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">params</span><span class="o">.</span><span class="n">items</span><span class="p">()</span> <span class="k">if</span> <span class="n">pattern</span><span class="o">.</span><span class="n">match</span><span class="p">(</span><span class="n">name</span><span class="p">)})</span> |
| <span class="k">for</span> <span class="n">cld</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_children</span><span class="o">.</span><span class="n">values</span><span class="p">():</span> |
| <span class="n">ret</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="n">cld</span><span class="o">.</span><span class="n">collect_params</span><span class="p">(</span><span class="n">select</span><span class="o">=</span><span class="n">select</span><span class="p">))</span> |
| <span class="k">return</span> <span class="n">ret</span></div> |
| |
| <span class="k">def</span> <span class="nf">_collect_params_with_prefix</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">prefix</span><span class="o">=</span><span class="s1">''</span><span class="p">):</span> |
| <span class="k">if</span> <span class="n">prefix</span><span class="p">:</span> |
| <span class="n">prefix</span> <span class="o">+=</span> <span class="s1">'.'</span> |
| <span class="n">ret</span> <span class="o">=</span> <span class="p">{</span><span class="n">prefix</span> <span class="o">+</span> <span class="n">key</span> <span class="p">:</span> <span class="n">val</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="bp">self</span><span class="o">.</span><span class="n">_reg_params</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">child</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_children</span><span class="o">.</span><span class="n">items</span><span class="p">():</span> |
| <span class="n">ret</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="n">child</span><span class="o">.</span><span class="n">_collect_params_with_prefix</span><span class="p">(</span><span class="n">prefix</span> <span class="o">+</span> <span class="n">name</span><span class="p">))</span> |
| <span class="k">return</span> <span class="n">ret</span> |
| |
| <div class="viewcode-block" id="Block.save_parameters"><a class="viewcode-back" href="../../../api/gluon/block.html#mxnet.gluon.Block.save_parameters">[docs]</a> <span class="k">def</span> <span class="nf">save_parameters</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">filename</span><span class="p">,</span> <span class="n">deduplicate</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span> |
| <span class="sd">"""Save parameters to file.</span> |
| |
| <span class="sd"> Saved parameters can only be loaded with `load_parameters`. Note that this</span> |
| <span class="sd"> method only saves parameters, not model structure. If you want to save</span> |
| <span class="sd"> model structures, please use :py:meth:`HybridBlock.export`.</span> |
| |
| <span class="sd"> Parameters</span> |
| <span class="sd"> ----------</span> |
| <span class="sd"> filename : str</span> |
| <span class="sd"> Path to file.</span> |
| <span class="sd"> deduplicate : bool, default False</span> |
| <span class="sd"> If True, save shared parameters only once. Otherwise, if a Block</span> |
| <span class="sd"> contains multiple sub-blocks that share parameters, each of the</span> |
| <span class="sd"> shared parameters will be separately saved for every sub-block.</span> |
| |
| <span class="sd"> References</span> |
| <span class="sd"> ----------</span> |
| <span class="sd"> `Saving and Loading Gluon Models \</span> |
| <span class="sd"> <https://mxnet.apache.org/api/python/docs/tutorials/packages/gluon/blocks/save_load_params.html>`_</span> |
| <span class="sd"> """</span> |
| <span class="n">params</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_collect_params_with_prefix</span><span class="p">()</span> |
| |
| <span class="k">if</span> <span class="n">deduplicate</span><span class="p">:</span> |
| <span class="c1"># Shared parameters are stored only a single time as of MXNet 1.6.</span> |
| <span class="c1"># Shared parameters are registered under multiple prefixes returned by</span> |
| <span class="c1"># _collect_params_with_prefix. We select a single one and only store</span> |
| <span class="c1"># it. In load_parameters it is sufficient for a shared parameter to</span> |
| <span class="c1"># only set it for a single prefix.</span> |
| <span class="n">reverse_params</span> <span class="o">=</span> <span class="p">{</span><span class="n">v</span><span class="p">:</span> <span class="n">k</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">params</span><span class="o">.</span><span class="n">items</span><span class="p">()}</span> |
| <span class="n">params</span> <span class="o">=</span> <span class="p">{</span><span class="n">v</span><span class="p">:</span> <span class="n">k</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">reverse_params</span><span class="o">.</span><span class="n">items</span><span class="p">()}</span> |
| |
| <span class="n">arg_dict</span> <span class="o">=</span> <span class="p">{</span><span class="n">key</span><span class="p">:</span> <span class="n">val</span><span class="o">.</span><span class="n">_reduce</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">params</span><span class="o">.</span><span class="n">items</span><span class="p">()}</span> |
| <span class="n">save_fn</span> <span class="o">=</span> <span class="n">_mx_npx</span><span class="o">.</span><span class="n">save</span> <span class="k">if</span> <span class="n">is_np_array</span><span class="p">()</span> <span class="k">else</span> <span class="n">ndarray</span><span class="o">.</span><span class="n">save</span> |
| <span class="n">save_fn</span><span class="p">(</span><span class="n">filename</span><span class="p">,</span> <span class="n">arg_dict</span><span class="p">)</span></div> |
| |
| <div class="viewcode-block" id="Block.save_params"><a class="viewcode-back" href="../../../api/gluon/block.html#mxnet.gluon.Block.save_params">[docs]</a> <span class="k">def</span> <span class="nf">save_params</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">filename</span><span class="p">):</span> |
| <span class="sd">"""[Deprecated] Please use save_parameters. Note that if you want load</span> |
| <span class="sd"> from SymbolBlock later, please use export instead.</span> |
| |
| <span class="sd"> Save parameters to file.</span> |
| |
| <span class="sd"> filename : str</span> |
| <span class="sd"> Path to file.</span> |
| <span class="sd"> """</span> |
| <span class="n">warnings</span><span class="o">.</span><span class="n">warn</span><span class="p">(</span><span class="s2">"save_params is deprecated. Please use save_parameters. "</span> |
| <span class="s2">"Note that if you want load from SymbolBlock later, please "</span> |
| <span class="s2">"use export instead. For details, see "</span> |
| <span class="s2">"https://mxnet.apache.org/tutorials/gluon/save_lo"</span> |
| <span class="s2">"ad_params.html"</span><span class="p">)</span> |
| <span class="k">try</span><span class="p">:</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">collect_params</span><span class="p">()</span><span class="o">.</span><span class="n">save</span><span class="p">(</span><span class="n">filename</span><span class="p">,</span> <span class="n">strip_prefix</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">prefix</span><span class="p">)</span> |
| <span class="k">except</span> <span class="ne">ValueError</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span> |
| <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s1">'</span><span class="si">%s</span><span class="se">\n</span><span class="s1">save_params is deprecated. Using '</span> \ |
| <span class="s1">'save_parameters may resolve this error.'</span><span class="o">%</span><span class="n">e</span><span class="o">.</span><span class="n">message</span><span class="p">)</span></div> |
| |
| <div class="viewcode-block" id="Block.load_parameters"><a class="viewcode-back" href="../../../api/gluon/block.html#mxnet.gluon.Block.load_parameters">[docs]</a> <span class="k">def</span> <span class="nf">load_parameters</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">filename</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">allow_missing</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> |
| <span class="n">ignore_extra</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">cast_dtype</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">dtype_source</span><span class="o">=</span><span class="s1">'current'</span><span class="p">):</span> |
| <span class="sd">"""Load parameters from file previously saved by `save_parameters`.</span> |
| |
| <span class="sd"> Parameters</span> |
| <span class="sd"> ----------</span> |
| <span class="sd"> filename : str</span> |
| <span class="sd"> Path to parameter file.</span> |
| <span class="sd"> ctx : Context or list of Context, default cpu()</span> |
| <span class="sd"> Context(s) to initialize loaded parameters on.</span> |
| <span class="sd"> allow_missing : bool, default False</span> |
| <span class="sd"> Whether to silently skip loading parameters not represents in the file.</span> |
| <span class="sd"> ignore_extra : bool, default False</span> |
| <span class="sd"> Whether to silently ignore parameters from the file that are not</span> |
| <span class="sd"> present in this Block.</span> |
| <span class="sd"> cast_dtype : bool, default False</span> |
| <span class="sd"> Cast the data type of the NDArray loaded from the checkpoint to the dtype</span> |
| <span class="sd"> provided by the Parameter if any.</span> |
| <span class="sd"> dtype_source : str, default 'current'</span> |
| <span class="sd"> must be in {'current', 'saved'}</span> |
| <span class="sd"> Only valid if cast_dtype=True, specify the source of the dtype for casting</span> |
| <span class="sd"> the parameters</span> |
| <span class="sd"> References</span> |
| <span class="sd"> ----------</span> |
| <span class="sd"> `Saving and Loading Gluon Models \</span> |
| <span class="sd"> <https://mxnet.apache.org/api/python/docs/tutorials/packages/gluon/blocks/save_load_params.html>`_</span> |
| <span class="sd"> """</span> |
| <span class="k">if</span> <span class="n">is_np_array</span><span class="p">():</span> |
| <span class="c1"># failure may happen when loading parameters saved as NDArrays within</span> |
| <span class="c1"># NumPy semantics. Check the failure type and recover from it if it happens.</span> |
| <span class="k">try</span><span class="p">:</span> |
| <span class="n">loaded</span> <span class="o">=</span> <span class="n">_mx_npx</span><span class="o">.</span><span class="n">load</span><span class="p">(</span><span class="n">filename</span><span class="p">)</span> |
| <span class="k">except</span> <span class="n">MXNetError</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span> |
| <span class="n">err_msg</span> <span class="o">=</span> <span class="nb">str</span><span class="p">(</span><span class="n">e</span><span class="p">)</span> |
| <span class="k">if</span> <span class="s1">'is_np_shape'</span> <span class="ow">in</span> <span class="n">err_msg</span><span class="p">:</span> |
| <span class="c1"># Loading failure due to parameters saved without numpy semantics.</span> |
| <span class="c1"># Temporarily disable numpy semantics and load parameters. After it's</span> |
| <span class="c1"># done, resume the numpy semantics. This is fine because the cases</span> |
| <span class="c1"># numpy ndarray covers is a superset of the legacy ndarray's.</span> |
| <span class="k">with</span> <span class="n">np_array</span><span class="p">(</span><span class="kc">False</span><span class="p">):</span> |
| <span class="k">with</span> <span class="n">np_shape</span><span class="p">(</span><span class="kc">False</span><span class="p">):</span> |
| <span class="n">loaded_nds</span> <span class="o">=</span> <span class="n">ndarray</span><span class="o">.</span><span class="n">load</span><span class="p">(</span><span class="n">filename</span><span class="p">)</span> |
| <span class="k">assert</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">loaded_nds</span><span class="p">,</span> <span class="nb">dict</span><span class="p">),</span>\ |
| <span class="s1">'expecting a dict type, got </span><span class="si">{}</span><span class="s1">'</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="nb">type</span><span class="p">(</span><span class="n">loaded_nds</span><span class="p">)))</span> |
| <span class="n">loaded</span> <span class="o">=</span> <span class="p">{</span><span class="n">k</span><span class="p">:</span> <span class="n">loaded_nds</span><span class="p">[</span><span class="n">k</span><span class="p">]</span><span class="o">.</span><span class="n">as_np_ndarray</span><span class="p">()</span> <span class="k">for</span> <span class="n">k</span> <span class="ow">in</span> <span class="n">loaded_nds</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="n">err_msg</span><span class="p">)</span> |
| <span class="k">else</span><span class="p">:</span> |
| <span class="n">loaded</span> <span class="o">=</span> <span class="n">ndarray</span><span class="o">.</span><span class="n">load</span><span class="p">(</span><span class="n">filename</span><span class="p">)</span> |
| <span class="n">params</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_collect_params_with_prefix</span><span class="p">()</span> |
| <span class="k">if</span> <span class="ow">not</span> <span class="n">loaded</span> <span class="ow">and</span> <span class="ow">not</span> <span class="n">params</span><span class="p">:</span> |
| <span class="k">return</span> |
| |
| <span class="k">if</span> <span class="ow">not</span> <span class="nb">any</span><span class="p">(</span><span class="s1">'.'</span> <span class="ow">in</span> <span class="n">i</span> <span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="n">loaded</span><span class="o">.</span><span class="n">keys</span><span class="p">()):</span> |
| <span class="c1"># legacy loading</span> |
| <span class="n">loaded</span> <span class="o">=</span> <span class="kc">None</span> <span class="c1"># This should be changed to `del loaded` when dropping Python 2</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">collect_params</span><span class="p">()</span><span class="o">.</span><span class="n">load</span><span class="p">(</span> |
| <span class="n">filename</span><span class="p">,</span> <span class="n">ctx</span><span class="p">,</span> <span class="n">allow_missing</span><span class="p">,</span> <span class="n">ignore_extra</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">prefix</span><span class="p">,</span> |
| <span class="n">cast_dtype</span><span class="o">=</span><span class="n">cast_dtype</span><span class="p">,</span> <span class="n">dtype_source</span><span class="o">=</span><span class="n">dtype_source</span><span class="p">)</span> |
| <span class="k">return</span> |
| |
| <span class="k">if</span> <span class="ow">not</span> <span class="n">allow_missing</span><span class="p">:</span> |
| <span class="c1"># Shared parameters are stored only a single time as of MXNet 1.6.</span> |
| <span class="c1"># We thus retrieve all prefixes (through _collect_params_with_prefix)</span> |
| <span class="c1"># that a shared parameter is used with. Check that there are no</span> |
| <span class="c1"># missing parameters that were not yet already loaded from the</span> |
| <span class="c1"># shared version.</span> |
| <span class="n">params_inv</span> <span class="o">=</span> <span class="n">defaultdict</span><span class="p">(</span><span class="nb">list</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">params</span><span class="o">.</span><span class="n">items</span><span class="p">():</span> |
| <span class="n">params_inv</span><span class="p">[</span><span class="n">v</span><span class="p">]</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">k</span><span class="p">)</span> |
| |
| <span class="k">for</span> <span class="n">name</span><span class="p">,</span> <span class="n">param</span> <span class="ow">in</span> <span class="n">params</span><span class="o">.</span><span class="n">items</span><span class="p">():</span> |
| <span class="k">assert</span> <span class="nb">any</span><span class="p">(</span><span class="n">p</span> <span class="ow">in</span> <span class="n">loaded</span> <span class="k">for</span> <span class="n">p</span> <span class="ow">in</span> <span class="n">params_inv</span><span class="p">[</span><span class="n">param</span><span class="p">]),</span> \ |
| <span class="s2">"Parameter '</span><span class="si">%s</span><span class="s2">' is missing in file '</span><span class="si">%s</span><span class="s2">', which contains parameters: </span><span class="si">%s</span><span class="s2">. "</span> \ |
| <span class="s2">"Set allow_missing=True to ignore missing parameters."</span><span class="o">%</span><span class="p">(</span> |
| <span class="n">name</span><span class="p">,</span> <span class="n">filename</span><span class="p">,</span> <span class="n">_brief_print_list</span><span class="p">(</span><span class="n">loaded</span><span class="o">.</span><span class="n">keys</span><span class="p">()))</span> |
| <span class="k">for</span> <span class="n">name</span> <span class="ow">in</span> <span class="n">loaded</span><span class="p">:</span> |
| <span class="k">if</span> <span class="ow">not</span> <span class="n">ignore_extra</span> <span class="ow">and</span> <span class="n">name</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">params</span><span class="p">:</span> |
| <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span> |
| <span class="s2">"Parameter '</span><span class="si">%s</span><span class="s2">' loaded from file '</span><span class="si">%s</span><span class="s2">' is not present in ParameterDict, "</span> \ |
| <span class="s2">"which contains parameters </span><span class="si">%s</span><span class="s2">. Set ignore_extra=True to ignore. "</span><span class="o">%</span><span class="p">(</span> |
| <span class="n">name</span><span class="p">,</span> <span class="n">filename</span><span class="p">,</span> <span class="n">_brief_print_list</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_params</span><span class="o">.</span><span class="n">keys</span><span class="p">())))</span> |
| <span class="k">if</span> <span class="n">name</span> <span class="ow">in</span> <span class="n">params</span><span class="p">:</span> |
| <span class="n">params</span><span class="p">[</span><span class="n">name</span><span class="p">]</span><span class="o">.</span><span class="n">_load_init</span><span class="p">(</span><span class="n">loaded</span><span class="p">[</span><span class="n">name</span><span class="p">],</span> <span class="n">ctx</span><span class="p">,</span> <span class="n">cast_dtype</span><span class="o">=</span><span class="n">cast_dtype</span><span class="p">,</span> <span class="n">dtype_source</span><span class="o">=</span><span class="n">dtype_source</span><span class="p">)</span></div> |
| |
| <div class="viewcode-block" id="Block.load_params"><a class="viewcode-back" href="../../../api/gluon/block.html#mxnet.gluon.Block.load_params">[docs]</a> <span class="k">def</span> <span class="nf">load_params</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">filename</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">allow_missing</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> |
| <span class="n">ignore_extra</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span> |
| <span class="sd">"""[Deprecated] Please use load_parameters.</span> |
| |
| <span class="sd"> Load parameters from file.</span> |
| |
| <span class="sd"> filename : str</span> |
| <span class="sd"> Path to parameter file.</span> |
| <span class="sd"> ctx : Context or list of Context, default cpu()</span> |
| <span class="sd"> Context(s) to initialize loaded parameters on.</span> |
| <span class="sd"> allow_missing : bool, default False</span> |
| <span class="sd"> Whether to silently skip loading parameters not represents in the file.</span> |
| <span class="sd"> ignore_extra : bool, default False</span> |
| <span class="sd"> Whether to silently ignore parameters from the file that are not</span> |
| <span class="sd"> present in this Block.</span> |
| <span class="sd"> """</span> |
| <span class="n">warnings</span><span class="o">.</span><span class="n">warn</span><span class="p">(</span><span class="s2">"load_params is deprecated. Please use load_parameters."</span><span class="p">)</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">load_parameters</span><span class="p">(</span><span class="n">filename</span><span class="p">,</span> <span class="n">ctx</span><span class="p">,</span> <span class="n">allow_missing</span><span class="p">,</span> <span class="n">ignore_extra</span><span class="p">)</span></div> |
| |
| <div class="viewcode-block" id="Block.register_child"><a class="viewcode-back" href="../../../api/gluon/block.html#mxnet.gluon.Block.register_child">[docs]</a> <span class="k">def</span> <span class="nf">register_child</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">block</span><span class="p">,</span> <span class="n">name</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span> |
| <span class="sd">"""Registers block as a child of self. :py:class:`Block` s assigned to self as</span> |
| <span class="sd"> attributes will be registered automatically."""</span> |
| <span class="k">if</span> <span class="n">name</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span> |
| <span class="n">name</span> <span class="o">=</span> <span class="nb">str</span><span class="p">(</span><span class="nb">len</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_children</span><span class="p">))</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_children</span><span class="p">[</span><span class="n">name</span><span class="p">]</span> <span class="o">=</span> <span class="n">block</span></div> |
| |
| <div class="viewcode-block" id="Block.register_forward_pre_hook"><a class="viewcode-back" href="../../../api/gluon/block.html#mxnet.gluon.Block.register_forward_pre_hook">[docs]</a> <span class="k">def</span> <span class="nf">register_forward_pre_hook</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">hook</span><span class="p">):</span> |
| <span class="sa">r</span><span class="sd">"""Registers a forward pre-hook on the block.</span> |
| |
| <span class="sd"> The hook function is called immediately before :func:`forward`.</span> |
| <span class="sd"> It should not modify the input or output.</span> |
| |
| <span class="sd"> Parameters</span> |
| <span class="sd"> ----------</span> |
| <span class="sd"> hook : callable</span> |
| <span class="sd"> The forward hook function of form `hook(block, input) -> None`.</span> |
| |
| <span class="sd"> Returns</span> |
| <span class="sd"> -------</span> |
| <span class="sd"> :class:`mxnet.gluon.utils.HookHandle`</span> |
| <span class="sd"> """</span> |
| <span class="n">handle</span> <span class="o">=</span> <span class="n">HookHandle</span><span class="p">()</span> |
| <span class="n">handle</span><span class="o">.</span><span class="n">attach</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_forward_pre_hooks</span><span class="p">,</span> <span class="n">hook</span><span class="p">)</span> |
| <span class="k">return</span> <span class="n">handle</span></div> |
| |
| <div class="viewcode-block" id="Block.register_forward_hook"><a class="viewcode-back" href="../../../api/gluon/block.html#mxnet.gluon.Block.register_forward_hook">[docs]</a> <span class="k">def</span> <span class="nf">register_forward_hook</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">hook</span><span class="p">):</span> |
| <span class="sa">r</span><span class="sd">"""Registers a forward hook on the block.</span> |
| |
| <span class="sd"> The hook function is called immediately after :func:`forward`.</span> |
| <span class="sd"> It should not modify the input or output.</span> |
| |
| <span class="sd"> Parameters</span> |
| <span class="sd"> ----------</span> |
| <span class="sd"> hook : callable</span> |
| <span class="sd"> The forward hook function of form `hook(block, input, output) -> None`.</span> |
| |
| <span class="sd"> Returns</span> |
| <span class="sd"> -------</span> |
| <span class="sd"> :class:`mxnet.gluon.utils.HookHandle`</span> |
| <span class="sd"> """</span> |
| <span class="n">handle</span> <span class="o">=</span> <span class="n">HookHandle</span><span class="p">()</span> |
| <span class="n">handle</span><span class="o">.</span><span class="n">attach</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_forward_hooks</span><span class="p">,</span> <span class="n">hook</span><span class="p">)</span> |
| <span class="k">return</span> <span class="n">handle</span></div> |
| |
| <div class="viewcode-block" id="Block.apply"><a class="viewcode-back" href="../../../api/gluon/block.html#mxnet.gluon.Block.apply">[docs]</a> <span class="k">def</span> <span class="nf">apply</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">fn</span><span class="p">):</span> |
| <span class="sa">r</span><span class="sd">"""Applies ``fn`` recursively to every child block as well as self.</span> |
| |
| <span class="sd"> Parameters</span> |
| <span class="sd"> ----------</span> |
| <span class="sd"> fn : callable</span> |
| <span class="sd"> Function to be applied to each submodule, of form `fn(block)`.</span> |
| |
| <span class="sd"> Returns</span> |
| <span class="sd"> -------</span> |
| <span class="sd"> this block</span> |
| <span class="sd"> """</span> |
| <span class="k">for</span> <span class="n">cld</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_children</span><span class="o">.</span><span class="n">values</span><span class="p">():</span> |
| <span class="n">cld</span><span class="o">.</span><span class="n">apply</span><span class="p">(</span><span class="n">fn</span><span class="p">)</span> |
| <span class="n">fn</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> |
| |
| <div class="viewcode-block" id="Block.initialize"><a class="viewcode-back" href="../../../api/gluon/block.html#mxnet.gluon.Block.initialize">[docs]</a> <span class="k">def</span> <span class="nf">initialize</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">init</span><span class="o">=</span><span class="n">initializer</span><span class="o">.</span><span class="n">Uniform</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">verbose</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> |
| <span class="n">force_reinit</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span> |
| <span class="sd">"""Initializes :py:class:`Parameter` s of this :py:class:`Block` and its children.</span> |
| <span class="sd"> Equivalent to ``block.collect_params().initialize(...)``</span> |
| |
| <span class="sd"> Parameters</span> |
| <span class="sd"> ----------</span> |
| <span class="sd"> init : Initializer</span> |
| <span class="sd"> Global default Initializer to be used when :py:meth:`Parameter.init` is ``None``.</span> |
| <span class="sd"> Otherwise, :py:meth:`Parameter.init` takes precedence.</span> |
| <span class="sd"> ctx : Context or list of Context</span> |
| <span class="sd"> Keeps a copy of Parameters on one or many context(s).</span> |
| <span class="sd"> verbose : bool, default False</span> |
| <span class="sd"> Whether to verbosely print out details on initialization.</span> |
| <span class="sd"> force_reinit : bool, default False</span> |
| <span class="sd"> Whether to force re-initialization if parameter is already initialized.</span> |
| <span class="sd"> """</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">collect_params</span><span class="p">()</span><span class="o">.</span><span class="n">initialize</span><span class="p">(</span><span class="n">init</span><span class="p">,</span> <span class="n">ctx</span><span class="p">,</span> <span class="n">verbose</span><span class="p">,</span> <span class="n">force_reinit</span><span class="p">)</span></div> |
| |
| <div class="viewcode-block" id="Block.hybridize"><a class="viewcode-back" href="../../../api/gluon/block.html#mxnet.gluon.Block.hybridize">[docs]</a> <span class="k">def</span> <span class="nf">hybridize</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">active</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span> |
| <span class="sd">""" Please refer description of HybridBlock hybridize().</span> |
| <span class="sd"> """</span> |
| <span class="k">for</span> <span class="n">cld</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_children</span><span class="o">.</span><span class="n">values</span><span class="p">():</span> |
| <span class="n">cld</span><span class="o">.</span><span class="n">hybridize</span><span class="p">(</span><span class="n">active</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span></div> |
| |
| <div class="viewcode-block" id="Block.save"><a class="viewcode-back" href="../../../api/gluon/block.html#mxnet.gluon.Block.save">[docs]</a> <span class="k">def</span> <span class="nf">save</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">prefix</span><span class="p">):</span> |
| <span class="sd">"""Save the model architecture and parameters to load again later</span> |
| |
| <span class="sd"> Saves the model architecture as a nested dictionary where each Block</span> |
| <span class="sd"> in the model is a dictionary and its children are sub-dictionaries.</span> |
| |
| <span class="sd"> Each Block is uniquely identified by Block class name and a unique ID.</span> |
| <span class="sd"> We save the child's name that that parent uses for it to restore later</span> |
| <span class="sd"> in order to match the saved parameters.</span> |
| |
| <span class="sd"> Recursively traverses a Block's children in order (since its an</span> |
| <span class="sd"> OrderedDict) and uses the unique ID to denote that specific Block.</span> |
| <span class="sd"> Assumes that the model is created in an identical order every time.</span> |
| <span class="sd"> If the model is not able to be recreated deterministically do not</span> |
| <span class="sd"> use this set of APIs to save/load your model.</span> |
| |
| <span class="sd"> For HybridBlocks, the cached_graph (Symbol & inputs) is saved if</span> |
| <span class="sd"> it has already been hybridized.</span> |
| |
| <span class="sd"> Parameters</span> |
| <span class="sd"> ----------</span> |
| <span class="sd"> prefix : str</span> |
| <span class="sd"> The prefix to use in filenames for saving this model:</span> |
| <span class="sd"> <prefix>-model.json and <prefix>-model.params</span> |
| <span class="sd"> """</span> |
| <span class="c1"># create empty model structure</span> |
| <span class="n">model</span> <span class="o">=</span> <span class="p">{}</span> |
| <span class="k">def</span> <span class="nf">_save_cached_graphs</span><span class="p">(</span><span class="n">blk</span><span class="p">,</span> <span class="n">index</span><span class="p">,</span> <span class="n">structure</span><span class="p">):</span> |
| <span class="c1"># create new entry for this block</span> |
| <span class="n">mdl</span> <span class="o">=</span> <span class="p">{</span><span class="s1">'orig_name'</span><span class="p">:</span> <span class="n">blk</span><span class="o">.</span><span class="n">name</span><span class="p">}</span> |
| <span class="c1"># encode unique name based on block type and ID</span> |
| <span class="n">name</span> <span class="o">=</span> <span class="nb">type</span><span class="p">(</span><span class="n">blk</span><span class="p">)</span><span class="o">.</span><span class="vm">__name__</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span> |
| <span class="n">structure</span><span class="p">[</span><span class="n">name</span><span class="o">+</span><span class="nb">str</span><span class="p">(</span><span class="n">index</span><span class="p">[</span><span class="mi">0</span><span class="p">])]</span> <span class="o">=</span> <span class="n">mdl</span> |
| <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">blk</span><span class="p">,</span> <span class="n">HybridBlock</span><span class="p">):</span> |
| <span class="k">if</span> <span class="n">blk</span><span class="o">.</span><span class="n">_cached_graph</span><span class="p">:</span> |
| <span class="c1"># save in/out formats</span> |
| <span class="n">mdl</span><span class="p">[</span><span class="s1">'in_format'</span><span class="p">]</span> <span class="o">=</span> <span class="n">blk</span><span class="o">.</span><span class="n">_in_format</span> |
| <span class="n">mdl</span><span class="p">[</span><span class="s1">'out_format'</span><span class="p">]</span> <span class="o">=</span> <span class="n">blk</span><span class="o">.</span><span class="n">_out_format</span> |
| <span class="c1"># save cached graph & input symbols</span> |
| <span class="n">syms</span><span class="p">,</span> <span class="n">out</span> <span class="o">=</span> <span class="n">blk</span><span class="o">.</span><span class="n">_cached_graph</span> |
| <span class="n">mdl_syms</span> <span class="o">=</span> <span class="p">[]</span> |
| <span class="k">for</span> <span class="n">sym</span> <span class="ow">in</span> <span class="n">syms</span><span class="p">:</span> |
| <span class="n">mdl_syms</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">sym</span><span class="o">.</span><span class="n">tojson</span><span class="p">())</span> |
| <span class="n">mdl</span><span class="p">[</span><span class="s1">'inputs'</span><span class="p">]</span> <span class="o">=</span> <span class="n">mdl_syms</span> |
| <span class="n">mdl</span><span class="p">[</span><span class="s1">'symbol'</span><span class="p">]</span> <span class="o">=</span> <span class="n">out</span><span class="o">.</span><span class="n">tojson</span><span class="p">()</span> |
| <span class="n">mdl</span><span class="p">[</span><span class="s1">'hybridized'</span><span class="p">]</span> <span class="o">=</span> <span class="kc">True</span> |
| <span class="k">else</span><span class="p">:</span> |
| <span class="n">mdl</span><span class="p">[</span><span class="s1">'hybridized'</span><span class="p">]</span> <span class="o">=</span> <span class="kc">False</span> |
| <span class="n">children</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">()</span> |
| <span class="n">mdl</span><span class="p">[</span><span class="s1">'children'</span><span class="p">]</span> <span class="o">=</span> <span class="n">children</span> |
| <span class="c1"># recursively save children</span> |
| <span class="k">for</span> <span class="n">ch_name</span><span class="p">,</span> <span class="n">child</span> <span class="ow">in</span> <span class="n">blk</span><span class="o">.</span><span class="n">_children</span><span class="o">.</span><span class="n">items</span><span class="p">():</span> |
| <span class="n">index</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="c1"># save child's original name in this block's map</span> |
| <span class="n">children</span><span class="p">[</span><span class="n">child</span><span class="o">.</span><span class="n">name</span><span class="p">]</span> <span class="o">=</span> <span class="n">ch_name</span> |
| <span class="n">_save_cached_graphs</span><span class="p">(</span><span class="n">child</span><span class="p">,</span> <span class="n">index</span><span class="p">,</span> <span class="n">mdl</span><span class="p">)</span> |
| <span class="c1"># save top-level block</span> |
| <span class="n">index</span> <span class="o">=</span> <span class="p">[</span><span class="mi">0</span><span class="p">]</span> |
| <span class="n">_save_cached_graphs</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">index</span><span class="p">,</span> <span class="n">model</span><span class="p">)</span> |
| <span class="c1"># save model</span> |
| <span class="k">with</span> <span class="nb">open</span><span class="p">(</span><span class="n">prefix</span><span class="o">+</span><span class="s1">'-model.json'</span><span class="p">,</span> <span class="s1">'w'</span><span class="p">)</span> <span class="k">as</span> <span class="n">fp</span><span class="p">:</span> |
| <span class="n">json</span><span class="o">.</span><span class="n">dump</span><span class="p">(</span><span class="n">model</span><span class="p">,</span> <span class="n">fp</span><span class="p">)</span> |
| <span class="c1"># save params</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">save_parameters</span><span class="p">(</span><span class="n">prefix</span><span class="o">+</span><span class="s1">'-model.params'</span><span class="p">)</span></div> |
| |
| <div class="viewcode-block" id="Block.load"><a class="viewcode-back" href="../../../api/gluon/block.html#mxnet.gluon.Block.load">[docs]</a> <span class="k">def</span> <span class="nf">load</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">prefix</span><span class="p">):</span> |
| <span class="sd">"""Load a model saved using the `save` API</span> |
| |
| <span class="sd"> Reconfigures a model using the saved configuration. This function</span> |
| <span class="sd"> does not regenerate the model architecture. It resets the children's</span> |
| <span class="sd"> names as they were when saved in order to match the names of the</span> |
| <span class="sd"> saved parameters.</span> |
| |
| <span class="sd"> This function assumes the Blocks in the model were created in the same</span> |
| <span class="sd"> order they were when the model was saved. This is because each Block is</span> |
| <span class="sd"> uniquely identified by Block class name and a unique ID in order (since</span> |
| <span class="sd"> its an OrderedDict) and uses the unique ID to denote that specific Block.</span> |
| <span class="sd"> Assumes that the model is created in an identical order every time.</span> |
| <span class="sd"> If the model is not able to be recreated deterministically do not</span> |
| <span class="sd"> use this set of APIs to save/load your model.</span> |
| |
| <span class="sd"> For HybridBlocks, the cached_graph (Symbol & inputs) and settings are</span> |
| <span class="sd"> restored if it had been hybridized before saving.</span> |
| |
| <span class="sd"> Parameters</span> |
| <span class="sd"> ----------</span> |
| <span class="sd"> prefix : str</span> |
| <span class="sd"> The prefix to use in filenames for loading this model:</span> |
| <span class="sd"> <prefix>-model.json and <prefix>-model.params</span> |
| <span class="sd"> """</span> |
| <span class="c1"># load model json from file</span> |
| <span class="k">with</span> <span class="nb">open</span><span class="p">(</span><span class="n">prefix</span><span class="o">+</span><span class="s1">'-model.json'</span><span class="p">)</span> <span class="k">as</span> <span class="n">fp</span><span class="p">:</span> |
| <span class="n">model</span> <span class="o">=</span> <span class="n">json</span><span class="o">.</span><span class="n">load</span><span class="p">(</span><span class="n">fp</span><span class="p">)</span> |
| |
| <span class="k">def</span> <span class="nf">_load_cached_graphs</span><span class="p">(</span><span class="n">blk</span><span class="p">,</span> <span class="n">index</span><span class="p">,</span> <span class="n">structure</span><span class="p">):</span> |
| <span class="c1"># get block name</span> |
| <span class="n">name</span> <span class="o">=</span> <span class="nb">type</span><span class="p">(</span><span class="n">blk</span><span class="p">)</span><span class="o">.</span><span class="vm">__name__</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span> |
| <span class="c1"># lookup previous encoded name based on block type and ID</span> |
| <span class="n">mdl</span> <span class="o">=</span> <span class="n">structure</span><span class="p">[</span><span class="n">name</span><span class="o">+</span><span class="nb">str</span><span class="p">(</span><span class="n">index</span><span class="p">[</span><span class="mi">0</span><span class="p">])]</span> |
| <span class="c1"># rename block to what it was when saved</span> |
| <span class="n">blk</span><span class="o">.</span><span class="n">_name</span> <span class="o">=</span> <span class="n">mdl</span><span class="p">[</span><span class="s1">'orig_name'</span><span class="p">]</span> |
| <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">blk</span><span class="p">,</span> <span class="n">HybridBlock</span><span class="p">):</span> |
| <span class="k">if</span> <span class="n">mdl</span><span class="p">[</span><span class="s1">'hybridized'</span><span class="p">]:</span> |
| <span class="c1"># restore in/out formats</span> |
| <span class="n">blk</span><span class="o">.</span><span class="n">_in_format</span> <span class="o">=</span> <span class="n">mdl</span><span class="p">[</span><span class="s1">'in_format'</span><span class="p">]</span> |
| <span class="n">blk</span><span class="o">.</span><span class="n">_out_format</span> <span class="o">=</span> <span class="n">mdl</span><span class="p">[</span><span class="s1">'out_format'</span><span class="p">]</span> |
| <span class="c1"># get saved symbol</span> |
| <span class="n">out</span> <span class="o">=</span> <span class="n">load_json</span><span class="p">(</span><span class="n">mdl</span><span class="p">[</span><span class="s1">'symbol'</span><span class="p">])</span> |
| <span class="n">syms</span> <span class="o">=</span> <span class="p">[]</span> |
| <span class="c1"># recreate inputs for this symbol</span> |
| <span class="k">for</span> <span class="n">inp</span> <span class="ow">in</span> <span class="n">mdl</span><span class="p">[</span><span class="s1">'inputs'</span><span class="p">]:</span> |
| <span class="n">syms</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">load_json</span><span class="p">(</span><span class="n">inp</span><span class="p">))</span> |
| <span class="c1"># reset cached_graph and active status</span> |
| <span class="n">blk</span><span class="o">.</span><span class="n">_cached_graph</span> <span class="o">=</span> <span class="p">(</span><span class="n">syms</span><span class="p">,</span> <span class="n">out</span><span class="p">)</span> |
| <span class="n">blk</span><span class="o">.</span><span class="n">_active</span> <span class="o">=</span> <span class="kc">True</span> |
| <span class="c1"># rename params with updated block name</span> |
| <span class="n">pnames</span> <span class="o">=</span> <span class="nb">list</span><span class="p">(</span><span class="n">blk</span><span class="o">.</span><span class="n">params</span><span class="o">.</span><span class="n">keys</span><span class="p">())</span> |
| <span class="k">for</span> <span class="n">p</span> <span class="ow">in</span> <span class="n">pnames</span><span class="p">:</span> |
| <span class="n">param</span> <span class="o">=</span> <span class="n">blk</span><span class="o">.</span><span class="n">params</span><span class="o">.</span><span class="n">_params</span><span class="p">[</span><span class="n">p</span><span class="p">]</span> |
| <span class="n">new_name</span> <span class="o">=</span> <span class="n">blk</span><span class="o">.</span><span class="n">name</span> <span class="o">+</span><span class="s1">'_'</span><span class="o">+</span> <span class="n">p</span><span class="p">[</span><span class="nb">len</span><span class="p">(</span><span class="n">blk</span><span class="o">.</span><span class="n">params</span><span class="o">.</span><span class="n">_prefix</span><span class="p">):]</span> |
| <span class="n">blk</span><span class="o">.</span><span class="n">params</span><span class="o">.</span><span class="n">_params</span><span class="o">.</span><span class="n">pop</span><span class="p">(</span><span class="n">p</span><span class="p">)</span> |
| <span class="n">blk</span><span class="o">.</span><span class="n">params</span><span class="o">.</span><span class="n">_params</span><span class="p">[</span><span class="n">new_name</span><span class="p">]</span> <span class="o">=</span> <span class="n">param</span> |
| <span class="c1"># recursively reload children</span> |
| <span class="k">for</span> <span class="n">ch_name</span><span class="p">,</span> <span class="n">child</span> <span class="ow">in</span> <span class="n">blk</span><span class="o">.</span><span class="n">_children</span><span class="o">.</span><span class="n">items</span><span class="p">():</span> |
| <span class="n">index</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="n">_load_cached_graphs</span><span class="p">(</span><span class="n">child</span><span class="p">,</span> <span class="n">index</span><span class="p">,</span> <span class="n">mdl</span><span class="p">)</span> |
| <span class="c1"># current set of child names</span> |
| <span class="n">ch_names</span> <span class="o">=</span> <span class="nb">list</span><span class="p">(</span><span class="n">blk</span><span class="o">.</span><span class="n">_children</span><span class="o">.</span><span class="n">keys</span><span class="p">())</span> |
| <span class="c1"># original child names</span> |
| <span class="n">children</span> <span class="o">=</span> <span class="n">mdl</span><span class="p">[</span><span class="s1">'children'</span><span class="p">]</span> |
| <span class="c1"># loop and remap children with original names</span> |
| <span class="k">for</span> <span class="n">ch_name</span> <span class="ow">in</span> <span class="n">ch_names</span><span class="p">:</span> |
| <span class="n">child</span> <span class="o">=</span> <span class="n">blk</span><span class="o">.</span><span class="n">_children</span><span class="p">[</span><span class="n">ch_name</span><span class="p">]</span> |
| <span class="n">blk</span><span class="o">.</span><span class="n">_children</span><span class="o">.</span><span class="n">pop</span><span class="p">(</span><span class="n">ch_name</span><span class="p">)</span> |
| <span class="n">orig_name</span> <span class="o">=</span> <span class="n">children</span><span class="p">[</span><span class="n">child</span><span class="o">.</span><span class="n">name</span><span class="p">]</span> |
| <span class="n">blk</span><span class="o">.</span><span class="n">_children</span><span class="p">[</span><span class="n">orig_name</span><span class="p">]</span> <span class="o">=</span> <span class="n">child</span> |
| <span class="c1"># load top-level block</span> |
| <span class="n">index</span> <span class="o">=</span> <span class="p">[</span><span class="mi">0</span><span class="p">]</span> |
| <span class="n">_load_cached_graphs</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">index</span><span class="p">,</span> <span class="n">model</span><span class="p">)</span> |
| <span class="c1"># load params</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">load_parameters</span><span class="p">(</span><span class="n">prefix</span><span class="o">+</span><span class="s1">'-model.params'</span><span class="p">)</span></div> |
| |
| <div class="viewcode-block" id="Block.cast"><a class="viewcode-back" href="../../../api/gluon/block.html#mxnet.gluon.Block.cast">[docs]</a> <span class="k">def</span> <span class="nf">cast</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">dtype</span><span class="p">):</span> |
| <span class="sd">"""Cast this Block to use another data type.</span> |
| |
| <span class="sd"> Parameters</span> |
| <span class="sd"> ----------</span> |
| <span class="sd"> dtype : str or numpy.dtype</span> |
| <span class="sd"> The new data type.</span> |
| <span class="sd"> """</span> |
| <span class="k">for</span> <span class="n">child</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_children</span><span class="o">.</span><span class="n">values</span><span class="p">():</span> |
| <span class="n">child</span><span class="o">.</span><span class="n">cast</span><span class="p">(</span><span class="n">dtype</span><span class="p">)</span> |
| <span class="k">for</span> <span class="n">_</span><span class="p">,</span> <span class="n">param</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">params</span><span class="o">.</span><span class="n">items</span><span class="p">():</span> |
| <span class="n">param</span><span class="o">.</span><span class="n">cast</span><span class="p">(</span><span class="n">dtype</span><span class="p">)</span></div> |
| |
| <span class="k">def</span> <span class="fm">__call__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">):</span> |
| <span class="sd">"""Calls forward. Only accepts positional arguments."""</span> |
| <span class="k">for</span> <span class="n">hook</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_forward_pre_hooks</span><span class="o">.</span><span class="n">values</span><span class="p">():</span> |
| <span class="n">hook</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">args</span><span class="p">)</span> |
| |
| <span class="n">out</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">forward</span><span class="p">(</span><span class="o">*</span><span class="n">args</span><span class="p">)</span> |
| |
| <span class="k">for</span> <span class="n">hook</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_forward_hooks</span><span class="o">.</span><span class="n">values</span><span class="p">():</span> |
| <span class="n">hook</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">args</span><span class="p">,</span> <span class="n">out</span><span class="p">)</span> |
| <span class="k">if</span> <span class="n">_mx_npx</span><span class="o">.</span><span class="n">is_np_array</span><span class="p">():</span> |
| <span class="n">_check_all_np_ndarrays</span><span class="p">(</span><span class="n">out</span><span class="p">)</span> |
| <span class="k">return</span> <span class="n">out</span> |
| |
| <div class="viewcode-block" id="Block.forward"><a class="viewcode-back" href="../../../api/gluon/block.html#mxnet.gluon.Block.forward">[docs]</a> <span class="k">def</span> <span class="nf">forward</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">):</span> |
| <span class="sd">"""Overrides to implement forward computation using :py:class:`NDArray`. Only</span> |
| <span class="sd"> accepts positional arguments.</span> |
| |
| <span class="sd"> Parameters</span> |
| <span class="sd"> ----------</span> |
| <span class="sd"> *args : list of NDArray</span> |
| <span class="sd"> Input tensors.</span> |
| <span class="sd"> """</span> |
| <span class="c1"># pylint: disable= invalid-name</span> |
| <span class="k">raise</span> <span class="ne">NotImplementedError</span></div> |
| |
| <div class="viewcode-block" id="Block.register_op_hook"><a class="viewcode-back" href="../../../api/gluon/block.html#mxnet.gluon.Block.register_op_hook">[docs]</a> <span class="k">def</span> <span class="nf">register_op_hook</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">callback</span><span class="p">,</span> <span class="n">monitor_all</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span> |
| <span class="sd">"""Install callback monitor.</span> |
| |
| <span class="sd"> Parameters</span> |
| <span class="sd"> ----------</span> |
| <span class="sd"> callback : function</span> |
| <span class="sd"> Takes a string and a NDArrayHandle.</span> |
| <span class="sd"> monitor_all : bool, default False</span> |
| <span class="sd"> If true, monitor both input and output, otherwise monitor output only.</span> |
| <span class="sd"> """</span> |
| <span class="k">for</span> <span class="n">cld</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_children</span><span class="o">.</span><span class="n">values</span><span class="p">():</span> |
| <span class="n">cld</span><span class="o">.</span><span class="n">register_op_hook</span><span class="p">(</span><span class="n">callback</span><span class="p">,</span> <span class="n">monitor_all</span><span class="p">)</span></div> |
| |
| <div class="viewcode-block" id="Block.summary"><a class="viewcode-back" href="../../../api/gluon/block.html#mxnet.gluon.Block.summary">[docs]</a> <span class="k">def</span> <span class="nf">summary</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="o">*</span><span class="n">inputs</span><span class="p">):</span> |
| <span class="sd">"""Print the summary of the model's output and parameters.</span> |
| |
| <span class="sd"> The network must have been initialized, and must not have been hybridized.</span> |
| |
| <span class="sd"> Parameters</span> |
| <span class="sd"> ----------</span> |
| <span class="sd"> inputs : object</span> |
| <span class="sd"> Any input that the model supports. For any tensor in the input, only</span> |
| <span class="sd"> :class:`mxnet.ndarray.NDArray` is supported.</span> |
| <span class="sd"> """</span> |
| <span class="n">summary</span> <span class="o">=</span> <span class="n">OrderedDict</span><span class="p">()</span> |
| <span class="n">seen</span> <span class="o">=</span> <span class="nb">set</span><span class="p">()</span> |
| <span class="n">hooks</span> <span class="o">=</span> <span class="p">[]</span> |
| |
| <span class="k">def</span> <span class="nf">_get_shape_str</span><span class="p">(</span><span class="n">args</span><span class="p">):</span> |
| <span class="k">def</span> <span class="nf">flatten</span><span class="p">(</span><span class="n">args</span><span class="p">):</span> |
| <span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">args</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="k">return</span> <span class="p">[</span><span class="n">args</span><span class="p">],</span> <span class="nb">int</span><span class="p">(</span><span class="mi">0</span><span class="p">)</span> |
| <span class="n">flat</span> <span class="o">=</span> <span class="p">[]</span> |
| <span class="n">fmts</span> <span class="o">=</span> <span class="p">[]</span> |
| <span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="n">args</span><span class="p">:</span> |
| <span class="n">arg</span><span class="p">,</span> <span class="n">fmt</span> <span class="o">=</span> <span class="n">flatten</span><span class="p">(</span><span class="n">i</span><span class="p">)</span> |
| <span class="n">flat</span><span class="o">.</span><span class="n">extend</span><span class="p">(</span><span class="n">arg</span><span class="p">)</span> |
| <span class="n">fmts</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">fmt</span><span class="p">)</span> |
| <span class="k">return</span> <span class="n">flat</span><span class="p">,</span> <span class="n">fmts</span> |
| |
| <span class="k">def</span> <span class="nf">regroup</span><span class="p">(</span><span class="n">args</span><span class="p">,</span> <span class="n">fmt</span><span class="p">):</span> |
| <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">fmt</span><span class="p">,</span> <span class="nb">int</span><span class="p">):</span> |
| <span class="k">if</span> <span class="n">fmt</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span> |
| <span class="k">return</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="k">return</span> <span class="n">args</span><span class="p">[:</span><span class="n">fmt</span><span class="p">],</span> <span class="n">args</span><span class="p">[</span><span class="n">fmt</span><span class="p">:]</span> |
| <span class="n">ret</span> <span class="o">=</span> <span class="p">[]</span> |
| <span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="n">fmt</span><span class="p">:</span> |
| <span class="n">res</span><span class="p">,</span> <span class="n">args</span> <span class="o">=</span> <span class="n">regroup</span><span class="p">(</span><span class="n">args</span><span class="p">,</span> <span class="n">i</span><span class="p">)</span> |
| <span class="n">ret</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">res</span><span class="p">)</span> |
| <span class="k">return</span> <span class="n">ret</span><span class="p">,</span> <span class="n">args</span> |
| |
| <span class="n">flat_args</span><span class="p">,</span> <span class="n">fmts</span> <span class="o">=</span> <span class="n">flatten</span><span class="p">(</span><span class="n">args</span><span class="p">)</span> |
| <span class="n">flat_arg_shapes</span> <span class="o">=</span> <span class="p">[</span><span class="n">x</span><span class="o">.</span><span class="n">shape</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">ndarray</span><span class="o">.</span><span class="n">NDArray</span><span class="p">)</span> <span class="k">else</span> <span class="n">x</span> |
| <span class="k">for</span> <span class="n">x</span> <span class="ow">in</span> <span class="n">flat_args</span><span class="p">]</span> |
| <span class="n">shapes</span> <span class="o">=</span> <span class="n">regroup</span><span class="p">(</span><span class="n">flat_arg_shapes</span><span class="p">,</span> <span class="n">fmts</span><span class="p">)[</span><span class="mi">0</span><span class="p">]</span> |
| <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">shapes</span><span class="p">,</span> <span class="nb">list</span><span class="p">):</span> |
| <span class="n">shape_str</span> <span class="o">=</span> <span class="nb">str</span><span class="p">(</span><span class="n">shapes</span><span class="p">)[</span><span class="mi">1</span><span class="p">:</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span> |
| <span class="k">else</span><span class="p">:</span> |
| <span class="n">shape_str</span> <span class="o">=</span> <span class="nb">str</span><span class="p">(</span><span class="n">shapes</span><span class="p">)</span> |
| <span class="k">return</span> <span class="n">shape_str</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s1">'L'</span><span class="p">,</span> <span class="s1">''</span><span class="p">)</span> |
| |
| <span class="k">def</span> <span class="nf">_register_summary_hook</span><span class="p">(</span><span class="n">block</span><span class="p">):</span> |
| <span class="k">assert</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">block</span><span class="p">,</span> <span class="n">HybridBlock</span><span class="p">)</span> <span class="ow">or</span> <span class="ow">not</span> <span class="n">block</span><span class="o">.</span><span class="n">_active</span><span class="p">,</span> \ |
| <span class="s1">'"</span><span class="si">{}</span><span class="s1">" must not be hybridized to print summary.'</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">block</span><span class="o">.</span><span class="n">name</span><span class="p">)</span> |
| <span class="k">def</span> <span class="nf">_summary_hook</span><span class="p">(</span><span class="n">block</span><span class="p">,</span> <span class="n">_</span><span class="p">,</span> <span class="n">outputs</span><span class="p">):</span> |
| <span class="n">class_name</span> <span class="o">=</span> <span class="n">block</span><span class="o">.</span><span class="vm">__class__</span><span class="o">.</span><span class="vm">__name__</span> |
| <span class="n">block_idx</span> <span class="o">=</span> <span class="nb">len</span><span class="p">(</span><span class="n">summary</span><span class="p">)</span> <span class="o">-</span> <span class="mi">1</span> |
| |
| <span class="n">m_key</span> <span class="o">=</span> <span class="s1">'</span><span class="si">%s</span><span class="s1">-</span><span class="si">%i</span><span class="s1">'</span> <span class="o">%</span> <span class="p">(</span><span class="n">class_name</span><span class="p">,</span> <span class="n">block_idx</span><span class="o">+</span><span class="mi">1</span><span class="p">)</span> |
| <span class="n">summary</span><span class="p">[</span><span class="n">m_key</span><span class="p">]</span> <span class="o">=</span> <span class="n">OrderedDict</span><span class="p">()</span> |
| <span class="n">summary</span><span class="p">[</span><span class="n">m_key</span><span class="p">][</span><span class="s1">'output_shape'</span><span class="p">]</span> <span class="o">=</span> <span class="n">_get_shape_str</span><span class="p">(</span><span class="n">outputs</span><span class="p">)</span> |
| |
| <span class="n">params</span> <span class="o">=</span> <span class="mi">0</span> |
| <span class="n">summary</span><span class="p">[</span><span class="n">m_key</span><span class="p">][</span><span class="s1">'trainable'</span><span class="p">]</span> <span class="o">=</span> <span class="mi">0</span> |
| <span class="n">summary</span><span class="p">[</span><span class="n">m_key</span><span class="p">][</span><span class="s1">'shared'</span><span class="p">]</span> <span class="o">=</span> <span class="mi">0</span> |
| <span class="k">for</span> <span class="n">p</span> <span class="ow">in</span> <span class="n">block</span><span class="o">.</span><span class="n">params</span><span class="o">.</span><span class="n">values</span><span class="p">():</span> |
| <span class="n">params</span> <span class="o">+=</span> <span class="n">p</span><span class="o">.</span><span class="n">data</span><span class="p">()</span><span class="o">.</span><span class="n">size</span> |
| <span class="n">summary</span><span class="p">[</span><span class="n">m_key</span><span class="p">][</span><span class="s1">'trainable'</span><span class="p">]</span> <span class="o">+=</span> <span class="mi">0</span> <span class="k">if</span> <span class="n">p</span><span class="o">.</span><span class="n">grad_req</span> <span class="o">==</span> <span class="s1">'null'</span> <span class="k">else</span> <span class="n">p</span><span class="o">.</span><span class="n">data</span><span class="p">()</span><span class="o">.</span><span class="n">size</span> |
| <span class="k">if</span> <span class="n">p</span> <span class="ow">in</span> <span class="n">seen</span><span class="p">:</span> |
| <span class="n">summary</span><span class="p">[</span><span class="n">m_key</span><span class="p">][</span><span class="s1">'shared'</span><span class="p">]</span> <span class="o">+=</span> <span class="n">p</span><span class="o">.</span><span class="n">data</span><span class="p">()</span><span class="o">.</span><span class="n">size</span> |
| <span class="k">else</span><span class="p">:</span> |
| <span class="n">seen</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="n">p</span><span class="p">)</span> |
| <span class="n">summary</span><span class="p">[</span><span class="n">m_key</span><span class="p">][</span><span class="s1">'n_params'</span><span class="p">]</span> <span class="o">=</span> <span class="n">params</span> |
| |
| <span class="kn">from</span> <span class="nn">.nn.basic_layers</span> <span class="kn">import</span> <span class="n">Sequential</span><span class="p">,</span> <span class="n">HybridSequential</span> |
| <span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">block</span><span class="p">,</span> <span class="p">(</span><span class="n">Sequential</span><span class="p">,</span> <span class="n">HybridSequential</span><span class="p">)):</span> |
| <span class="n">hooks</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">block</span><span class="o">.</span><span class="n">register_forward_hook</span><span class="p">(</span><span class="n">_summary_hook</span><span class="p">))</span> |
| |
| <span class="n">summary</span><span class="p">[</span><span class="s1">'Input'</span><span class="p">]</span> <span class="o">=</span> <span class="n">OrderedDict</span><span class="p">()</span> |
| <span class="n">summary</span><span class="p">[</span><span class="s1">'Input'</span><span class="p">][</span><span class="s1">'output_shape'</span><span class="p">]</span> <span class="o">=</span> <span class="n">_get_shape_str</span><span class="p">(</span><span class="n">inputs</span><span class="p">)</span> |
| <span class="n">summary</span><span class="p">[</span><span class="s1">'Input'</span><span class="p">][</span><span class="s1">'n_params'</span><span class="p">]</span> <span class="o">=</span> <span class="mi">0</span> |
| <span class="n">summary</span><span class="p">[</span><span class="s1">'Input'</span><span class="p">][</span><span class="s1">'trainable'</span><span class="p">]</span> <span class="o">=</span> <span class="mi">0</span> |
| <span class="n">summary</span><span class="p">[</span><span class="s1">'Input'</span><span class="p">][</span><span class="s1">'shared'</span><span class="p">]</span> <span class="o">=</span> <span class="mi">0</span> |
| |
| <span class="k">try</span><span class="p">:</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">apply</span><span class="p">(</span><span class="n">_register_summary_hook</span><span class="p">)</span> |
| <span class="bp">self</span><span class="p">(</span><span class="o">*</span><span class="n">inputs</span><span class="p">)</span> |
| |
| <span class="n">line_format</span> <span class="o">=</span> <span class="s1">'</span><span class="si">{:>20}</span><span class="s1"> </span><span class="si">{:>42}</span><span class="s1"> </span><span class="si">{:>15}</span><span class="s1">'</span> |
| <span class="nb">print</span><span class="p">(</span><span class="s1">'-'</span><span class="o">*</span><span class="mi">80</span><span class="p">)</span> |
| <span class="nb">print</span><span class="p">(</span><span class="n">line_format</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="s1">'Layer (type)'</span><span class="p">,</span> <span class="s1">'Output Shape'</span><span class="p">,</span> <span class="s1">'Param #'</span><span class="p">))</span> |
| <span class="nb">print</span><span class="p">(</span><span class="s1">'='</span><span class="o">*</span><span class="mi">80</span><span class="p">)</span> |
| <span class="n">total_params</span> <span class="o">=</span> <span class="mi">0</span> |
| <span class="n">trainable_params</span> <span class="o">=</span> <span class="mi">0</span> |
| <span class="n">shared_params</span> <span class="o">=</span> <span class="mi">0</span> |
| <span class="k">for</span> <span class="n">layer</span> <span class="ow">in</span> <span class="n">summary</span><span class="p">:</span> |
| <span class="nb">print</span><span class="p">(</span><span class="n">line_format</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">layer</span><span class="p">,</span> |
| <span class="nb">str</span><span class="p">(</span><span class="n">summary</span><span class="p">[</span><span class="n">layer</span><span class="p">][</span><span class="s1">'output_shape'</span><span class="p">]),</span> |
| <span class="n">summary</span><span class="p">[</span><span class="n">layer</span><span class="p">][</span><span class="s1">'n_params'</span><span class="p">]))</span> |
| <span class="n">total_params</span> <span class="o">+=</span> <span class="n">summary</span><span class="p">[</span><span class="n">layer</span><span class="p">][</span><span class="s1">'n_params'</span><span class="p">]</span> |
| <span class="n">trainable_params</span> <span class="o">+=</span> <span class="n">summary</span><span class="p">[</span><span class="n">layer</span><span class="p">][</span><span class="s1">'trainable'</span><span class="p">]</span> |
| <span class="n">shared_params</span> <span class="o">+=</span> <span class="n">summary</span><span class="p">[</span><span class="n">layer</span><span class="p">][</span><span class="s1">'shared'</span><span class="p">]</span> |
| <span class="nb">print</span><span class="p">(</span><span class="s1">'='</span><span class="o">*</span><span class="mi">80</span><span class="p">)</span> |
| <span class="nb">print</span><span class="p">(</span><span class="s1">'Parameters in forward computation graph, duplicate included'</span><span class="p">)</span> |
| <span class="nb">print</span><span class="p">(</span><span class="s1">' Total params: '</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">total_params</span><span class="p">))</span> |
| <span class="nb">print</span><span class="p">(</span><span class="s1">' Trainable params: '</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">trainable_params</span><span class="p">))</span> |
| <span class="nb">print</span><span class="p">(</span><span class="s1">' Non-trainable params: '</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">total_params</span> <span class="o">-</span> <span class="n">trainable_params</span><span class="p">))</span> |
| <span class="nb">print</span><span class="p">(</span><span class="s1">'Shared params in forward computation graph: '</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">shared_params</span><span class="p">))</span> |
| <span class="nb">print</span><span class="p">(</span><span class="s1">'Unique parameters in model: '</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">total_params</span> <span class="o">-</span> <span class="n">shared_params</span><span class="p">))</span> |
| <span class="nb">print</span><span class="p">(</span><span class="s1">'-'</span><span class="o">*</span><span class="mi">80</span><span class="p">)</span> |
| <span class="k">finally</span><span class="p">:</span> |
| <span class="k">for</span> <span class="n">h</span> <span class="ow">in</span> <span class="n">hooks</span><span class="p">:</span> |
| <span class="n">h</span><span class="o">.</span><span class="n">detach</span><span class="p">()</span></div></div> |
| |
| |
| <span class="k">class</span> <span class="nc">HybridBlock</span><span class="p">(</span><span class="n">Block</span><span class="p">):</span> |
| <span class="sd">"""`HybridBlock` supports forwarding with both Symbol and NDArray.</span> |
| |
| <span class="sd"> `HybridBlock` is similar to `Block`, with a few differences::</span> |
| |
| <span class="sd"> import mxnet as mx</span> |
| <span class="sd"> from mxnet.gluon import HybridBlock, nn</span> |
| |
| <span class="sd"> class Model(HybridBlock):</span> |
| <span class="sd"> def __init__(self, **kwargs):</span> |
| <span class="sd"> super(Model, self).__init__(**kwargs)</span> |
| <span class="sd"> # use name_scope to give child Blocks appropriate names.</span> |
| <span class="sd"> with self.name_scope():</span> |
| <span class="sd"> self.dense0 = nn.Dense(20)</span> |
| <span class="sd"> self.dense1 = nn.Dense(20)</span> |
| |
| <span class="sd"> def hybrid_forward(self, F, x):</span> |
| <span class="sd"> x = F.relu(self.dense0(x))</span> |
| <span class="sd"> return F.relu(self.dense1(x))</span> |
| |
| <span class="sd"> model = Model()</span> |
| <span class="sd"> model.initialize(ctx=mx.cpu(0))</span> |
| <span class="sd"> model.hybridize()</span> |
| <span class="sd"> model(mx.nd.zeros((10, 10), ctx=mx.cpu(0)))</span> |
| |
| <span class="sd"> Forward computation in :py:class:`HybridBlock` must be static to work with :py:class:`Symbol` s,</span> |
| <span class="sd"> i.e. you cannot call :py:meth:`NDArray.asnumpy`, :py:attr:`NDArray.shape`,</span> |
| <span class="sd"> :py:attr:`NDArray.dtype`, `NDArray` indexing (`x[i]`) etc on tensors.</span> |
| <span class="sd"> Also, you cannot use branching or loop logic that bases on non-constant</span> |
| <span class="sd"> expressions like random numbers or intermediate results, since they change</span> |
| <span class="sd"> the graph structure for each iteration.</span> |
| |
| <span class="sd"> Before activating with :py:meth:`hybridize()`, :py:class:`HybridBlock` works just like normal</span> |
| <span class="sd"> :py:class:`Block`. After activation, :py:class:`HybridBlock` will create a symbolic graph</span> |
| <span class="sd"> representing the forward computation and cache it. On subsequent forwards,</span> |
| <span class="sd"> the cached graph will be used instead of :py:meth:`hybrid_forward`.</span> |
| |
| <span class="sd"> Please see references for detailed tutorial.</span> |
| |
| <span class="sd"> References</span> |
| <span class="sd"> ----------</span> |
| <span class="sd"> `Hybrid - Faster training and easy deployment</span> |
| <span class="sd"> <https://mxnet.io/tutorials/gluon/hybrid.html>`_</span> |
| <span class="sd"> """</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">prefix</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">params</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span> |
| <span class="nb">super</span><span class="p">(</span><span class="n">HybridBlock</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="n">prefix</span><span class="o">=</span><span class="n">prefix</span><span class="p">,</span> <span class="n">params</span><span class="o">=</span><span class="n">params</span><span class="p">)</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_cached_graph</span> <span class="o">=</span> <span class="p">()</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_cached_op</span> <span class="o">=</span> <span class="kc">None</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_cached_op_args</span> <span class="o">=</span> <span class="p">[]</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_out_format</span> <span class="o">=</span> <span class="kc">None</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_in_format</span> <span class="o">=</span> <span class="kc">None</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_active</span> <span class="o">=</span> <span class="kc">False</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_flags</span> <span class="o">=</span> <span class="p">[]</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_callback</span> <span class="o">=</span> <span class="kc">None</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_monitor_all</span> <span class="o">=</span> <span class="kc">False</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_backend</span> <span class="o">=</span> <span class="kc">None</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_backend_opts</span> <span class="o">=</span> <span class="p">{}</span> |
| |
| <span class="k">def</span> <span class="fm">__setattr__</span><span class="p">(</span><span class="bp">self</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="sd">"""Registers parameters."""</span> |
| <span class="nb">super</span><span class="p">(</span><span class="n">HybridBlock</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="fm">__setattr__</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="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="n">HybridBlock</span><span class="p">):</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_clear_cached_op</span><span class="p">()</span> |
| |
| <span class="k">def</span> <span class="nf">_get_graph</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">):</span> |
| <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">_cached_graph</span><span class="p">:</span> |
| <span class="n">flatten_args</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_in_format</span> <span class="o">=</span> <span class="n">_flatten</span><span class="p">(</span><span class="n">args</span><span class="p">,</span> <span class="s2">"input"</span><span class="p">)</span> |
| <span class="n">flatten_inputs</span> <span class="o">=</span> <span class="p">[]</span> |
| <span class="n">symbol_inputs</span> <span class="o">=</span> <span class="p">[]</span> |
| <span class="n">cnt</span> <span class="o">=</span> <span class="mi">0</span> |
| <span class="n">real_arg_num</span> <span class="o">=</span> <span class="nb">sum</span><span class="p">([</span><span class="n">ele</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span> <span class="k">for</span> <span class="n">ele</span> <span class="ow">in</span> <span class="n">flatten_args</span><span class="p">])</span> |
| <span class="k">if</span> <span class="n">real_arg_num</span> <span class="o">==</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="s1">'All args are None and we do not support such a case.'</span> |
| <span class="s1">' Received args=</span><span class="si">{}</span><span class="s1">'</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">args</span><span class="p">))</span> |
| <span class="k">for</span> <span class="n">arg</span> <span class="ow">in</span> <span class="n">flatten_args</span><span class="p">:</span> |
| <span class="k">if</span> <span class="n">arg</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="n">real_arg_num</span> <span class="o">></span> <span class="mi">1</span><span class="p">:</span> |
| <span class="n">arg_sym</span> <span class="o">=</span> <span class="n">symbol</span><span class="o">.</span><span class="n">var</span><span class="p">(</span><span class="s1">'data</span><span class="si">{}</span><span class="s1">'</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">cnt</span><span class="p">))</span> |
| <span class="k">else</span><span class="p">:</span> |
| <span class="n">arg_sym</span> <span class="o">=</span> <span class="n">symbol</span><span class="o">.</span><span class="n">var</span><span class="p">(</span><span class="s1">'data'</span><span class="p">)</span> |
| <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">arg</span><span class="p">,</span> <span class="n">_mx_np</span><span class="o">.</span><span class="n">ndarray</span><span class="p">):</span> |
| <span class="n">arg_sym</span> <span class="o">=</span> <span class="n">arg_sym</span><span class="o">.</span><span class="n">as_np_ndarray</span><span class="p">()</span> |
| <span class="n">cnt</span> <span class="o">+=</span> <span class="mi">1</span> |
| <span class="n">flatten_inputs</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">arg_sym</span><span class="p">)</span> |
| <span class="n">symbol_inputs</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">arg_sym</span><span class="p">)</span> |
| <span class="k">else</span><span class="p">:</span> |
| <span class="n">flatten_inputs</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="kc">None</span><span class="p">)</span> |
| <span class="n">grouped_inputs</span> <span class="o">=</span> <span class="n">_regroup</span><span class="p">(</span><span class="n">flatten_inputs</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_in_format</span><span class="p">)</span> |
| <span class="n">params</span> <span class="o">=</span> <span class="p">{</span><span class="n">i</span><span class="p">:</span> <span class="n">j</span><span class="o">.</span><span class="n">var</span><span class="p">()</span> <span class="k">for</span> <span class="n">i</span><span class="p">,</span> <span class="n">j</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_reg_params</span><span class="o">.</span><span class="n">items</span><span class="p">()}</span> |
| <span class="k">with</span> <span class="bp">self</span><span class="o">.</span><span class="n">name_scope</span><span class="p">():</span> |
| <span class="n">out</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">hybrid_forward</span><span class="p">(</span><span class="n">symbol</span><span class="p">,</span> <span class="o">*</span><span class="n">grouped_inputs</span><span class="p">,</span> <span class="o">**</span><span class="n">params</span><span class="p">)</span> <span class="c1"># pylint: disable=no-value-for-parameter</span> |
| <span class="n">out</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_out_format</span> <span class="o">=</span> <span class="n">_flatten</span><span class="p">(</span><span class="n">out</span><span class="p">,</span> <span class="s2">"output"</span><span class="p">)</span> |
| |
| <span class="bp">self</span><span class="o">.</span><span class="n">_cached_graph</span> <span class="o">=</span> <span class="n">symbol_inputs</span><span class="p">,</span> <span class="n">symbol</span><span class="o">.</span><span class="n">Group</span><span class="p">(</span><span class="n">out</span><span class="p">,</span> <span class="n">_check_same_symbol_type</span><span class="p">(</span><span class="n">out</span><span class="p">))</span> |
| |
| <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_cached_graph</span> |
| |
| <span class="k">def</span> <span class="nf">_build_cache</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">):</span> |
| <span class="n">data</span><span class="p">,</span> <span class="n">out</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_get_graph</span><span class="p">(</span><span class="o">*</span><span class="n">args</span><span class="p">)</span> |
| <span class="n">data_names</span> <span class="o">=</span> <span class="p">{</span><span class="n">data</span><span class="o">.</span><span class="n">name</span><span class="p">:</span> <span class="n">i</span> <span class="k">for</span> <span class="n">i</span><span class="p">,</span> <span class="n">data</span> <span class="ow">in</span> <span class="nb">enumerate</span><span class="p">(</span><span class="n">data</span><span class="p">)}</span> |
| <span class="n">input_names</span> <span class="o">=</span> <span class="n">out</span><span class="o">.</span><span class="n">list_inputs</span><span class="p">()</span> |
| <span class="n">expected_names</span> <span class="o">=</span> <span class="nb">set</span><span class="p">(</span><span class="n">input_names</span><span class="p">)</span> |
| |
| <span class="c1"># try to reuse cached_op_args for params</span> |
| <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_cached_op_args</span><span class="p">)</span> <span class="o">></span> <span class="mi">0</span><span class="p">:</span> |
| <span class="n">params</span> <span class="o">=</span> <span class="p">{</span><span class="n">param_tuple</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span><span class="o">.</span><span class="n">name</span><span class="p">:</span><span class="n">param_tuple</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span> |
| <span class="k">for</span> <span class="n">param_tuple</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_cached_op_args</span> |
| <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">param_tuple</span><span class="p">[</span><span class="mi">1</span><span class="p">],</span> <span class="n">Parameter</span><span class="p">)}</span> |
| <span class="k">else</span><span class="p">:</span> |
| <span class="n">params</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">collect_params</span><span class="p">()</span> |
| <span class="n">param_names</span> <span class="o">=</span> <span class="nb">set</span><span class="p">(</span><span class="n">params</span><span class="o">.</span><span class="n">keys</span><span class="p">())</span> |
| <span class="k">for</span> <span class="n">name</span> <span class="ow">in</span> <span class="n">expected_names</span><span class="p">:</span> |
| <span class="k">assert</span> <span class="n">name</span> <span class="ow">in</span> <span class="n">param_names</span> <span class="ow">or</span> <span class="n">name</span> <span class="ow">in</span> <span class="n">data_names</span><span class="p">,</span> \ |
| <span class="s2">"Unknown input to HybridBlock: </span><span class="si">%s</span><span class="s2">"</span> <span class="o">%</span><span class="n">name</span> |
| |
| <span class="n">used_data_names</span> <span class="o">=</span> <span class="p">[</span><span class="n">i</span> <span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="n">data_names</span> <span class="k">if</span> <span class="n">i</span> <span class="ow">in</span> <span class="n">expected_names</span><span class="p">]</span> |
| <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">used_data_names</span><span class="p">)</span> <span class="o">!=</span> <span class="nb">len</span><span class="p">(</span><span class="n">data_names</span><span class="p">):</span> |
| <span class="n">unused</span> <span class="o">=</span> <span class="s1">', '</span><span class="o">.</span><span class="n">join</span><span class="p">([</span><span class="s1">'</span><span class="si">%d</span><span class="s1">-th'</span><span class="o">%</span><span class="n">i</span> <span class="k">for</span> <span class="n">name</span><span class="p">,</span> <span class="n">i</span> <span class="ow">in</span> <span class="n">data_names</span><span class="o">.</span><span class="n">items</span><span class="p">()</span> |
| <span class="k">if</span> <span class="n">name</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">expected_names</span><span class="p">])</span> |
| <span class="n">warnings</span><span class="o">.</span><span class="n">warn</span><span class="p">(</span><span class="s2">"The </span><span class="si">%s</span><span class="s2"> input to HybridBlock is not used by any "</span> |
| <span class="s2">"computation. Is this intended?"</span><span class="o">%</span><span class="n">unused</span><span class="p">,</span> <span class="n">stacklevel</span><span class="o">=</span><span class="mi">4</span><span class="p">)</span> |
| |
| <span class="n">used_param_names</span> <span class="o">=</span> <span class="p">[</span><span class="n">i</span> <span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="n">param_names</span> <span class="k">if</span> <span class="n">i</span> <span class="ow">in</span> <span class="n">expected_names</span><span class="p">]</span> |
| <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">used_param_names</span><span class="p">)</span> <span class="o">!=</span> <span class="nb">len</span><span class="p">(</span><span class="n">param_names</span><span class="p">):</span> |
| <span class="n">unused</span> <span class="o">=</span> <span class="s1">', '</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="nb">list</span><span class="p">(</span><span class="n">param_names</span> <span class="o">-</span> <span class="nb">set</span><span class="p">(</span><span class="n">used_param_names</span><span class="p">)))</span> |
| <span class="n">warnings</span><span class="o">.</span><span class="n">warn</span><span class="p">(</span><span class="s2">"Parameter </span><span class="si">%s</span><span class="s2"> is not used by any computation. "</span> |
| <span class="s2">"Is this intended?"</span><span class="o">%</span><span class="n">unused</span><span class="p">,</span> <span class="n">stacklevel</span><span class="o">=</span><span class="mi">4</span><span class="p">)</span> |
| |
| <span class="n">args</span><span class="p">,</span> <span class="n">_</span> <span class="o">=</span> <span class="n">_flatten</span><span class="p">(</span><span class="n">args</span><span class="p">,</span> <span class="s2">"input"</span><span class="p">)</span> |
| <span class="k">try</span><span class="p">:</span> |
| <span class="k">for</span> <span class="n">name</span> <span class="ow">in</span> <span class="n">input_names</span><span class="p">:</span> |
| <span class="k">if</span> <span class="n">name</span> <span class="ow">in</span> <span class="n">params</span><span class="p">:</span> |
| <span class="n">params</span><span class="p">[</span><span class="n">name</span><span class="p">]</span><span class="o">.</span><span class="n">data</span><span class="p">()</span> |
| <span class="k">except</span> <span class="n">DeferredInitializationError</span><span class="p">:</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_deferred_infer_shape</span><span class="p">(</span><span class="o">*</span><span class="n">args</span><span class="p">)</span> |
| <span class="k">for</span> <span class="n">name</span> <span class="ow">in</span> <span class="n">input_names</span><span class="p">:</span> |
| <span class="k">if</span> <span class="n">name</span> <span class="ow">in</span> <span class="n">params</span><span class="p">:</span> |
| <span class="n">params</span><span class="p">[</span><span class="n">name</span><span class="p">]</span><span class="o">.</span><span class="n">_finish_deferred_init</span><span class="p">()</span> |
| |
| <span class="n">arg_dict</span><span class="p">,</span> <span class="n">aux_dict</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">(),</span> <span class="nb">dict</span><span class="p">()</span> |
| <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_backend</span><span class="p">:</span> |
| <span class="c1"># set context for inputs</span> |
| <span class="n">_</span><span class="p">,</span> <span class="n">_</span><span class="p">,</span> <span class="n">ctx_set</span><span class="p">,</span> <span class="n">_</span> <span class="o">=</span> <span class="n">_gather_type_ctx_info</span><span class="p">(</span><span class="nb">list</span><span class="p">(</span><span class="n">args</span><span class="p">))</span> |
| <span class="n">ctx</span> <span class="o">=</span> <span class="n">ctx_set</span><span class="o">.</span><span class="n">pop</span><span class="p">()</span> <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">ctx_set</span><span class="p">)</span> <span class="o">></span> <span class="mi">0</span> <span class="k">else</span> <span class="kc">None</span> |
| <span class="c1"># get list of params in the order of out.list_arguments</span> |
| <span class="n">input_shapes</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">()</span> |
| <span class="k">for</span> <span class="n">name</span> <span class="ow">in</span> <span class="n">out</span><span class="o">.</span><span class="n">list_arguments</span><span class="p">():</span> |
| <span class="k">if</span> <span class="n">name</span> <span class="ow">in</span> <span class="n">data_names</span><span class="o">.</span><span class="n">keys</span><span class="p">()</span> <span class="ow">and</span> <span class="n">data_names</span><span class="p">[</span><span class="n">name</span><span class="p">]</span> <span class="o"><</span> <span class="nb">len</span><span class="p">(</span><span class="n">args</span><span class="p">):</span> |
| <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">args</span><span class="p">[</span><span class="n">data_names</span><span class="p">[</span><span class="n">name</span><span class="p">]],</span> <span class="n">NDArray</span><span class="p">):</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">args</span><span class="p">[</span><span class="n">data_names</span><span class="p">[</span><span class="n">name</span><span class="p">]]</span> |
| <span class="k">elif</span> <span class="p">(</span><span class="nb">isinstance</span><span class="p">(</span><span class="n">args</span><span class="p">[</span><span class="n">data_names</span><span class="p">[</span><span class="n">name</span><span class="p">]],</span> <span class="n">symbol</span><span class="o">.</span><span class="n">Symbol</span><span class="p">)</span> <span class="ow">and</span> |
| <span class="s1">'__shape__'</span> <span class="ow">in</span> <span class="n">args</span><span class="p">[</span><span class="n">data_names</span><span class="p">[</span><span class="n">name</span><span class="p">]]</span><span class="o">.</span><span class="n">list_attr</span><span class="p">()):</span> |
| <span class="n">shape_str</span> <span class="o">=</span> <span class="n">args</span><span class="p">[</span><span class="n">data_names</span><span class="p">[</span><span class="n">name</span><span class="p">]]</span><span class="o">.</span><span class="n">list_attr</span><span class="p">()[</span><span class="s1">'__shape__'</span><span class="p">]</span> |
| <span class="n">input_shapes</span><span class="p">[</span><span class="n">name</span><span class="p">]</span> <span class="o">=</span> <span class="nb">tuple</span><span class="p">(</span><span class="nb">map</span><span class="p">(</span><span class="nb">int</span><span class="p">,</span> <span class="n">shape_str</span><span class="o">.</span><span class="n">strip</span><span class="p">(</span><span class="s1">'()'</span><span class="p">)</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s1">','</span><span class="p">)))</span> |
| <span class="k">elif</span> <span class="n">name</span> <span class="ow">in</span> <span class="n">params</span><span class="p">:</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">params</span><span class="p">[</span><span class="n">name</span><span class="p">]</span><span class="o">.</span><span class="n">data</span><span class="p">()</span> |
| |
| <span class="k">for</span> <span class="n">name</span> <span class="ow">in</span> <span class="n">out</span><span class="o">.</span><span class="n">list_auxiliary_states</span><span class="p">():</span> |
| <span class="k">if</span> <span class="n">name</span> <span class="ow">in</span> <span class="n">data_names</span><span class="o">.</span><span class="n">keys</span><span class="p">()</span> <span class="ow">and</span> <span class="n">data_names</span><span class="p">[</span><span class="n">name</span><span class="p">]</span> <span class="o"><</span> <span class="nb">len</span><span class="p">(</span><span class="n">args</span><span class="p">):</span> |
| <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">args</span><span class="p">[</span><span class="n">data_names</span><span class="p">[</span><span class="n">name</span><span class="p">]],</span> <span class="n">NDArray</span><span class="p">):</span> |
| <span class="n">aux_dict</span><span class="p">[</span><span class="n">name</span><span class="p">]</span> <span class="o">=</span> <span class="n">args</span><span class="p">[</span><span class="n">data_names</span><span class="p">[</span><span class="n">name</span><span class="p">]]</span> |
| <span class="k">elif</span> <span class="p">(</span><span class="nb">isinstance</span><span class="p">(</span><span class="n">args</span><span class="p">[</span><span class="n">data_names</span><span class="p">[</span><span class="n">name</span><span class="p">]],</span> <span class="n">symbol</span><span class="o">.</span><span class="n">Symbol</span><span class="p">)</span> <span class="ow">and</span> |
| <span class="s1">'__shape__'</span> <span class="ow">in</span> <span class="n">args</span><span class="p">[</span><span class="n">data_names</span><span class="p">[</span><span class="n">name</span><span class="p">]]</span><span class="o">.</span><span class="n">list_attr</span><span class="p">()):</span> |
| <span class="n">shape_str</span> <span class="o">=</span> <span class="n">args</span><span class="p">[</span><span class="n">data_names</span><span class="p">[</span><span class="n">name</span><span class="p">]]</span><span class="o">.</span><span class="n">list_attr</span><span class="p">()[</span><span class="s1">'__shape__'</span><span class="p">]</span> |
| <span class="n">input_shapes</span><span class="p">[</span><span class="n">name</span><span class="p">]</span> <span class="o">=</span> <span class="nb">tuple</span><span class="p">(</span><span class="nb">map</span><span class="p">(</span><span class="nb">int</span><span class="p">,</span> <span class="n">shape_str</span><span class="o">.</span><span class="n">strip</span><span class="p">(</span><span class="s1">'()'</span><span class="p">)</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s1">','</span><span class="p">)))</span> |
| <span class="k">elif</span> <span class="n">name</span> <span class="ow">in</span> <span class="n">params</span><span class="p">:</span> |
| <span class="n">aux_dict</span><span class="p">[</span><span class="n">name</span><span class="p">]</span> <span class="o">=</span> <span class="n">params</span><span class="p">[</span><span class="n">name</span><span class="p">]</span><span class="o">.</span><span class="n">data</span><span class="p">()</span> |
| |
| <span class="c1"># Partition the graph</span> |
| <span class="n">out</span> <span class="o">=</span> <span class="n">out</span><span class="o">.</span><span class="n">optimize_for</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_backend</span><span class="p">,</span> <span class="n">arg_dict</span><span class="p">,</span> <span class="n">aux_dict</span><span class="p">,</span> <span class="n">ctx</span><span class="p">,</span> <span class="n">input_shapes</span><span class="p">,</span> <span class="o">**</span><span class="bp">self</span><span class="o">.</span><span class="n">_backend_opts</span><span class="p">)</span> |
| |
| <span class="c1"># convert to numpy symbol if needed</span> |
| <span class="k">if</span> <span class="n">_mx_npx</span><span class="o">.</span><span class="n">is_np_array</span><span class="p">():</span> |
| <span class="n">out</span> <span class="o">=</span> <span class="n">out</span><span class="o">.</span><span class="n">as_np_ndarray</span><span class="p">()</span> |
| |
| <span class="c1">#update cached graph with partitioned graph</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_cached_graph</span> <span class="o">=</span> <span class="n">data</span><span class="p">,</span> <span class="n">out</span> |
| |
| <span class="n">input_names</span> <span class="o">=</span> <span class="n">out</span><span class="o">.</span><span class="n">list_inputs</span><span class="p">()</span> |
| <span class="n">data_indices</span> <span class="o">=</span> <span class="p">[]</span> |
| <span class="n">param_indices</span> <span class="o">=</span> <span class="p">[]</span> |
| |
| <span class="c1"># In the default case, _cached_ops_args contains all the parameters from params (the sets are identical)</span> |
| <span class="c1"># In the case of Partition API optimized graph _cached_ops_args might contain some parameters from params,</span> |
| <span class="c1"># might contain some new parameters created during optimization and added to `arg_dict/aux_dict`,</span> |
| <span class="c1"># and might not contain some parameters that were deleted during optimization.</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_cached_op_args</span> <span class="o">=</span> <span class="p">[]</span> |
| <span class="k">for</span> <span class="n">i</span><span class="p">,</span> <span class="n">name</span> <span class="ow">in</span> <span class="nb">enumerate</span><span class="p">(</span><span class="n">input_names</span><span class="p">):</span> |
| <span class="n">pair</span> <span class="o">=</span> <span class="kc">None</span> |
| <span class="k">if</span> <span class="n">name</span> <span class="ow">in</span> <span class="n">data_names</span><span class="p">:</span> |
| <span class="n">data_indices</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="n">pair</span> <span class="o">=</span> <span class="p">(</span><span class="kc">True</span><span class="p">,</span> <span class="n">data_names</span><span class="p">[</span><span class="n">name</span><span class="p">])</span> |
| <span class="k">else</span><span class="p">:</span> |
| <span class="n">param_indices</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">if</span> <span class="n">name</span> <span class="ow">in</span> <span class="n">params</span><span class="p">:</span> |
| <span class="n">param</span> <span class="o">=</span> <span class="n">params</span><span class="p">[</span><span class="n">name</span><span class="p">]</span> |
| <span class="k">else</span><span class="p">:</span> |
| <span class="c1"># The param is missing from the original params dictionary, which means the param must have</span> |
| <span class="c1"># been added by the Partition API backend</span> |
| <span class="k">if</span> <span class="n">name</span> <span class="ow">in</span> <span class="n">arg_dict</span> <span class="ow">or</span> <span class="n">name</span><span class="p">:</span> |
| <span class="n">param_data</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="k">elif</span> <span class="n">name</span> <span class="ow">in</span> <span class="n">aux_dict</span><span class="p">:</span> |
| <span class="n">param_data</span> <span class="o">=</span> <span class="n">aux_dict</span><span class="p">[</span><span class="n">name</span><span class="p">]</span> |
| <span class="k">else</span><span class="p">:</span> |
| <span class="k">raise</span> <span class="ne">RuntimeError</span><span class="p">(</span><span class="s1">'A parameter was added to the graph during optimization but it was not '</span> |
| <span class="s1">'added to the parameter dicts.</span><span class="se">\n</span><span class="s1">'</span> |
| <span class="s1">'Please check the backend.'</span><span class="p">)</span> |
| |
| <span class="n">param</span> <span class="o">=</span> <span class="n">Parameter</span><span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="n">dtype</span><span class="o">=</span><span class="n">param_data</span><span class="o">.</span><span class="n">dtype</span><span class="p">)</span> |
| <span class="n">param</span><span class="o">.</span><span class="n">_load_init</span><span class="p">(</span><span class="n">param_data</span><span class="p">,</span> <span class="n">param_data</span><span class="o">.</span><span class="n">context</span><span class="p">)</span> |
| <span class="n">pair</span> <span class="o">=</span> <span class="p">(</span><span class="kc">False</span><span class="p">,</span> <span class="n">param</span><span class="p">)</span> |
| |
| <span class="bp">self</span><span class="o">.</span><span class="n">_cached_op_args</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">pair</span><span class="p">)</span> |
| |
| <span class="n">flags</span> <span class="o">=</span> <span class="p">[(</span><span class="s1">'data_indices'</span><span class="p">,</span> <span class="n">data_indices</span><span class="p">),</span> <span class="p">(</span><span class="s1">'param_indices'</span><span class="p">,</span> <span class="n">param_indices</span><span class="p">)]</span> <span class="o">+</span> \ |
| <span class="bp">self</span><span class="o">.</span><span class="n">_flags</span> |
| |
| <span class="bp">self</span><span class="o">.</span><span class="n">_cached_op</span> <span class="o">=</span> <span class="n">ndarray</span><span class="o">.</span><span class="n">CachedOp</span><span class="p">(</span><span class="n">out</span><span class="p">,</span> <span class="n">flags</span><span class="p">)</span> |
| |
| |
| <span class="k">def</span> <span class="nf">_deferred_infer_shape</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">):</span> |
| <span class="k">try</span><span class="p">:</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">infer_shape</span><span class="p">(</span><span class="o">*</span><span class="n">args</span><span class="p">)</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">error_msg</span> <span class="o">=</span> <span class="s2">"Deferred initialization failed because shape"</span>\ |
| <span class="s2">" cannot be inferred. </span><span class="si">{}</span><span class="s2">"</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">e</span><span class="p">)</span> |
| <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="n">error_msg</span><span class="p">)</span> |
| |
| <span class="k">def</span> <span class="nf">_call_cached_op</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">):</span> |
| <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_cached_op</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_build_cache</span><span class="p">(</span><span class="o">*</span><span class="n">args</span><span class="p">)</span> |
| <span class="k">assert</span> <span class="bp">self</span><span class="o">.</span><span class="n">_cached_op</span><span class="p">,</span> <span class="s2">"Gluon failed to build the cache. "</span> \ |
| <span class="s2">"This should never happen. "</span> \ |
| <span class="s2">"Please submit an issue on Github"</span> \ |
| <span class="s2">" https://github.com/apache/incubator-mxnet."</span> |
| <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_callback</span><span class="p">:</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_cached_op</span><span class="o">.</span><span class="n">_register_op_hook</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_callback</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_monitor_all</span><span class="p">)</span> |
| <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_flags</span><span class="p">)</span> <span class="o">>=</span> <span class="mi">2</span> <span class="ow">and</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_flags</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span> <span class="ow">or</span> <span class="bp">self</span><span class="o">.</span><span class="n">_flags</span><span class="p">[</span><span class="mi">0</span><span class="p">]):</span> |
| <span class="n">warnings</span><span class="o">.</span><span class="n">warn</span><span class="p">(</span><span class="s2">"register_op_hook is experimental when static_alloc=True / static_shape=True "</span> |
| <span class="s2">" and may not work correctly"</span><span class="p">)</span> |
| |
| <span class="n">args</span><span class="p">,</span> <span class="n">fmt</span> <span class="o">=</span> <span class="n">_flatten</span><span class="p">(</span><span class="n">args</span><span class="p">,</span> <span class="s2">"input"</span><span class="p">)</span> |
| <span class="k">if</span> <span class="n">fmt</span> <span class="o">!=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_in_format</span><span class="p">:</span> |
| <span class="c1"># Do not raise in the case that the fmt or stored_fmt ends with None and</span> |
| <span class="c1"># We are relying on the default values.</span> |
| <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_in_format</span><span class="p">)</span> <span class="o">></span> <span class="nb">len</span><span class="p">(</span><span class="n">fmt</span><span class="p">):</span> |
| <span class="n">valid</span> <span class="o">=</span> <span class="nb">all</span><span class="p">([</span><span class="bp">self</span><span class="o">.</span><span class="n">_in_format</span><span class="p">[</span><span class="n">i</span><span class="p">]</span> <span class="o">==</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="nb">len</span><span class="p">(</span><span class="n">fmt</span><span class="p">),</span> <span class="nb">len</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_in_format</span><span class="p">))])</span> |
| <span class="n">valid</span> <span class="o">=</span> <span class="n">valid</span> <span class="ow">and</span> <span class="p">(</span><span class="n">fmt</span> <span class="o">==</span> <span class="bp">self</span><span class="o">.</span><span class="n">_in_format</span><span class="p">[:</span><span class="nb">len</span><span class="p">(</span><span class="n">fmt</span><span class="p">)])</span> |
| <span class="k">elif</span> <span class="nb">len</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_in_format</span><span class="p">)</span> <span class="o"><</span> <span class="nb">len</span><span class="p">(</span><span class="n">fmt</span><span class="p">):</span> |
| <span class="n">valid</span> <span class="o">=</span> <span class="nb">all</span><span class="p">([</span><span class="n">fmt</span><span class="p">[</span><span class="n">i</span><span class="p">]</span> <span class="o">==</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="nb">len</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_in_format</span><span class="p">),</span> <span class="nb">len</span><span class="p">(</span><span class="n">fmt</span><span class="p">))])</span> |
| <span class="n">valid</span> <span class="o">=</span> <span class="n">valid</span> <span class="ow">and</span> <span class="p">(</span><span class="n">fmt</span><span class="p">[:</span><span class="nb">len</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_in_format</span><span class="p">)]</span> <span class="o">==</span> <span class="bp">self</span><span class="o">.</span><span class="n">_in_format</span><span class="p">)</span> |
| <span class="k">else</span><span class="p">:</span> |
| <span class="n">valid</span> <span class="o">=</span> <span class="kc">False</span> |
| <span class="k">if</span> <span class="ow">not</span> <span class="n">valid</span><span class="p">:</span> |
| <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s2">"The argument structure of HybridBlock does not match"</span> |
| <span class="s2">" the cached version. Stored format = </span><span class="si">{}</span><span class="s2">, input format = </span><span class="si">{}</span><span class="s2">"</span> |
| <span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">fmt</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_in_format</span><span class="p">))</span> |
| |
| <span class="n">args_without_none</span> <span class="o">=</span> <span class="p">[</span><span class="n">ele</span> <span class="k">for</span> <span class="n">ele</span> <span class="ow">in</span> <span class="n">args</span> <span class="k">if</span> <span class="n">ele</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">]</span> |
| <span class="n">cargs</span> <span class="o">=</span> <span class="p">[</span><span class="n">args_without_none</span><span class="p">[</span><span class="n">i</span><span class="p">]</span> <span class="k">if</span> <span class="n">is_arg</span> <span class="k">else</span> <span class="n">i</span><span class="o">.</span><span class="n">data</span><span class="p">()</span> |
| <span class="k">for</span> <span class="n">is_arg</span><span class="p">,</span> <span class="n">i</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_cached_op_args</span><span class="p">]</span> |
| <span class="n">out</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_cached_op</span><span class="p">(</span><span class="o">*</span><span class="n">cargs</span><span class="p">)</span> |
| <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">out</span><span class="p">,</span> <span class="n">NDArray</span><span class="p">):</span> |
| <span class="n">out</span> <span class="o">=</span> <span class="p">[</span><span class="n">out</span><span class="p">]</span> |
| <span class="k">return</span> <span class="n">_regroup</span><span class="p">(</span><span class="n">out</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_out_format</span><span class="p">)</span> |
| |
| <span class="k">def</span> <span class="nf">optimize_for</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">x</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="n">backend</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">clear</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> |
| <span class="n">static_alloc</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> |
| <span class="n">static_shape</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> |
| <span class="n">inline_limit</span><span class="o">=</span><span class="mi">2</span><span class="p">,</span> |
| <span class="n">forward_bulk_size</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">backward_bulk_size</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span> |
| <span class="sd">"""Partitions the current HybridBlock and optimizes it for a given backend</span> |
| <span class="sd"> without executing a forward pass. Modifies the HybridBlock in-place.</span> |
| |
| <span class="sd"> Immediately partitions a HybridBlock using the specified backend. Combines</span> |
| <span class="sd"> the work done in the hybridize API with part of the work done in the forward</span> |
| <span class="sd"> pass without calling the CachedOp. Can be used in place of hybridize,</span> |
| <span class="sd"> afterwards `export` can be called or inference can be run. See README.md in</span> |
| <span class="sd"> example/extensions/lib_subgraph/README.md for more details.</span> |
| |
| <span class="sd"> Examples</span> |
| <span class="sd"> --------</span> |
| <span class="sd"> # partition and then export to file</span> |
| <span class="sd"> block.optimize_for(x, backend='myPart')</span> |
| <span class="sd"> block.export('partitioned')</span> |
| |
| <span class="sd"> # partition and then run inference</span> |
| <span class="sd"> block.optimize_for(x, backend='myPart')</span> |
| <span class="sd"> block(x)</span> |
| |
| <span class="sd"> Parameters</span> |
| <span class="sd"> ----------</span> |
| <span class="sd"> x : NDArray</span> |
| <span class="sd"> first input to model</span> |
| <span class="sd"> *args : NDArray</span> |
| <span class="sd"> other inputs to model</span> |
| <span class="sd"> backend : str</span> |
| <span class="sd"> The name of backend, as registered in `SubgraphBackendRegistry`, default None</span> |
| <span class="sd"> clear : bool, default False</span> |
| <span class="sd"> Clears any previous optimizations</span> |
| <span class="sd"> static_alloc : bool, default False</span> |
| <span class="sd"> Statically allocate memory to improve speed. Memory usage may increase.</span> |
| <span class="sd"> static_shape : bool, default False</span> |
| <span class="sd"> Optimize for invariant input shapes between iterations. Must also</span> |
| <span class="sd"> set static_alloc to True. Change of input shapes is still allowed</span> |
| <span class="sd"> but slower.</span> |
| <span class="sd"> inline_limit : optional int, default 2</span> |
| <span class="sd"> Maximum number of operators that can be inlined.</span> |
| <span class="sd"> forward_bulk_size : optional int, default None</span> |
| <span class="sd"> Segment size of bulk execution during forward pass.</span> |
| <span class="sd"> backward_bulk_size : optional int, default None</span> |
| <span class="sd"> Segment size of bulk execution during forward pass.</span> |
| <span class="sd"> **kwargs: The backend options, optional</span> |
| <span class="sd"> Passed on to `PrePartition` and `PostPartition` functions of `SubgraphProperty`</span> |
| <span class="sd"> """</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">></span> <span class="mi">0</span><span class="p">:</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_backend_opts</span> <span class="o">=</span> <span class="n">kwargs</span> |
| <span class="k">if</span> <span class="ow">not</span> <span class="n">backend</span><span class="p">:</span> |
| <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s1">'Must specify "backend" to optimize_for'</span><span class="p">)</span> |
| |
| <span class="bp">self</span><span class="o">.</span><span class="n">hybridize</span><span class="p">(</span><span class="kc">True</span><span class="p">,</span> <span class="n">backend</span><span class="p">,</span> <span class="n">clear</span><span class="p">,</span> <span class="n">static_alloc</span><span class="p">,</span> <span class="n">static_shape</span><span class="p">,</span> |
| <span class="n">inline_limit</span><span class="p">,</span> <span class="n">forward_bulk_size</span><span class="p">,</span> <span class="n">backward_bulk_size</span><span class="p">)</span> |
| |
| <span class="c1"># do part of forward API call</span> |
| <span class="n">has_symbol</span><span class="p">,</span> <span class="n">has_ndarray</span><span class="p">,</span> <span class="n">ctx_set</span><span class="p">,</span> <span class="n">_</span> <span class="o">=</span> <span class="n">_gather_type_ctx_info</span><span class="p">([</span><span class="n">x</span><span class="p">]</span> <span class="o">+</span> <span class="nb">list</span><span class="p">(</span><span class="n">args</span><span class="p">))</span> |
| <span class="k">if</span> <span class="ow">not</span> <span class="n">has_symbol</span> <span class="ow">and</span> <span class="ow">not</span> <span class="n">has_ndarray</span><span class="p">:</span> |
| <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s1">'In HybridBlock, there must be one NDArray or one Symbol in the input.'</span> |
| <span class="s1">' Please check the type of the args.</span><span class="se">\n</span><span class="s1">'</span><span class="p">)</span> |
| <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">ctx_set</span><span class="p">)</span> <span class="o">></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="s1">'Found multiple contexts in the input, '</span> |
| <span class="s1">'After hybridized, the HybridBlock only supports one input '</span> |
| <span class="s1">'context. You can print the ele.ctx in the '</span> |
| <span class="s1">'input arguments to inspect their contexts. '</span> |
| <span class="s1">'Find all contexts = </span><span class="si">{}</span><span class="s1">'</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">ctx_set</span><span class="p">))</span> |
| |
| <span class="bp">self</span><span class="o">.</span><span class="n">_build_cache</span><span class="p">(</span><span class="n">x</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">)</span> |
| <span class="k">assert</span> <span class="bp">self</span><span class="o">.</span><span class="n">_cached_op</span><span class="p">,</span> <span class="s2">"Gluon failed to build the cache. "</span> \ |
| <span class="s2">"This should never happen. "</span> \ |
| <span class="s2">"Please submit an issue on Github"</span> \ |
| <span class="s2">" https://github.com/apache/incubator-mxnet."</span> |
| <span class="c1"># do not actually call the cached_op</span> |
| |
| <span class="k">def</span> <span class="nf">_clear_cached_op</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_cached_graph</span> <span class="o">=</span> <span class="p">()</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_cached_op</span> <span class="o">=</span> <span class="kc">None</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_cached_op_args</span> <span class="o">=</span> <span class="p">[]</span> |
| |
| <span class="k">def</span> <span class="nf">register_child</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">block</span><span class="p">,</span> <span class="n">name</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span> |
| <span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">block</span><span class="p">,</span> <span class="n">HybridBlock</span><span class="p">):</span> |
| <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span> |
| <span class="s2">"Children of HybridBlock must also be HybridBlock, "</span> \ |
| <span class="s2">"but </span><span class="si">%s</span><span class="s2"> has type </span><span class="si">%s</span><span class="s2">. If you are using Sequential, "</span> \ |
| <span class="s2">"please try HybridSequential instead."</span><span class="o">%</span><span class="p">(</span> |
| <span class="nb">str</span><span class="p">(</span><span class="n">block</span><span class="p">),</span> <span class="nb">str</span><span class="p">(</span><span class="nb">type</span><span class="p">(</span><span class="n">block</span><span class="p">))))</span> |
| <span class="nb">super</span><span class="p">(</span><span class="n">HybridBlock</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="n">register_child</span><span class="p">(</span><span class="n">block</span><span class="p">,</span> <span class="n">name</span><span class="p">)</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_clear_cached_op</span><span class="p">()</span> |
| |
| <span class="k">def</span> <span class="nf">hybridize</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">active</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">backend</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">clear</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> |
| <span class="n">static_alloc</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">static_shape</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> |
| <span class="n">inline_limit</span><span class="o">=</span><span class="mi">2</span><span class="p">,</span> |
| <span class="n">forward_bulk_size</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">backward_bulk_size</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span> |
| <span class="sd">"""Activates or deactivates :py:class:`HybridBlock` s recursively. Has no effect on</span> |
| <span class="sd"> non-hybrid children.</span> |
| |
| <span class="sd"> Parameters</span> |
| <span class="sd"> ----------</span> |
| <span class="sd"> active : bool, default True</span> |
| <span class="sd"> Whether to turn hybrid on or off.</span> |
| <span class="sd"> backend : str</span> |
| <span class="sd"> The name of backend, as registered in `SubgraphBackendRegistry`, default None</span> |
| <span class="sd"> clear : bool, default True</span> |
| <span class="sd"> Clears any previous optimizations</span> |
| <span class="sd"> static_alloc : optional bool, default False</span> |
| <span class="sd"> Statically allocate memory to improve speed. Memory usage may increase.</span> |
| <span class="sd"> static_shape : optional bool, default False</span> |
| <span class="sd"> Optimize for invariant input shapes between iterations. Must also</span> |
| <span class="sd"> set static_alloc to True. Change of input shapes is still allowed</span> |
| <span class="sd"> but slower.</span> |
| <span class="sd"> inline_limit : optional int, default 2</span> |
| <span class="sd"> Maximum number of operators that can be inlined.</span> |
| <span class="sd"> forward_bulk_size : optional int, default None</span> |
| <span class="sd"> Segment size of bulk execution during forward pass.</span> |
| <span class="sd"> backward_bulk_size : optional int, default None</span> |
| <span class="sd"> Segment size of bulk execution during forward pass.</span> |
| <span class="sd"> **kwargs: optional</span> |
| <span class="sd"> Backend options.</span> |
| <span class="sd"> """</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">></span> <span class="mi">0</span><span class="p">:</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_backend_opts</span> <span class="o">=</span> <span class="n">kwargs</span> |
| |
| <span class="bp">self</span><span class="o">.</span><span class="n">_backend</span> <span class="o">=</span> <span class="n">backend</span> |
| |
| <span class="bp">self</span><span class="o">.</span><span class="n">_active</span> <span class="o">=</span> <span class="n">active</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_flags</span> <span class="o">=</span> <span class="p">[(</span><span class="s2">"static_alloc"</span><span class="p">,</span> <span class="n">static_alloc</span><span class="p">),</span> <span class="p">(</span><span class="s2">"static_shape"</span><span class="p">,</span> <span class="n">static_shape</span><span class="p">),</span> |
| <span class="p">(</span><span class="s2">"inline_limit"</span><span class="p">,</span> <span class="n">inline_limit</span><span class="p">)]</span> |
| <span class="k">if</span> <span class="n">forward_bulk_size</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_flags</span><span class="o">.</span><span class="n">append</span><span class="p">((</span><span class="s2">"forward_bulk_size"</span><span class="p">,</span> <span class="n">forward_bulk_size</span><span class="p">))</span> |
| <span class="k">if</span> <span class="n">backward_bulk_size</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_flags</span><span class="o">.</span><span class="n">append</span><span class="p">((</span><span class="s2">"backward_bulk_size"</span><span class="p">,</span> <span class="n">backward_bulk_size</span><span class="p">))</span> |
| <span class="k">if</span> <span class="n">clear</span><span class="p">:</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_clear_cached_op</span><span class="p">()</span> |
| <span class="k">if</span> <span class="n">active</span> <span class="ow">and</span> <span class="bp">self</span><span class="o">.</span><span class="n">_forward_hooks</span> <span class="ow">or</span> <span class="bp">self</span><span class="o">.</span><span class="n">_forward_pre_hooks</span><span class="p">:</span> |
| <span class="n">warnings</span><span class="o">.</span><span class="n">warn</span><span class="p">(</span><span class="s1">'"</span><span class="si">{block}</span><span class="s1">" is being hybridized while still having forward hook/pre-hook. '</span> |
| <span class="s1">'If "</span><span class="si">{block}</span><span class="s1">" is a child of HybridBlock, the hooks will not take effect.'</span> |
| <span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">block</span><span class="o">=</span><span class="bp">self</span><span class="p">))</span> |
| <span class="nb">super</span><span class="p">(</span><span class="n">HybridBlock</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="n">hybridize</span><span class="p">(</span><span class="n">active</span><span class="p">,</span> |
| <span class="n">static_alloc</span><span class="o">=</span><span class="n">static_alloc</span><span class="p">,</span> |
| <span class="n">static_shape</span><span class="o">=</span><span class="n">static_shape</span><span class="p">,</span> |
| <span class="n">inline_limit</span><span class="o">=</span><span class="n">inline_limit</span><span class="p">,</span> |
| <span class="n">forward_bulk_size</span><span class="o">=</span><span class="n">forward_bulk_size</span><span class="p">,</span> |
| <span class="n">backward_bulk_size</span><span class="o">=</span><span class="n">backward_bulk_size</span><span class="p">)</span> |
| |
| <span class="k">def</span> <span class="nf">cast</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">dtype</span><span class="p">):</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_clear_cached_op</span><span class="p">()</span> |
| <span class="nb">super</span><span class="p">(</span><span class="n">HybridBlock</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="n">cast</span><span class="p">(</span><span class="n">dtype</span><span class="p">)</span> |
| |
| <span class="k">def</span> <span class="nf">_infer_attrs</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">infer_fn</span><span class="p">,</span> <span class="n">attr</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">):</span> |
| <span class="sd">"""Generic infer attributes."""</span> |
| <span class="n">inputs</span><span class="p">,</span> <span class="n">out</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_get_graph</span><span class="p">(</span><span class="o">*</span><span class="n">args</span><span class="p">)</span> |
| <span class="n">args</span><span class="p">,</span> <span class="n">_</span> <span class="o">=</span> <span class="n">_flatten</span><span class="p">(</span><span class="n">args</span><span class="p">,</span> <span class="s2">"input"</span><span class="p">)</span> |
| <span class="n">args_without_none</span> <span class="o">=</span> <span class="p">[</span><span class="n">ele</span> <span class="k">for</span> <span class="n">ele</span> <span class="ow">in</span> <span class="n">args</span> <span class="k">if</span> <span class="n">ele</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">]</span> |
| <span class="k">with</span> <span class="n">warnings</span><span class="o">.</span><span class="n">catch_warnings</span><span class="p">(</span><span class="n">record</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span> <span class="k">as</span> <span class="n">w</span><span class="p">:</span> |
| <span class="n">arg_attrs</span><span class="p">,</span> <span class="n">_</span><span class="p">,</span> <span class="n">aux_attrs</span> <span class="o">=</span> <span class="nb">getattr</span><span class="p">(</span><span class="n">out</span><span class="p">,</span> <span class="n">infer_fn</span><span class="p">)(</span> |
| <span class="o">**</span><span class="p">{</span><span class="n">i</span><span class="o">.</span><span class="n">name</span><span class="p">:</span> <span class="nb">getattr</span><span class="p">(</span><span class="n">j</span><span class="p">,</span> <span class="n">attr</span><span class="p">)</span> <span class="k">for</span> <span class="n">i</span><span class="p">,</span> <span class="n">j</span> <span class="ow">in</span> <span class="nb">zip</span><span class="p">(</span><span class="n">inputs</span><span class="p">,</span> <span class="n">args_without_none</span><span class="p">)})</span> |
| <span class="k">if</span> <span class="n">arg_attrs</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span> |
| <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="n">w</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span><span class="o">.</span><span class="n">message</span><span class="p">)</span> |
| <span class="n">sdict</span> <span class="o">=</span> <span class="p">{</span><span class="n">i</span><span class="p">:</span> <span class="n">j</span> <span class="k">for</span> <span class="n">i</span><span class="p">,</span> <span class="n">j</span> <span class="ow">in</span> <span class="nb">zip</span><span class="p">(</span><span class="n">out</span><span class="o">.</span><span class="n">list_arguments</span><span class="p">(),</span> <span class="n">arg_attrs</span><span class="p">)}</span> |
| <span class="n">sdict</span><span class="o">.</span><span class="n">update</span><span class="p">({</span><span class="n">name</span> <span class="p">:</span> <span class="n">attr</span> <span class="k">for</span> <span class="n">name</span><span class="p">,</span> <span class="n">attr</span> <span class="ow">in</span> \ |
| <span class="nb">zip</span><span class="p">(</span><span class="n">out</span><span class="o">.</span><span class="n">list_auxiliary_states</span><span class="p">(),</span> <span class="n">aux_attrs</span><span class="p">)})</span> |
| <span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">collect_params</span><span class="p">()</span><span class="o">.</span><span class="n">values</span><span class="p">():</span> |
| <span class="nb">setattr</span><span class="p">(</span><span class="n">i</span><span class="p">,</span> <span class="n">attr</span><span class="p">,</span> <span class="n">sdict</span><span class="p">[</span><span class="n">i</span><span class="o">.</span><span class="n">name</span><span class="p">])</span> |
| |
| <span class="k">def</span> <span class="nf">infer_shape</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">):</span> |
| <span class="sd">"""Infers shape of Parameters from inputs."""</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_infer_attrs</span><span class="p">(</span><span class="s1">'infer_shape'</span><span class="p">,</span> <span class="s1">'shape'</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">)</span> |
| |
| <span class="k">def</span> <span class="nf">infer_type</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">):</span> |
| <span class="sd">"""Infers data type of Parameters from inputs."""</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_infer_attrs</span><span class="p">(</span><span class="s1">'infer_type'</span><span class="p">,</span> <span class="s1">'dtype'</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">)</span> |
| |
| <span class="k">def</span> <span class="nf">export</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">path</span><span class="p">,</span> <span class="n">epoch</span><span class="o">=</span><span class="mi">0</span><span class="p">,</span> <span class="n">remove_amp_cast</span><span class="o">=</span><span class="kc">True</span><span class="p">):</span> |
| <span class="sd">"""Export HybridBlock to json format that can be loaded by</span> |
| <span class="sd"> `gluon.SymbolBlock.imports`, `mxnet.mod.Module` or the C++ interface.</span> |
| |
| <span class="sd"> .. note:: When there are only one input, it will have name `data`. When there</span> |
| <span class="sd"> Are more than one inputs, they will be named as `data0`, `data1`, etc.</span> |
| |
| <span class="sd"> Parameters</span> |
| <span class="sd"> ----------</span> |
| <span class="sd"> path : str</span> |
| <span class="sd"> Path to save model. Two files `path-symbol.json` and `path-xxxx.params`</span> |
| <span class="sd"> will be created, where xxxx is the 4 digits epoch number.</span> |
| <span class="sd"> epoch : int</span> |
| <span class="sd"> Epoch number of saved model.</span> |
| <span class="sd"> """</span> |
| <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">_cached_graph</span><span class="p">:</span> |
| <span class="k">raise</span> <span class="ne">RuntimeError</span><span class="p">(</span> |
| <span class="s2">"Please first call block.hybridize() and then run forward with "</span> |
| <span class="s2">"this block at least once before calling export."</span><span class="p">)</span> |
| <span class="n">sym</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_cached_graph</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span> |
| <span class="n">sym</span><span class="o">.</span><span class="n">save</span><span class="p">(</span><span class="s1">'</span><span class="si">%s</span><span class="s1">-symbol.json'</span><span class="o">%</span><span class="n">path</span><span class="p">,</span> <span class="n">remove_amp_cast</span><span class="o">=</span><span class="n">remove_amp_cast</span><span class="p">)</span> |
| |
| <span class="n">arg_names</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="n">aux_names</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="n">arg_dict</span> <span class="o">=</span> <span class="p">{}</span> |
| <span class="k">for</span> <span class="n">is_arg</span><span class="p">,</span> <span class="n">param</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_cached_op_args</span><span class="p">:</span> |
| <span class="k">if</span> <span class="ow">not</span> <span class="n">is_arg</span><span class="p">:</span> |
| <span class="n">name</span> <span class="o">=</span> <span class="n">param</span><span class="o">.</span><span class="n">name</span> |
| <span class="k">if</span> <span class="n">name</span> <span class="ow">in</span> <span class="n">arg_names</span><span class="p">:</span> |
| <span class="n">arg_dict</span><span class="p">[</span><span class="s1">'arg:</span><span class="si">{}</span><span class="s1">'</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="o">=</span> <span class="n">param</span><span class="o">.</span><span class="n">_reduce</span><span class="p">()</span> |
| <span class="k">else</span><span class="p">:</span> |
| <span class="k">if</span> <span class="n">name</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">aux_names</span><span class="p">:</span> |
| <span class="n">warnings</span><span class="o">.</span><span class="n">warn</span><span class="p">(</span><span class="s1">'Parameter "</span><span class="si">{name}</span><span class="s1">" is not found in the graph. '</span> |
| <span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="n">name</span><span class="p">),</span> <span class="n">stacklevel</span><span class="o">=</span><span class="mi">3</span><span class="p">)</span> |
| <span class="k">else</span><span class="p">:</span> |
| <span class="n">arg_dict</span><span class="p">[</span><span class="s1">'aux:</span><span class="si">%s</span><span class="s1">'</span><span class="o">%</span><span class="n">name</span><span class="p">]</span> <span class="o">=</span> <span class="n">param</span><span class="o">.</span><span class="n">_reduce</span><span class="p">()</span> |
| <span class="n">save_fn</span> <span class="o">=</span> <span class="n">_mx_npx</span><span class="o">.</span><span class="n">save</span> <span class="k">if</span> <span class="n">is_np_array</span><span class="p">()</span> <span class="k">else</span> <span class="n">ndarray</span><span class="o">.</span><span class="n">save</span> |
| <span class="n">save_fn</span><span class="p">(</span><span class="s1">'</span><span class="si">%s</span><span class="s1">-</span><span class="si">%04d</span><span class="s1">.params'</span><span class="o">%</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="n">epoch</span><span class="p">),</span> <span class="n">arg_dict</span><span class="p">)</span> |
| |
| <span class="k">def</span> <span class="nf">register_op_hook</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">callback</span><span class="p">,</span> <span class="n">monitor_all</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span> |
| <span class="sd">"""Install op hook for block recursively.</span> |
| |
| <span class="sd"> Parameters</span> |
| <span class="sd"> ----------</span> |
| <span class="sd"> callback : function</span> |
| <span class="sd"> Takes a string and a NDArrayHandle.</span> |
| <span class="sd"> monitor_all : bool, default False</span> |
| <span class="sd"> If true, monitor both input and output, otherwise monitor output only.</span> |
| <span class="sd"> """</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_callback</span> <span class="o">=</span> <span class="n">callback</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_monitor_all</span> <span class="o">=</span> <span class="n">monitor_all</span> |
| <span class="k">for</span> <span class="n">cld</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_children</span><span class="o">.</span><span class="n">values</span><span class="p">():</span> |
| <span class="n">cld</span><span class="o">.</span><span class="n">_callback</span> <span class="o">=</span> <span class="n">callback</span> |
| <span class="n">cld</span><span class="o">.</span><span class="n">_monitor_all</span> <span class="o">=</span> <span class="n">monitor_all</span> |
| |
| <span class="k">def</span> <span class="nf">forward</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">x</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">):</span> |
| <span class="sd">"""Defines the forward computation. Arguments can be either</span> |
| <span class="sd"> :py:class:`NDArray` or :py:class:`Symbol`."""</span> |
| |
| <span class="n">has_symbol</span><span class="p">,</span> <span class="n">has_ndarray</span><span class="p">,</span> <span class="n">ctx_set</span><span class="p">,</span> <span class="n">first_ctx</span> <span class="o">=</span> <span class="n">_gather_type_ctx_info</span><span class="p">([</span><span class="n">x</span><span class="p">]</span> <span class="o">+</span> <span class="nb">list</span><span class="p">(</span><span class="n">args</span><span class="p">))</span> |
| <span class="k">if</span> <span class="n">has_symbol</span> <span class="ow">and</span> <span class="n">has_ndarray</span><span class="p">:</span> |
| <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s1">'In HybridBlock, we do not support mixed NDArrays and Symbols'</span> |
| <span class="s1">' types for the input. Please check the type of the args.</span><span class="se">\n</span><span class="s1">'</span><span class="p">)</span> |
| <span class="k">if</span> <span class="ow">not</span> <span class="n">has_symbol</span> <span class="ow">and</span> <span class="ow">not</span> <span class="n">has_ndarray</span><span class="p">:</span> |
| <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s1">'In HybridBlock, there must be one NDArray or one Symbol in the input.'</span> |
| <span class="s1">' Please check the type of the args.</span><span class="se">\n</span><span class="s1">'</span><span class="p">)</span> |
| <span class="k">if</span> <span class="n">has_ndarray</span><span class="p">:</span> |
| <span class="n">ctx</span> <span class="o">=</span> <span class="n">first_ctx</span> |
| <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_active</span><span class="p">:</span> |
| <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">ctx_set</span><span class="p">)</span> <span class="o">></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="s1">'Find multiple contexts in the input, '</span> |
| <span class="s1">'After hybridized, the HybridBlock only supports one input '</span> |
| <span class="s1">'context. You can print the ele.ctx in the '</span> |
| <span class="s1">'input arguments to inspect their contexts. '</span> |
| <span class="s1">'Find all contexts = </span><span class="si">{}</span><span class="s1">'</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">ctx_set</span><span class="p">))</span> |
| <span class="k">with</span> <span class="n">ctx</span><span class="p">:</span> |
| <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_call_cached_op</span><span class="p">(</span><span class="n">x</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">)</span> |
| <span class="k">with</span> <span class="n">ctx</span><span class="p">:</span> |
| <span class="k">try</span><span class="p">:</span> |
| <span class="n">params</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="n">ctx</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="bp">self</span><span class="o">.</span><span class="n">_reg_params</span><span class="o">.</span><span class="n">items</span><span class="p">()}</span> |
| <span class="k">except</span> <span class="n">DeferredInitializationError</span><span class="p">:</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_deferred_infer_shape</span><span class="p">(</span><span class="n">x</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">)</span> |
| <span class="k">for</span> <span class="n">_</span><span class="p">,</span> <span class="n">v</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">params</span><span class="o">.</span><span class="n">items</span><span class="p">():</span> |
| <span class="n">v</span><span class="o">.</span><span class="n">_finish_deferred_init</span><span class="p">()</span> |
| <span class="n">params</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="n">ctx</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="bp">self</span><span class="o">.</span><span class="n">_reg_params</span><span class="o">.</span><span class="n">items</span><span class="p">()}</span> |
| |
| <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">hybrid_forward</span><span class="p">(</span><span class="n">ndarray</span><span class="p">,</span> <span class="n">x</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">params</span><span class="p">)</span> |
| <span class="n">params</span> <span class="o">=</span> <span class="p">{</span><span class="n">i</span><span class="p">:</span> <span class="n">j</span><span class="o">.</span><span class="n">var</span><span class="p">()</span> <span class="k">for</span> <span class="n">i</span><span class="p">,</span> <span class="n">j</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_reg_params</span><span class="o">.</span><span class="n">items</span><span class="p">()}</span> |
| <span class="k">with</span> <span class="bp">self</span><span class="o">.</span><span class="n">name_scope</span><span class="p">():</span> |
| <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">hybrid_forward</span><span class="p">(</span><span class="n">symbol</span><span class="p">,</span> <span class="n">x</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">params</span><span class="p">)</span> |
| |
| <span class="k">def</span> <span class="nf">hybrid_forward</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">F</span><span class="p">,</span> <span class="n">x</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="sd">"""Overrides to construct symbolic graph for this `Block`.</span> |
| |
| <span class="sd"> Parameters</span> |
| <span class="sd"> ----------</span> |
| <span class="sd"> x : Symbol or NDArray</span> |
| <span class="sd"> The first input tensor.</span> |
| <span class="sd"> *args : list of Symbol or list of NDArray</span> |
| <span class="sd"> Additional input tensors.</span> |
| <span class="sd"> """</span> |
| <span class="c1"># pylint: disable= invalid-name</span> |
| <span class="k">raise</span> <span class="ne">NotImplementedError</span> |
| |
| <span class="k">def</span> <span class="nf">_common_prefix</span><span class="p">(</span><span class="n">names</span><span class="p">):</span> |
| <span class="sd">"""Get the common prefix for all names"""</span> |
| <span class="k">if</span> <span class="ow">not</span> <span class="n">names</span><span class="p">:</span> |
| <span class="k">return</span> <span class="s1">''</span> |
| <span class="n">prefix</span> <span class="o">=</span> <span class="n">names</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> |
| <span class="k">for</span> <span class="n">name</span> <span class="ow">in</span> <span class="n">names</span><span class="p">:</span> |
| <span class="n">i</span> <span class="o">=</span> <span class="mi">0</span> |
| <span class="k">while</span> <span class="n">i</span> <span class="o"><</span> <span class="nb">len</span><span class="p">(</span><span class="n">prefix</span><span class="p">)</span> <span class="ow">and</span> <span class="n">i</span> <span class="o"><</span> <span class="nb">len</span><span class="p">(</span><span class="n">name</span><span class="p">)</span> <span class="ow">and</span> <span class="n">prefix</span><span class="p">[</span><span class="n">i</span><span class="p">]</span> <span class="o">==</span> <span class="n">name</span><span class="p">[</span><span class="n">i</span><span class="p">]:</span> |
| <span class="n">i</span> <span class="o">+=</span> <span class="mi">1</span> |
| <span class="n">prefix</span> <span class="o">=</span> <span class="n">prefix</span><span class="p">[:</span><span class="n">i</span><span class="p">]</span> |
| <span class="k">return</span> <span class="n">prefix</span> |
| |
| |
| <span class="k">class</span> <span class="nc">SymbolBlock</span><span class="p">(</span><span class="n">HybridBlock</span><span class="p">):</span> |
| <span class="sd">"""Construct block from symbol. This is useful for using pre-trained models</span> |
| <span class="sd"> as feature extractors. For example, you may want to extract the output</span> |
| <span class="sd"> from fc2 layer in AlexNet.</span> |
| |
| <span class="sd"> Parameters</span> |
| <span class="sd"> ----------</span> |
| <span class="sd"> outputs : Symbol or list of Symbol</span> |
| <span class="sd"> The desired output for SymbolBlock.</span> |
| <span class="sd"> inputs : Symbol or list of Symbol</span> |
| <span class="sd"> The Variables in output's argument that should be used as inputs.</span> |
| <span class="sd"> params : ParameterDict</span> |
| <span class="sd"> Parameter dictionary for arguments and auxililary states of outputs</span> |
| <span class="sd"> that are not inputs.</span> |
| |
| <span class="sd"> Examples</span> |
| <span class="sd"> --------</span> |
| <span class="sd"> >>> # To extract the feature from fc1 and fc2 layers of AlexNet:</span> |
| <span class="sd"> >>> alexnet = gluon.model_zoo.vision.alexnet(pretrained=True, ctx=mx.cpu(),</span> |
| <span class="sd"> prefix='model_')</span> |
| <span class="sd"> >>> inputs = mx.sym.var('data')</span> |
| <span class="sd"> >>> out = alexnet(inputs)</span> |
| <span class="sd"> >>> internals = out.get_internals()</span> |
| <span class="sd"> >>> print(internals.list_outputs())</span> |
| <span class="sd"> ['data', ..., 'model_dense0_relu_fwd_output', ..., 'model_dense1_relu_fwd_output', ...]</span> |
| <span class="sd"> >>> outputs = [internals['model_dense0_relu_fwd_output'],</span> |
| <span class="sd"> internals['model_dense1_relu_fwd_output']]</span> |
| <span class="sd"> >>> # Create SymbolBlock that shares parameters with alexnet</span> |
| <span class="sd"> >>> feat_model = gluon.SymbolBlock(outputs, inputs, params=alexnet.collect_params())</span> |
| <span class="sd"> >>> x = mx.nd.random.normal(shape=(16, 3, 224, 224))</span> |
| <span class="sd"> >>> print(feat_model(x))</span> |
| <span class="sd"> """</span> |
| <span class="nd">@staticmethod</span> |
| <span class="k">def</span> <span class="nf">imports</span><span class="p">(</span><span class="n">symbol_file</span><span class="p">,</span> <span class="n">input_names</span><span class="p">,</span> <span class="n">param_file</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">allow_missing</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> |
| <span class="n">ignore_extra</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span> |
| <span class="sd">"""Import model previously saved by `gluon.HybridBlock.export` or</span> |
| <span class="sd"> `Module.save_checkpoint` as a `gluon.SymbolBlock` for use in Gluon.</span> |
| |
| <span class="sd"> Parameters</span> |
| <span class="sd"> ----------</span> |
| <span class="sd"> symbol_file : str</span> |
| <span class="sd"> Path to symbol file.</span> |
| <span class="sd"> input_names : list of str</span> |
| <span class="sd"> List of input variable names</span> |
| <span class="sd"> param_file : str, optional</span> |
| <span class="sd"> Path to parameter file.</span> |
| <span class="sd"> ctx : Context, default None</span> |
| <span class="sd"> The context to initialize `gluon.SymbolBlock` on.</span> |
| <span class="sd"> allow_missing : bool, default False</span> |
| <span class="sd"> Whether to silently skip loading parameters not represents in the file.</span> |
| <span class="sd"> ignore_extra : bool, default False</span> |
| <span class="sd"> Whether to silently ignore parameters from the file that are not</span> |
| <span class="sd"> present in this Block.</span> |
| |
| <span class="sd"> Returns</span> |
| <span class="sd"> -------</span> |
| <span class="sd"> gluon.SymbolBlock</span> |
| <span class="sd"> `gluon.SymbolBlock` loaded from symbol and parameter files.</span> |
| |
| <span class="sd"> Examples</span> |
| <span class="sd"> --------</span> |
| <span class="sd"> >>> net1 = gluon.model_zoo.vision.resnet18_v1(</span> |
| <span class="sd"> ... prefix='resnet', pretrained=True)</span> |
| <span class="sd"> >>> net1.hybridize()</span> |
| <span class="sd"> >>> x = mx.nd.random.normal(shape=(1, 3, 32, 32))</span> |
| <span class="sd"> >>> out1 = net1(x)</span> |
| <span class="sd"> >>> net1.export('net1', epoch=1)</span> |
| <span class="sd"> >>></span> |
| <span class="sd"> >>> net2 = gluon.SymbolBlock.imports(</span> |
| <span class="sd"> ... 'net1-symbol.json', ['data'], 'net1-0001.params')</span> |
| <span class="sd"> >>> out2 = net2(x)</span> |
| <span class="sd"> """</span> |
| <span class="k">if</span> <span class="n">is_np_array</span><span class="p">():</span> |
| <span class="n">sym</span> <span class="o">=</span> <span class="n">np_symbol</span><span class="o">.</span><span class="n">load</span><span class="p">(</span><span class="n">symbol_file</span><span class="p">)</span> |
| <span class="k">else</span><span class="p">:</span> |
| <span class="n">sym</span> <span class="o">=</span> <span class="n">symbol</span><span class="o">.</span><span class="n">load</span><span class="p">(</span><span class="n">symbol_file</span><span class="p">)</span> |
| <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">input_names</span><span class="p">,</span> <span class="nb">str</span><span class="p">):</span> |
| <span class="n">input_names</span> <span class="o">=</span> <span class="p">[</span><span class="n">input_names</span><span class="p">]</span> |
| <span class="k">if</span> <span class="n">param_file</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span> |
| <span class="c1"># Get a valid type inference by using fp32</span> |
| <span class="n">inputs</span> <span class="o">=</span> <span class="p">[</span><span class="n">symbol</span><span class="o">.</span><span class="n">var</span><span class="p">(</span><span class="n">i</span><span class="p">,</span> <span class="n">dtype</span><span class="o">=</span><span class="n">mx_real_t</span><span class="p">)</span> <span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="n">input_names</span><span class="p">]</span> |
| <span class="k">else</span><span class="p">:</span> |
| <span class="c1"># Do not specify type, rely on saved params type instead</span> |
| <span class="n">inputs</span> <span class="o">=</span> <span class="p">[</span><span class="n">symbol</span><span class="o">.</span><span class="n">var</span><span class="p">(</span><span class="n">i</span><span class="p">)</span><span class="o">.</span><span class="n">as_np_ndarray</span><span class="p">()</span> <span class="k">if</span> <span class="n">is_np_array</span><span class="p">()</span> <span class="k">else</span> <span class="n">symbol</span><span class="o">.</span><span class="n">var</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="ow">in</span> <span class="n">input_names</span><span class="p">]</span> |
| <span class="n">ret</span> <span class="o">=</span> <span class="n">SymbolBlock</span><span class="p">(</span><span class="n">sym</span><span class="p">,</span> <span class="n">inputs</span><span class="p">)</span> |
| <span class="k">if</span> <span class="n">param_file</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span> |
| <span class="n">ret</span><span class="o">.</span><span class="n">collect_params</span><span class="p">()</span><span class="o">.</span><span class="n">load</span><span class="p">(</span><span class="n">param_file</span><span class="p">,</span> <span class="n">ctx</span><span class="p">,</span> <span class="n">allow_missing</span><span class="p">,</span> <span class="n">ignore_extra</span><span class="p">,</span> <span class="n">cast_dtype</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> |
| <span class="n">dtype_source</span><span class="o">=</span><span class="s1">'saved'</span><span class="p">)</span> |
| <span class="k">return</span> <span class="n">ret</span> |
| |
| <span class="k">def</span> <span class="fm">__repr__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="n">s</span> <span class="o">=</span> <span class="s1">'</span><span class="si">{name}</span><span class="s1">(</span><span class="se">\n</span><span class="si">{modstr}</span><span class="se">\n</span><span class="s1">)'</span> |
| <span class="n">modstr</span> <span class="o">=</span> <span class="s1">'</span><span class="se">\n</span><span class="s1">'</span><span class="o">.</span><span class="n">join</span><span class="p">([</span><span class="s1">'</span><span class="si">{block}</span><span class="s1"> : </span><span class="si">{numinputs}</span><span class="s1"> -> </span><span class="si">{numoutputs}</span><span class="s1">'</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">block</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">_cached_graph</span><span class="p">[</span><span class="mi">1</span><span class="p">],</span> |
| <span class="n">numinputs</span><span class="o">=</span><span class="nb">len</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_cached_graph</span><span class="p">[</span><span class="mi">0</span><span class="p">]),</span> |
| <span class="n">numoutputs</span><span class="o">=</span><span class="nb">len</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_cached_graph</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span><span class="o">.</span> |
| <span class="n">list_outputs</span><span class="p">()))])</span> |
| <span class="k">return</span> <span class="n">s</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="vm">__class__</span><span class="o">.</span><span class="vm">__name__</span><span class="p">,</span> |
| <span class="n">modstr</span><span class="o">=</span><span class="n">modstr</span><span class="p">)</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">outputs</span><span class="p">,</span> <span class="n">inputs</span><span class="p">,</span> <span class="n">params</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span> |
| <span class="nb">super</span><span class="p">(</span><span class="n">SymbolBlock</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="n">prefix</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">params</span><span class="o">=</span><span class="kc">None</span><span class="p">)</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_prefix</span> <span class="o">=</span> <span class="s1">''</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_params</span> <span class="o">=</span> <span class="n">ParameterDict</span><span class="p">(</span><span class="s1">''</span><span class="p">,</span> <span class="n">params</span><span class="p">)</span> |
| <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">inputs</span><span class="p">,</span> <span class="n">symbol</span><span class="o">.</span><span class="n">Symbol</span><span class="p">)</span> <span class="ow">and</span> <span class="nb">len</span><span class="p">(</span><span class="n">inputs</span><span class="o">.</span><span class="n">list_outputs</span><span class="p">())</span> <span class="o">==</span> <span class="mi">1</span><span class="p">:</span> |
| <span class="n">inputs</span> <span class="o">=</span> <span class="p">[</span><span class="n">inputs</span><span class="p">]</span> |
| <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">outputs</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="ow">and</span> <span class="nb">len</span><span class="p">(</span><span class="n">outputs</span><span class="p">)</span> <span class="o">==</span> <span class="mi">1</span><span class="p">:</span> |
| <span class="n">outputs</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">syms</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_in_format</span> <span class="o">=</span> <span class="n">_flatten</span><span class="p">(</span><span class="n">inputs</span><span class="p">,</span> <span class="s2">"input"</span><span class="p">)</span> |
| <span class="n">out</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_out_format</span> <span class="o">=</span> <span class="n">_flatten</span><span class="p">(</span><span class="n">outputs</span><span class="p">,</span> <span class="s2">"output"</span><span class="p">)</span> |
| <span class="n">input_names</span> <span class="o">=</span> <span class="nb">set</span><span class="p">()</span> |
| <span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="n">syms</span><span class="p">:</span> |
| <span class="k">assert</span> <span class="nb">len</span><span class="p">(</span><span class="n">i</span><span class="o">.</span><span class="n">get_internals</span><span class="p">()</span><span class="o">.</span><span class="n">list_outputs</span><span class="p">())</span> <span class="o">==</span> <span class="mi">1</span><span class="p">,</span> \ |
| <span class="s2">"Input symbols must be variable, but </span><span class="si">%s</span><span class="s2"> is an output of operators"</span><span class="o">%</span><span class="nb">str</span><span class="p">(</span><span class="n">i</span><span class="p">)</span> |
| <span class="n">input_names</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="n">i</span><span class="o">.</span><span class="n">name</span><span class="p">)</span> |
| |
| <span class="c1"># check if any symbol is row_sparse</span> |
| <span class="n">row_sparse_storage</span> <span class="o">=</span> <span class="n">ndarray</span><span class="o">.</span><span class="n">ndarray</span><span class="o">.</span><span class="n">_STORAGE_TYPE_STR_TO_ID</span><span class="p">[</span><span class="s1">'row_sparse'</span><span class="p">]</span> |
| |
| <span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="n">out</span><span class="p">:</span> |
| <span class="k">for</span> <span class="n">j</span> <span class="ow">in</span> <span class="n">i</span><span class="o">.</span><span class="n">get_internals</span><span class="p">():</span> |
| <span class="k">assert</span><span class="p">(</span><span class="n">j</span><span class="o">.</span><span class="n">attr</span><span class="p">(</span><span class="s2">"__storage_type__"</span><span class="p">)</span> <span class="o">!=</span> <span class="nb">str</span><span class="p">(</span><span class="n">row_sparse_storage</span><span class="p">)),</span> \ |
| <span class="s2">"SymbolBlock doesn't support Parameter '</span><span class="si">%s</span><span class="s2">' because its storage "</span> \ |
| <span class="s2">"type is 'row_sparse'."</span> <span class="o">%</span> <span class="n">j</span><span class="o">.</span><span class="n">name</span> |
| <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">out</span><span class="p">)</span> <span class="o">></span> <span class="mi">1</span><span class="p">:</span> |
| <span class="n">out</span> <span class="o">=</span> <span class="n">symbol</span><span class="o">.</span><span class="n">Group</span><span class="p">(</span><span class="n">out</span><span class="p">,</span> <span class="n">_check_same_symbol_type</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">out</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> |
| |
| <span class="c1"># Infer type of parameters. Without this, every parameter will be created with</span> |
| <span class="c1"># default type i.e., fp32</span> |
| <span class="n">arg_params</span> <span class="o">=</span> <span class="n">out</span><span class="o">.</span><span class="n">list_arguments</span><span class="p">()</span> |
| <span class="n">aux_params</span> <span class="o">=</span> <span class="n">out</span><span class="o">.</span><span class="n">list_auxiliary_states</span><span class="p">()</span> |
| |
| <span class="n">arg_types</span><span class="p">,</span> <span class="n">aux_types</span> <span class="o">=</span> <span class="n">_infer_param_types</span><span class="p">(</span><span class="n">syms</span><span class="p">,</span> <span class="n">out</span><span class="p">,</span> <span class="n">arg_params</span><span class="p">,</span> <span class="n">aux_params</span><span class="p">)</span> |
| |
| <span class="k">for</span> <span class="n">i</span><span class="p">,</span> <span class="n">arg</span> <span class="ow">in</span> <span class="nb">enumerate</span><span class="p">(</span><span class="n">arg_params</span><span class="p">):</span> |
| <span class="k">if</span> <span class="n">arg</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">input_names</span><span class="p">:</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">params</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">arg</span><span class="p">,</span> <span class="n">allow_deferred_init</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">arg_types</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">aux</span> <span class="ow">in</span> <span class="nb">enumerate</span><span class="p">(</span><span class="n">aux_params</span><span class="p">):</span> |
| <span class="k">if</span> <span class="n">aux</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">input_names</span><span class="p">:</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">params</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">aux</span><span class="p">,</span> <span class="n">grad_req</span><span class="o">=</span><span class="s1">'null'</span><span class="p">,</span> <span class="n">allow_deferred_init</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">aux_types</span><span class="p">[</span><span class="n">i</span><span class="p">])</span> |
| |
| <span class="bp">self</span><span class="o">.</span><span class="n">_cached_graph</span> <span class="o">=</span> <span class="n">syms</span><span class="p">,</span> <span class="n">out</span> |
| <span class="n">len_prefix</span> <span class="o">=</span> <span class="nb">len</span><span class="p">(</span><span class="n">_common_prefix</span><span class="p">(</span><span class="nb">list</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_params</span><span class="o">.</span><span class="n">keys</span><span class="p">())))</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_reg_params</span> <span class="o">=</span> <span class="p">{</span><span class="n">key</span><span class="p">[</span><span class="n">len_prefix</span><span class="p">:]:</span> <span class="n">val</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="bp">self</span><span class="o">.</span><span class="n">_params</span><span class="o">.</span><span class="n">items</span><span class="p">()}</span> |
| |
| <span class="k">def</span> <span class="nf">forward</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">x</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">):</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">NDArray</span><span class="p">):</span> |
| <span class="k">with</span> <span class="n">x</span><span class="o">.</span><span class="n">ctx</span><span class="p">:</span> |
| <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_call_cached_op</span><span class="p">(</span><span class="n">x</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">)</span> |
| |
| <span class="k">assert</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">x</span><span class="p">,</span> <span class="n">Symbol</span><span class="p">),</span> \ |
| <span class="s2">"HybridBlock requires the first argument to forward be either "</span> \ |
| <span class="s2">"Symbol or NDArray, but got </span><span class="si">%s</span><span class="s2">"</span><span class="o">%</span><span class="nb">type</span><span class="p">(</span><span class="n">x</span><span class="p">)</span> |
| <span class="n">args</span><span class="p">,</span> <span class="n">in_fmt</span> <span class="o">=</span> <span class="n">_flatten</span><span class="p">([</span><span class="n">x</span><span class="p">]</span> <span class="o">+</span> <span class="nb">list</span><span class="p">(</span><span class="n">args</span><span class="p">),</span> <span class="s2">"input"</span><span class="p">)</span> |
| <span class="k">assert</span> <span class="n">in_fmt</span> <span class="o">==</span> <span class="bp">self</span><span class="o">.</span><span class="n">_in_format</span><span class="p">,</span> <span class="s2">"Invalid input format"</span> |
| <span class="n">ret</span> <span class="o">=</span> <span class="n">copy</span><span class="o">.</span><span class="n">copy</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_cached_graph</span><span class="p">[</span><span class="mi">1</span><span class="p">])</span> |
| <span class="n">ret</span><span class="o">.</span><span class="n">_compose</span><span class="p">(</span><span class="o">**</span><span class="p">{</span><span class="n">k</span><span class="o">.</span><span class="n">name</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="bp">self</span><span class="o">.</span><span class="n">_cached_graph</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="k">return</span> <span class="n">_regroup</span><span class="p">(</span><span class="nb">list</span><span class="p">(</span><span class="n">ret</span><span class="p">),</span> <span class="bp">self</span><span class="o">.</span><span class="n">_out_format</span><span class="p">)</span> |
| |
| <span class="k">def</span> <span class="nf">_clear_cached_op</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="n">tmp</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_cached_graph</span> |
| <span class="nb">super</span><span class="p">(</span><span class="n">SymbolBlock</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="n">_clear_cached_op</span><span class="p">()</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_cached_graph</span> <span class="o">=</span> <span class="n">tmp</span> |
| |
| <span class="k">def</span> <span class="nf">cast</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">dtype</span><span class="p">):</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_clear_cached_op</span><span class="p">()</span> |
| <span class="nb">super</span><span class="p">(</span><span class="n">SymbolBlock</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="n">cast</span><span class="p">(</span><span class="n">dtype</span><span class="p">)</span> |
| <span class="k">if</span> <span class="n">np</span><span class="o">.</span><span class="n">dtype</span><span class="p">(</span><span class="n">dtype</span><span class="p">)</span><span class="o">.</span><span class="n">name</span> <span class="o">==</span> <span class="s1">'float16'</span><span class="p">:</span> |
| <span class="c1"># correct BatchNorm types back to float32 due to its special requirement</span> |
| <span class="n">out</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_cached_graph</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span> |
| <span class="n">params_list</span> <span class="o">=</span> <span class="n">out</span><span class="o">.</span><span class="n">get_internals</span><span class="p">()</span><span class="o">.</span><span class="n">list_inputs</span><span class="p">()</span> |
| <span class="k">for</span> <span class="n">node</span> <span class="ow">in</span> <span class="n">params_list</span><span class="p">:</span> |
| <span class="k">if</span> <span class="n">node</span><span class="o">.</span><span class="n">endswith</span><span class="p">(</span><span class="s1">'running_var'</span><span class="p">):</span> |
| <span class="n">prefix</span> <span class="o">=</span> <span class="n">node</span><span class="p">[:</span><span class="o">-</span><span class="mi">11</span><span class="p">]</span> |
| <span class="n">sibs</span> <span class="o">=</span> <span class="p">[</span><span class="n">prefix</span> <span class="o">+</span> <span class="n">t</span> <span class="k">for</span> <span class="n">t</span> <span class="ow">in</span> <span class="p">(</span><span class="s1">'running_mean'</span><span class="p">,</span> <span class="s1">'gamma'</span><span class="p">,</span> <span class="s1">'beta'</span><span class="p">)]</span> |
| <span class="n">is_bn</span> <span class="o">=</span> <span class="nb">all</span><span class="p">(</span><span class="n">p</span> <span class="ow">in</span> <span class="n">params_list</span> <span class="k">for</span> <span class="n">p</span> <span class="ow">in</span> <span class="n">sibs</span><span class="p">)</span> |
| <span class="k">if</span> <span class="n">is_bn</span><span class="p">:</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">params</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">node</span><span class="p">)</span><span class="o">.</span><span class="n">cast</span><span class="p">(</span><span class="s1">'float32'</span><span class="p">)</span> |
| <span class="k">for</span> <span class="n">sib</span> <span class="ow">in</span> <span class="n">sibs</span><span class="p">:</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">params</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">sib</span><span class="p">)</span><span class="o">.</span><span class="n">cast</span><span class="p">(</span><span class="s1">'float32'</span><span class="p">)</span> |
| <span class="k">if</span> <span class="n">node</span><span class="o">.</span><span class="n">endswith</span><span class="p">(</span><span class="s1">'moving_var'</span><span class="p">):</span> |
| <span class="c1"># another convention used</span> |
| <span class="n">prefix</span> <span class="o">=</span> <span class="n">node</span><span class="p">[:</span><span class="o">-</span><span class="mi">10</span><span class="p">]</span> |
| <span class="n">sibs</span> <span class="o">=</span> <span class="p">[</span><span class="n">prefix</span> <span class="o">+</span> <span class="n">t</span> <span class="k">for</span> <span class="n">t</span> <span class="ow">in</span> <span class="p">(</span><span class="s1">'moving_mean'</span><span class="p">,</span> <span class="s1">'gamma'</span><span class="p">,</span> <span class="s1">'beta'</span><span class="p">)]</span> |
| <span class="n">is_bn</span> <span class="o">=</span> <span class="nb">all</span><span class="p">(</span><span class="n">p</span> <span class="ow">in</span> <span class="n">params_list</span> <span class="k">for</span> <span class="n">p</span> <span class="ow">in</span> <span class="n">sibs</span><span class="p">)</span> |
| <span class="k">if</span> <span class="n">is_bn</span><span class="p">:</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">params</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">node</span><span class="p">)</span><span class="o">.</span><span class="n">cast</span><span class="p">(</span><span class="s1">'float32'</span><span class="p">)</span> |
| <span class="k">for</span> <span class="n">sib</span> <span class="ow">in</span> <span class="n">sibs</span><span class="p">:</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">params</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">sib</span><span class="p">)</span><span class="o">.</span><span class="n">cast</span><span class="p">(</span><span class="s1">'float32'</span><span class="p">)</span> |
| |
| <span class="k">def</span> <span class="nf">hybrid_forward</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">F</span><span class="p">,</span> <span class="n">x</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">raise</span> <span class="ne">NotImplementedError</span> |
| |
| <span class="k">def</span> <span class="nf">reset_ctx</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">ctx</span><span class="p">):</span> |
| <span class="sd">"""Re-assign all Parameters to other contexts. If the Block is hybridized, it will reset the _cached_op_args.</span> |
| <span class="sd"> Parameters</span> |
| <span class="sd"> ----------</span> |
| <span class="sd"> ctx : Context or list of Context, default :py:meth:`context.current_context()`.</span> |
| <span class="sd"> Assign Parameter to given context. If ctx is a list of Context, a</span> |
| <span class="sd"> copy will be made for each context.</span> |
| <span class="sd"> """</span> |
| <span class="n">params</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">collect_params</span><span class="p">()</span> |
| <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_cached_op</span><span class="p">:</span> |
| <span class="k">for</span> <span class="n">p</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_cached_op_args</span><span class="p">:</span> |
| <span class="c1"># resetting parameters creating by the partitioning backend</span> |
| <span class="k">if</span> <span class="n">p</span><span class="o">.</span><span class="n">name</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">params</span><span class="p">:</span> |
| <span class="n">p</span><span class="o">.</span><span class="n">reset_ctx</span><span class="p">(</span><span class="n">ctx</span><span class="p">)</span> |
| <span class="k">for</span> <span class="n">p</span> <span class="ow">in</span> <span class="n">params</span><span class="o">.</span><span class="n">values</span><span class="p">():</span> |
| <span class="n">p</span><span class="o">.</span><span class="n">reset_ctx</span><span class="p">(</span><span class="n">ctx</span><span class="p">)</span> |
| |
| <span class="k">def</span> <span class="nf">_infer_param_types</span><span class="p">(</span><span class="n">in_params</span><span class="p">,</span> <span class="n">out_params</span><span class="p">,</span> <span class="n">arg_params</span><span class="p">,</span> <span class="n">aux_params</span><span class="p">,</span> <span class="n">default_dtype</span><span class="o">=</span><span class="n">mx_real_t</span><span class="p">):</span> |
| <span class="sd">"""Utility function that helps in inferring DType of args and auxs params</span> |
| <span class="sd"> from given input param.</span> |
| |
| <span class="sd"> Parameters</span> |
| <span class="sd"> ----------</span> |
| <span class="sd"> in_params: List of Symbol</span> |
| <span class="sd"> List of input symbol variables.</span> |
| <span class="sd"> out_params: Symbol</span> |
| <span class="sd"> Output symbol variable.</span> |
| <span class="sd"> arg_params: List of Str</span> |
| <span class="sd"> List of names of argument parametrs.</span> |
| <span class="sd"> aux_params: List of Str</span> |
| <span class="sd"> List of names of auxiliary parameters.</span> |
| <span class="sd"> default_dtype: numpy.dtype or str, default 'float32'</span> |
| <span class="sd"> Default data type for arg_params and aux_params, if unable to infer the type.</span> |
| |
| <span class="sd"> Returns</span> |
| <span class="sd"> -------</span> |
| <span class="sd"> arg_types: List of numpy.dtype</span> |
| <span class="sd"> List of arg_params type. Order is same as arg_params.</span> |
| <span class="sd"> Defaults to 'float32', if unable to infer type.</span> |
| <span class="sd"> aux_types: List of numpy.dtype</span> |
| <span class="sd"> List of aux_params type. Order is same as aux_params.</span> |
| <span class="sd"> Defaults to 'float32', if unable to infer type.</span> |
| <span class="sd"> """</span> |
| <span class="n">arg_types</span> <span class="o">=</span> <span class="kc">None</span> |
| <span class="n">aux_types</span> <span class="o">=</span> <span class="kc">None</span> |
| |
| <span class="c1"># Get Input symbol details. This will be used to infer types of</span> |
| <span class="c1"># other parameters.</span> |
| <span class="n">input_sym_names</span> <span class="o">=</span> <span class="p">[</span><span class="n">in_param</span><span class="o">.</span><span class="n">name</span> <span class="k">for</span> <span class="n">in_param</span> <span class="ow">in</span> <span class="n">in_params</span><span class="p">]</span> |
| |
| <span class="c1"># Try to infer input types. If not successful, we will set default dtype.</span> |
| <span class="c1"># If successful, we will try to infer other params in the graph.</span> |
| <span class="n">input_sym_arg_types</span> <span class="o">=</span> <span class="p">[]</span> |
| <span class="n">can_infer_input_type</span> <span class="o">=</span> <span class="kc">True</span> |
| <span class="k">for</span> <span class="n">in_param</span> <span class="ow">in</span> <span class="n">in_params</span><span class="p">:</span> |
| <span class="n">input_sym_arg_type</span> <span class="o">=</span> <span class="n">in_param</span><span class="o">.</span><span class="n">infer_type</span><span class="p">()[</span><span class="mi">0</span><span class="p">]</span> |
| <span class="k">if</span> <span class="ow">not</span> <span class="n">input_sym_arg_type</span> <span class="ow">or</span> <span class="nb">len</span><span class="p">(</span><span class="n">input_sym_arg_type</span><span class="p">)</span> <span class="o"><</span> <span class="mi">1</span><span class="p">:</span> |
| <span class="n">can_infer_input_type</span> <span class="o">=</span> <span class="kc">False</span> |
| <span class="k">break</span> |
| <span class="k">else</span><span class="p">:</span> |
| <span class="n">input_sym_arg_types</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">in_param</span><span class="o">.</span><span class="n">infer_type</span><span class="p">()[</span><span class="mi">0</span><span class="p">][</span><span class="mi">0</span><span class="p">])</span> |
| |
| <span class="c1"># Try to infer types of other parameters.</span> |
| <span class="k">if</span> <span class="n">can_infer_input_type</span><span class="p">:</span> |
| <span class="n">params</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">input_sym_names</span><span class="p">,</span> <span class="n">input_sym_arg_types</span><span class="p">)}</span> |
| <span class="k">try</span><span class="p">:</span> |
| <span class="n">arg_types</span><span class="p">,</span> <span class="n">_</span><span class="p">,</span> <span class="n">aux_types</span> <span class="o">=</span> <span class="n">out_params</span><span class="o">.</span><span class="n">infer_type</span><span class="p">(</span><span class="o">**</span><span class="n">params</span><span class="p">)</span> |
| <span class="k">except</span> <span class="n">MXNetError</span><span class="p">:</span> |
| <span class="c1"># Cannot infer type with current input</span> |
| <span class="n">arg_types</span><span class="p">,</span> <span class="n">aux_types</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span> <span class="kc">None</span> |
| |
| <span class="k">if</span> <span class="n">arg_types</span> <span class="ow">is</span> <span class="kc">None</span> <span class="ow">or</span> <span class="nb">len</span><span class="p">(</span><span class="n">arg_types</span><span class="p">)</span> <span class="o">!=</span> <span class="nb">len</span><span class="p">(</span><span class="n">arg_params</span><span class="p">):</span> |
| <span class="n">arg_types</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="n">arg_params</span><span class="p">:</span> |
| <span class="n">arg_types</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">default_dtype</span><span class="p">)</span> |
| |
| <span class="k">if</span> <span class="n">aux_types</span> <span class="ow">is</span> <span class="kc">None</span> <span class="ow">or</span> <span class="nb">len</span><span class="p">(</span><span class="n">aux_types</span><span class="p">)</span> <span class="o">!=</span> <span class="nb">len</span><span class="p">(</span><span class="n">aux_params</span><span class="p">):</span> |
| <span class="n">aux_types</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="n">aux_params</span><span class="p">:</span> |
| <span class="n">aux_types</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">default_dtype</span><span class="p">)</span> |
| |
| <span class="k">return</span> <span class="p">(</span><span class="n">arg_types</span><span class="p">,</span> <span class="n">aux_types</span><span class="p">)</span> |
| </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 class="u-email" href="mailto:dev@mxnet.apache.org">Dev list</a></li> |
| <li><a class="u-email" href="mailto:user@mxnet.apache.org">User mailing list</a></li> |
| <li><a href="https://cwiki.apache.org/confluence/display/MXNET/Apache+MXNet+Home">Developer Wiki</a></li> |
| <li><a href="https://issues.apache.org/jira/projects/MXNET/issues">Jira Tracker</a></li> |
| <li><a href="https://github.com/apache/incubator-mxnet/labels/Roadmap">Github Roadmap</a></li> |
| <li><a href="https://medium.com/apache-mxnet">Blog</a></li> |
| <li><a href="https://discuss.mxnet.io">Forum</a></li> |
| <li><a href="/community/contribute">Contribute</a></li> |
| |
| </ul> |
| </div> |
| |
| <div class="col-4"><ul class="social-media-list"><li><a href="https://github.com/apache/incubator-mxnet"><svg class="svg-icon"><use xlink:href="../../../_static/minima-social-icons.svg#github"></use></svg> <span class="username">apache/incubator-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> |
