| <!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.ndarray.sparse — 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/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.ndarray.sparse</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.ndarray.sparse</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=wildcard-import, unused-wildcard-import, too-many-lines</span> |
| <span class="sd">"""Sparse NDArray API of MXNet."""</span> |
| |
| <span class="k">try</span><span class="p">:</span> |
| <span class="kn">from</span> <span class="nn">__builtin__</span> <span class="kn">import</span> <span class="nb">slice</span> <span class="k">as</span> <span class="n">py_slice</span> |
| <span class="kn">from</span> <span class="nn">__builtin__</span> <span class="kn">import</span> <span class="nb">sum</span> <span class="k">as</span> <span class="n">py_sum</span> |
| <span class="k">except</span> <span class="ne">ImportError</span><span class="p">:</span> |
| <span class="kn">from</span> <span class="nn">builtins</span> <span class="kn">import</span> <span class="nb">slice</span> <span class="k">as</span> <span class="n">py_slice</span> |
| <span class="kn">from</span> <span class="nn">builtins</span> <span class="kn">import</span> <span class="nb">sum</span> <span class="k">as</span> <span class="n">py_sum</span> |
| |
| <span class="kn">import</span> <span class="nn">ctypes</span> |
| <span class="kn">import</span> <span class="nn">warnings</span> |
| <span class="kn">import</span> <span class="nn">operator</span> |
| <span class="kn">from</span> <span class="nn">array</span> <span class="kn">import</span> <span class="n">array</span> <span class="k">as</span> <span class="n">native_array</span> |
| |
| <span class="n">__all__</span> <span class="o">=</span> <span class="p">[</span><span class="s2">"_ndarray_cls"</span><span class="p">,</span> <span class="s2">"csr_matrix"</span><span class="p">,</span> <span class="s2">"row_sparse_array"</span><span class="p">,</span> |
| <span class="s2">"BaseSparseNDArray"</span><span class="p">,</span> <span class="s2">"CSRNDArray"</span><span class="p">,</span> <span class="s2">"RowSparseNDArray"</span><span class="p">,</span> |
| <span class="s2">"add"</span><span class="p">,</span> <span class="s2">"subtract"</span><span class="p">,</span> <span class="s2">"multiply"</span><span class="p">,</span> <span class="s2">"divide"</span><span class="p">]</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">NotSupportedForSparseNDArray</span> |
| <span class="kn">from</span> <span class="nn">..base</span> <span class="kn">import</span> <span class="n">_LIB</span><span class="p">,</span> <span class="n">numeric_types</span> |
| <span class="kn">from</span> <span class="nn">..base</span> <span class="kn">import</span> <span class="n">c_array_buf</span><span class="p">,</span> <span class="n">mx_real_t</span><span class="p">,</span> <span class="n">integer_types</span> |
| <span class="kn">from</span> <span class="nn">..base</span> <span class="kn">import</span> <span class="n">NDArrayHandle</span><span class="p">,</span> <span class="n">check_call</span> |
| <span class="kn">from</span> <span class="nn">..context</span> <span class="kn">import</span> <span class="n">Context</span><span class="p">,</span> <span class="n">current_context</span> |
| <span class="kn">from</span> <span class="nn">.</span> <span class="kn">import</span> <span class="n">_internal</span> |
| <span class="kn">from</span> <span class="nn">.</span> <span class="kn">import</span> <span class="n">op</span> |
| <span class="k">try</span><span class="p">:</span> |
| <span class="kn">from</span> <span class="nn">.gen_sparse</span> <span class="kn">import</span> <span class="n">retain</span> <span class="k">as</span> <span class="n">gs_retain</span> <span class="c1"># pylint: disable=redefined-builtin</span> |
| <span class="k">except</span> <span class="ne">ImportError</span><span class="p">:</span> |
| <span class="n">gs_retain</span> <span class="o">=</span> <span class="kc">None</span> |
| <span class="kn">from</span> <span class="nn">._internal</span> <span class="kn">import</span> <span class="n">_set_ndarray_class</span> |
| <span class="kn">from</span> <span class="nn">.ndarray</span> <span class="kn">import</span> <span class="n">NDArray</span><span class="p">,</span> <span class="n">_storage_type</span><span class="p">,</span> <span class="n">_DTYPE_NP_TO_MX</span><span class="p">,</span> <span class="n">_DTYPE_MX_TO_NP</span> |
| <span class="kn">from</span> <span class="nn">.ndarray</span> <span class="kn">import</span> <span class="n">_STORAGE_TYPE_STR_TO_ID</span><span class="p">,</span> <span class="n">_STORAGE_TYPE_ROW_SPARSE</span><span class="p">,</span> <span class="n">_STORAGE_TYPE_CSR</span><span class="p">,</span> <span class="n">_int64_enabled</span> |
| <span class="kn">from</span> <span class="nn">.ndarray</span> <span class="kn">import</span> <span class="n">_STORAGE_TYPE_UNDEFINED</span><span class="p">,</span> <span class="n">_STORAGE_TYPE_DEFAULT</span> |
| <span class="kn">from</span> <span class="nn">.ndarray</span> <span class="kn">import</span> <span class="n">zeros</span> <span class="k">as</span> <span class="n">_zeros_ndarray</span> |
| <span class="kn">from</span> <span class="nn">.ndarray</span> <span class="kn">import</span> <span class="n">array</span> <span class="k">as</span> <span class="n">_array</span> |
| <span class="kn">from</span> <span class="nn">.ndarray</span> <span class="kn">import</span> <span class="n">_ufunc_helper</span> |
| |
| |
| <span class="k">try</span><span class="p">:</span> |
| <span class="kn">import</span> <span class="nn">scipy.sparse</span> <span class="k">as</span> <span class="nn">spsp</span> |
| <span class="k">except</span> <span class="ne">ImportError</span><span class="p">:</span> |
| <span class="n">spsp</span> <span class="o">=</span> <span class="kc">None</span> |
| |
| <span class="n">_STORAGE_AUX_TYPES</span> <span class="o">=</span> <span class="p">{</span> |
| <span class="s1">'row_sparse'</span><span class="p">:</span> <span class="p">[</span><span class="n">np</span><span class="o">.</span><span class="n">int64</span><span class="p">],</span> |
| <span class="s1">'csr'</span><span class="p">:</span> <span class="p">[</span><span class="n">np</span><span class="o">.</span><span class="n">int64</span><span class="p">,</span> <span class="n">np</span><span class="o">.</span><span class="n">int64</span><span class="p">]</span> |
| <span class="p">}</span> |
| |
| |
| <span class="k">def</span> <span class="nf">_new_alloc_handle</span><span class="p">(</span><span class="n">stype</span><span class="p">,</span> <span class="n">shape</span><span class="p">,</span> <span class="n">ctx</span><span class="p">,</span> <span class="n">delay_alloc</span><span class="p">,</span> <span class="n">dtype</span><span class="p">,</span> <span class="n">aux_types</span><span class="p">,</span> <span class="n">aux_shapes</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span> |
| <span class="w"> </span><span class="sd">"""Return a new handle with specified storage type, shape, dtype and context.</span> |
| |
| <span class="sd"> Empty handle is only used to hold results</span> |
| |
| <span class="sd"> Returns</span> |
| <span class="sd"> -------</span> |
| <span class="sd"> handle</span> |
| <span class="sd"> A new empty ndarray handle</span> |
| <span class="sd"> """</span> |
| <span class="n">hdl</span> <span class="o">=</span> <span class="n">NDArrayHandle</span><span class="p">()</span> |
| <span class="k">for</span> <span class="n">aux_t</span> <span class="ow">in</span> <span class="n">aux_types</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">aux_t</span><span class="p">)</span> <span class="o">!=</span> <span class="n">np</span><span class="o">.</span><span class="n">dtype</span><span class="p">(</span><span class="s2">"int64"</span><span class="p">):</span> |
| <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">(</span><span class="s2">"only int64 is supported for aux types"</span><span class="p">)</span> |
| <span class="n">aux_type_ids</span> <span class="o">=</span> <span class="p">[</span><span class="nb">int</span><span class="p">(</span><span class="n">_DTYPE_NP_TO_MX</span><span class="p">[</span><span class="n">np</span><span class="o">.</span><span class="n">dtype</span><span class="p">(</span><span class="n">aux_t</span><span class="p">)</span><span class="o">.</span><span class="n">type</span><span class="p">])</span> <span class="k">for</span> <span class="n">aux_t</span> <span class="ow">in</span> <span class="n">aux_types</span><span class="p">]</span> |
| <span class="n">aux_shapes</span> <span class="o">=</span> <span class="p">[(</span><span class="mi">0</span><span class="p">,)</span> <span class="k">for</span> <span class="n">aux_t</span> <span class="ow">in</span> <span class="n">aux_types</span><span class="p">]</span> <span class="k">if</span> <span class="n">aux_shapes</span> <span class="ow">is</span> <span class="kc">None</span> <span class="k">else</span> <span class="n">aux_shapes</span> |
| <span class="n">aux_shape_lens</span> <span class="o">=</span> <span class="p">[</span><span class="nb">len</span><span class="p">(</span><span class="n">aux_shape</span><span class="p">)</span> <span class="k">for</span> <span class="n">aux_shape</span> <span class="ow">in</span> <span class="n">aux_shapes</span><span class="p">]</span> |
| <span class="n">aux_shapes</span> <span class="o">=</span> <span class="n">py_sum</span><span class="p">(</span><span class="n">aux_shapes</span><span class="p">,</span> <span class="p">())</span> |
| <span class="n">num_aux</span> <span class="o">=</span> <span class="n">ctypes</span><span class="o">.</span><span class="n">c_uint</span><span class="p">(</span><span class="nb">len</span><span class="p">(</span><span class="n">aux_types</span><span class="p">))</span> |
| <span class="k">if</span> <span class="n">_int64_enabled</span><span class="p">():</span> |
| <span class="n">check_call</span><span class="p">(</span><span class="n">_LIB</span><span class="o">.</span><span class="n">MXNDArrayCreateSparseEx64</span><span class="p">(</span> |
| <span class="n">ctypes</span><span class="o">.</span><span class="n">c_int</span><span class="p">(</span><span class="nb">int</span><span class="p">(</span><span class="n">_STORAGE_TYPE_STR_TO_ID</span><span class="p">[</span><span class="n">stype</span><span class="p">])),</span> |
| <span class="n">c_array_buf</span><span class="p">(</span><span class="n">ctypes</span><span class="o">.</span><span class="n">c_int64</span><span class="p">,</span> <span class="n">native_array</span><span class="p">(</span><span class="s1">'q'</span><span class="p">,</span> <span class="n">shape</span><span class="p">)),</span> |
| <span class="n">ctypes</span><span class="o">.</span><span class="n">c_int</span><span class="p">(</span><span class="nb">len</span><span class="p">(</span><span class="n">shape</span><span class="p">)),</span> |
| <span class="n">ctypes</span><span class="o">.</span><span class="n">c_int</span><span class="p">(</span><span class="n">ctx</span><span class="o">.</span><span class="n">device_typeid</span><span class="p">),</span> |
| <span class="n">ctypes</span><span class="o">.</span><span class="n">c_int</span><span class="p">(</span><span class="n">ctx</span><span class="o">.</span><span class="n">device_id</span><span class="p">),</span> |
| <span class="n">ctypes</span><span class="o">.</span><span class="n">c_int</span><span class="p">(</span><span class="nb">int</span><span class="p">(</span><span class="n">delay_alloc</span><span class="p">)),</span> |
| <span class="n">ctypes</span><span class="o">.</span><span class="n">c_int</span><span class="p">(</span><span class="nb">int</span><span class="p">(</span><span class="n">_DTYPE_NP_TO_MX</span><span class="p">[</span><span class="n">np</span><span class="o">.</span><span class="n">dtype</span><span class="p">(</span><span class="n">dtype</span><span class="p">)</span><span class="o">.</span><span class="n">type</span><span class="p">])),</span> |
| <span class="n">num_aux</span><span class="p">,</span> |
| <span class="n">c_array_buf</span><span class="p">(</span><span class="n">ctypes</span><span class="o">.</span><span class="n">c_int</span><span class="p">,</span> <span class="n">native_array</span><span class="p">(</span><span class="s1">'i'</span><span class="p">,</span> <span class="n">aux_type_ids</span><span class="p">)),</span> |
| <span class="n">c_array_buf</span><span class="p">(</span><span class="n">ctypes</span><span class="o">.</span><span class="n">c_int</span><span class="p">,</span> <span class="n">native_array</span><span class="p">(</span><span class="s1">'i'</span><span class="p">,</span> <span class="n">aux_shape_lens</span><span class="p">)),</span> |
| <span class="n">c_array_buf</span><span class="p">(</span><span class="n">ctypes</span><span class="o">.</span><span class="n">c_int64</span><span class="p">,</span> <span class="n">native_array</span><span class="p">(</span><span class="s1">'q'</span><span class="p">,</span> <span class="n">aux_shapes</span><span class="p">)),</span> |
| <span class="n">ctypes</span><span class="o">.</span><span class="n">byref</span><span class="p">(</span><span class="n">hdl</span><span class="p">)))</span> |
| <span class="k">else</span><span class="p">:</span> |
| <span class="n">check_call</span><span class="p">(</span><span class="n">_LIB</span><span class="o">.</span><span class="n">MXNDArrayCreateSparseEx</span><span class="p">(</span> |
| <span class="n">ctypes</span><span class="o">.</span><span class="n">c_int</span><span class="p">(</span><span class="nb">int</span><span class="p">(</span><span class="n">_STORAGE_TYPE_STR_TO_ID</span><span class="p">[</span><span class="n">stype</span><span class="p">])),</span> |
| <span class="n">c_array_buf</span><span class="p">(</span><span class="n">ctypes</span><span class="o">.</span><span class="n">c_uint</span><span class="p">,</span> <span class="n">native_array</span><span class="p">(</span><span class="s1">'I'</span><span class="p">,</span> <span class="n">shape</span><span class="p">)),</span> |
| <span class="n">ctypes</span><span class="o">.</span><span class="n">c_uint</span><span class="p">(</span><span class="nb">len</span><span class="p">(</span><span class="n">shape</span><span class="p">)),</span> |
| <span class="n">ctypes</span><span class="o">.</span><span class="n">c_int</span><span class="p">(</span><span class="n">ctx</span><span class="o">.</span><span class="n">device_typeid</span><span class="p">),</span> |
| <span class="n">ctypes</span><span class="o">.</span><span class="n">c_int</span><span class="p">(</span><span class="n">ctx</span><span class="o">.</span><span class="n">device_id</span><span class="p">),</span> |
| <span class="n">ctypes</span><span class="o">.</span><span class="n">c_int</span><span class="p">(</span><span class="nb">int</span><span class="p">(</span><span class="n">delay_alloc</span><span class="p">)),</span> |
| <span class="n">ctypes</span><span class="o">.</span><span class="n">c_int</span><span class="p">(</span><span class="nb">int</span><span class="p">(</span><span class="n">_DTYPE_NP_TO_MX</span><span class="p">[</span><span class="n">np</span><span class="o">.</span><span class="n">dtype</span><span class="p">(</span><span class="n">dtype</span><span class="p">)</span><span class="o">.</span><span class="n">type</span><span class="p">])),</span> |
| <span class="n">num_aux</span><span class="p">,</span> |
| <span class="n">c_array_buf</span><span class="p">(</span><span class="n">ctypes</span><span class="o">.</span><span class="n">c_int</span><span class="p">,</span> <span class="n">native_array</span><span class="p">(</span><span class="s1">'i'</span><span class="p">,</span> <span class="n">aux_type_ids</span><span class="p">)),</span> |
| <span class="n">c_array_buf</span><span class="p">(</span><span class="n">ctypes</span><span class="o">.</span><span class="n">c_uint</span><span class="p">,</span> <span class="n">native_array</span><span class="p">(</span><span class="s1">'I'</span><span class="p">,</span> <span class="n">aux_shape_lens</span><span class="p">)),</span> |
| <span class="n">c_array_buf</span><span class="p">(</span><span class="n">ctypes</span><span class="o">.</span><span class="n">c_uint</span><span class="p">,</span> <span class="n">native_array</span><span class="p">(</span><span class="s1">'I'</span><span class="p">,</span> <span class="n">aux_shapes</span><span class="p">)),</span> |
| <span class="n">ctypes</span><span class="o">.</span><span class="n">byref</span><span class="p">(</span><span class="n">hdl</span><span class="p">)))</span> |
| <span class="k">return</span> <span class="n">hdl</span> |
| |
| |
| <div class="viewcode-block" id="BaseSparseNDArray"><a class="viewcode-back" href="../../../api/ndarray/sparse/index.html#mxnet.ndarray.sparse.BaseSparseNDArray">[docs]</a><span class="k">class</span> <span class="nc">BaseSparseNDArray</span><span class="p">(</span><span class="n">NDArray</span><span class="p">):</span> |
| <span class="w"> </span><span class="sd">"""The base class of an NDArray stored in a sparse storage format.</span> |
| |
| <span class="sd"> See CSRNDArray and RowSparseNDArray for more details.</span> |
| <span class="sd"> """</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="w"> </span><span class="sd">"""Returns a string representation of the sparse array."""</span> |
| <span class="n">shape_info</span> <span class="o">=</span> <span class="s1">'x'</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">'</span> <span class="o">%</span> <span class="n">x</span> <span class="k">for</span> <span class="n">x</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">shape</span><span class="p">])</span> |
| <span class="c1"># The data content is not displayed since the array usually has big shape</span> |
| <span class="k">return</span> <span class="s1">'</span><span class="se">\n</span><span class="s1"><</span><span class="si">%s</span><span class="s1"> </span><span class="si">%s</span><span class="s1"> @</span><span class="si">%s</span><span class="s1">>'</span> <span class="o">%</span> <span class="p">(</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">shape_info</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">context</span><span class="p">)</span> |
| |
| <span class="k">def</span> <span class="fm">__add__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">other</span><span class="p">):</span> |
| <span class="k">return</span> <span class="n">add</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">other</span><span class="p">)</span> |
| |
| <span class="k">def</span> <span class="fm">__sub__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">other</span><span class="p">):</span> |
| <span class="k">return</span> <span class="n">subtract</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">other</span><span class="p">)</span> |
| |
| <span class="k">def</span> <span class="fm">__mul__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">other</span><span class="p">):</span> |
| <span class="k">return</span> <span class="n">multiply</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">other</span><span class="p">)</span> |
| |
| <span class="k">def</span> <span class="nf">__div__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">other</span><span class="p">):</span> |
| <span class="k">return</span> <span class="n">divide</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">other</span><span class="p">)</span> |
| |
| <span class="k">def</span> <span class="fm">__iadd__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">other</span><span class="p">):</span> |
| <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span> |
| |
| <span class="k">def</span> <span class="fm">__isub__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">other</span><span class="p">):</span> |
| <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span> |
| |
| <span class="k">def</span> <span class="fm">__imul__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">other</span><span class="p">):</span> |
| <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span> |
| |
| <span class="k">def</span> <span class="nf">__idiv__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">other</span><span class="p">):</span> |
| <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span> |
| |
| <span class="k">def</span> <span class="fm">__itruediv__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">other</span><span class="p">):</span> |
| <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span> |
| |
| <span class="k">def</span> <span class="nf">_sync_copyfrom</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">source_array</span><span class="p">):</span> |
| <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span> |
| |
| <span class="k">def</span> <span class="nf">_at</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">idx</span><span class="p">):</span> |
| <span class="k">raise</span> <span class="n">NotSupportedForSparseNDArray</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_at</span><span class="p">,</span> <span class="s1">'[idx]'</span><span class="p">,</span> <span class="n">idx</span><span class="p">)</span> |
| |
| <span class="k">def</span> <span class="nf">_slice</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">start</span><span class="p">,</span> <span class="n">stop</span><span class="p">):</span> |
| <span class="k">raise</span> <span class="n">NotSupportedForSparseNDArray</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_slice</span><span class="p">,</span> <span class="kc">None</span><span class="p">,</span> <span class="n">start</span><span class="p">,</span> <span class="n">stop</span><span class="p">)</span> |
| |
| <div class="viewcode-block" id="BaseSparseNDArray.reshape"><a class="viewcode-back" href="../../../api/ndarray/sparse/index.html#mxnet.ndarray.sparse.BaseSparseNDArray.reshape">[docs]</a> <span class="k">def</span> <span class="nf">reshape</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="o">*</span><span class="n">shape</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="n">NotSupportedForSparseNDArray</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">reshape</span><span class="p">,</span> <span class="kc">None</span><span class="p">,</span> <span class="n">shape</span><span class="p">)</span></div> |
| |
| <span class="nd">@property</span> |
| <span class="k">def</span> <span class="nf">size</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="c1"># the `size` for a sparse ndarray is ambiguous, hence disabled.</span> |
| <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span> |
| |
| <span class="k">def</span> <span class="nf">_aux_type</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">i</span><span class="p">):</span> |
| <span class="w"> </span><span class="sd">"""Data-type of the array's ith aux data.</span> |
| |
| <span class="sd"> Returns</span> |
| <span class="sd"> -------</span> |
| <span class="sd"> numpy.dtype</span> |
| <span class="sd"> This BaseSparseNDArray's aux data type.</span> |
| <span class="sd"> """</span> |
| <span class="n">aux_type</span> <span class="o">=</span> <span class="n">ctypes</span><span class="o">.</span><span class="n">c_int</span><span class="p">()</span> |
| <span class="n">check_call</span><span class="p">(</span><span class="n">_LIB</span><span class="o">.</span><span class="n">MXNDArrayGetAuxType</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">handle</span><span class="p">,</span> <span class="n">i</span><span class="p">,</span> <span class="n">ctypes</span><span class="o">.</span><span class="n">byref</span><span class="p">(</span><span class="n">aux_type</span><span class="p">)))</span> |
| <span class="k">return</span> <span class="n">_DTYPE_MX_TO_NP</span><span class="p">[</span><span class="n">aux_type</span><span class="o">.</span><span class="n">value</span><span class="p">]</span> |
| |
| <span class="nd">@property</span> |
| <span class="k">def</span> <span class="nf">_num_aux</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="w"> </span><span class="sd">"""The number of aux data used to help store the sparse ndarray.</span> |
| <span class="sd"> """</span> |
| <span class="k">return</span> <span class="nb">len</span><span class="p">(</span><span class="n">_STORAGE_AUX_TYPES</span><span class="p">[</span><span class="bp">self</span><span class="o">.</span><span class="n">stype</span><span class="p">])</span> |
| |
| <span class="nd">@property</span> |
| <span class="k">def</span> <span class="nf">_aux_types</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="w"> </span><span class="sd">"""The data types of the aux data for the BaseSparseNDArray.</span> |
| <span class="sd"> """</span> |
| <span class="n">aux_types</span> <span class="o">=</span> <span class="p">[]</span> |
| <span class="n">num_aux</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_num_aux</span> |
| <span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="n">num_aux</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="bp">self</span><span class="o">.</span><span class="n">_aux_type</span><span class="p">(</span><span class="n">i</span><span class="p">))</span> |
| <span class="k">return</span> <span class="n">aux_types</span> |
| |
| <div class="viewcode-block" id="BaseSparseNDArray.asnumpy"><a class="viewcode-back" href="../../../api/ndarray/sparse/index.html#mxnet.ndarray.sparse.BaseSparseNDArray.asnumpy">[docs]</a> <span class="k">def</span> <span class="nf">asnumpy</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="w"> </span><span class="sd">"""Return a dense ``numpy.ndarray`` object with value copied from this array</span> |
| <span class="sd"> """</span> |
| <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">tostype</span><span class="p">(</span><span class="s1">'default'</span><span class="p">)</span><span class="o">.</span><span class="n">asnumpy</span><span class="p">()</span></div> |
| |
| <div class="viewcode-block" id="BaseSparseNDArray.astype"><a class="viewcode-back" href="../../../api/ndarray/sparse/index.html#mxnet.ndarray.sparse.BaseSparseNDArray.astype">[docs]</a> <span class="k">def</span> <span class="nf">astype</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="n">copy</span><span class="o">=</span><span class="kc">True</span><span class="p">):</span> |
| <span class="w"> </span><span class="sd">"""Return a copy of the array after casting to a specified type.</span> |
| |
| <span class="sd"> Parameters</span> |
| <span class="sd"> ----------</span> |
| <span class="sd"> dtype : numpy.dtype or str</span> |
| <span class="sd"> The type of the returned array.</span> |
| <span class="sd"> copy : bool</span> |
| <span class="sd"> Default `True`. By default, astype always returns a newly</span> |
| <span class="sd"> allocated ndarray on the same context. If this is set to</span> |
| <span class="sd"> `False`, and the dtype requested is the same as the ndarray's</span> |
| <span class="sd"> dtype, the ndarray is returned instead of a copy.</span> |
| |
| <span class="sd"> Examples</span> |
| <span class="sd"> --------</span> |
| <span class="sd"> >>> x = mx.nd.sparse.zeros('row_sparse', (2,3), dtype='float32')</span> |
| <span class="sd"> >>> y = x.astype('int32')</span> |
| <span class="sd"> >>> y.dtype</span> |
| <span class="sd"> <type 'numpy.int32'></span> |
| <span class="sd"> """</span> |
| <span class="k">if</span> <span class="ow">not</span> <span class="n">copy</span> <span class="ow">and</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="bp">self</span><span class="o">.</span><span class="n">dtype</span><span class="p">:</span> |
| <span class="k">return</span> <span class="bp">self</span> |
| |
| <span class="n">res</span> <span class="o">=</span> <span class="n">zeros</span><span class="p">(</span><span class="n">shape</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">shape</span><span class="p">,</span> <span class="n">ctx</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">context</span><span class="p">,</span> |
| <span class="n">dtype</span><span class="o">=</span><span class="n">dtype</span><span class="p">,</span> <span class="n">stype</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">stype</span><span class="p">)</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">copyto</span><span class="p">(</span><span class="n">res</span><span class="p">)</span> |
| <span class="k">return</span> <span class="n">res</span></div> |
| |
| <div class="viewcode-block" id="BaseSparseNDArray.copyto"><a class="viewcode-back" href="../../../api/ndarray/sparse/index.html#mxnet.ndarray.sparse.BaseSparseNDArray.copyto">[docs]</a> <span class="k">def</span> <span class="nf">copyto</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">other</span><span class="p">):</span> |
| <span class="w"> </span><span class="sd">"""Copies the value of this array to another array.</span> |
| |
| <span class="sd"> Parameters</span> |
| <span class="sd"> ----------</span> |
| <span class="sd"> other : NDArray or CSRNDArray or RowSparseNDArray or Context</span> |
| <span class="sd"> The destination array or context.</span> |
| |
| <span class="sd"> Returns</span> |
| <span class="sd"> -------</span> |
| <span class="sd"> NDArray or CSRNDArray or RowSparseNDArray</span> |
| <span class="sd"> The copied array.</span> |
| <span class="sd"> """</span> |
| <span class="c1"># pylint: disable= no-member, protected-access</span> |
| <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">other</span><span class="p">,</span> <span class="n">NDArray</span><span class="p">):</span> |
| <span class="k">if</span> <span class="n">other</span><span class="o">.</span><span class="n">handle</span> <span class="ow">is</span> <span class="bp">self</span><span class="o">.</span><span class="n">handle</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">'You are attempting to copy an array to itself'</span><span class="p">,</span> <span class="ne">RuntimeWarning</span><span class="p">)</span> |
| <span class="k">return</span> <span class="kc">False</span> |
| <span class="k">return</span> <span class="n">_internal</span><span class="o">.</span><span class="n">_copyto</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">out</span><span class="o">=</span><span class="n">other</span><span class="p">)</span> |
| <span class="k">elif</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">other</span><span class="p">,</span> <span class="n">Context</span><span class="p">):</span> |
| <span class="n">hret</span> <span class="o">=</span> <span class="n">_ndarray_cls</span><span class="p">(</span><span class="n">_new_alloc_handle</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">stype</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">shape</span><span class="p">,</span> <span class="n">other</span><span class="p">,</span> |
| <span class="kc">True</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">dtype</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_aux_types</span><span class="p">))</span> |
| <span class="k">return</span> <span class="n">_internal</span><span class="o">.</span><span class="n">_copyto</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">out</span><span class="o">=</span><span class="n">hret</span><span class="p">)</span> |
| <span class="k">else</span><span class="p">:</span> |
| <span class="k">raise</span> <span class="ne">TypeError</span><span class="p">(</span><span class="s1">'copyto does not support type '</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="nb">type</span><span class="p">(</span><span class="n">other</span><span class="p">)))</span></div> |
| <span class="c1"># pylint: enable= no-member, protected-access</span> |
| |
| <div class="viewcode-block" id="BaseSparseNDArray.check_format"><a class="viewcode-back" href="../../../api/ndarray/sparse/index.html#mxnet.ndarray.sparse.BaseSparseNDArray.check_format">[docs]</a> <span class="k">def</span> <span class="nf">check_format</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">full_check</span><span class="o">=</span><span class="kc">True</span><span class="p">):</span> |
| <span class="w"> </span><span class="sd">"""Check whether the NDArray format is valid.</span> |
| |
| <span class="sd"> Parameters</span> |
| <span class="sd"> ----------</span> |
| <span class="sd"> full_check : bool, optional</span> |
| <span class="sd"> If `True`, rigorous check, O(N) operations. Otherwise</span> |
| <span class="sd"> basic check, O(1) operations (default True).</span> |
| <span class="sd"> """</span> |
| <span class="n">check_call</span><span class="p">(</span><span class="n">_LIB</span><span class="o">.</span><span class="n">MXNDArraySyncCheckFormat</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">handle</span><span class="p">,</span> <span class="n">ctypes</span><span class="o">.</span><span class="n">c_bool</span><span class="p">(</span><span class="n">full_check</span><span class="p">)))</span></div> |
| |
| <span class="k">def</span> <span class="nf">_data</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="w"> </span><span class="sd">"""A deep copy NDArray of the data array associated with the BaseSparseNDArray.</span> |
| |
| <span class="sd"> This function blocks. Do not use it in performance critical code.</span> |
| <span class="sd"> """</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">wait_to_read</span><span class="p">()</span> |
| <span class="n">hdl</span> <span class="o">=</span> <span class="n">NDArrayHandle</span><span class="p">()</span> |
| <span class="n">check_call</span><span class="p">(</span><span class="n">_LIB</span><span class="o">.</span><span class="n">MXNDArrayGetDataNDArray</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">handle</span><span class="p">,</span> <span class="n">ctypes</span><span class="o">.</span><span class="n">byref</span><span class="p">(</span><span class="n">hdl</span><span class="p">)))</span> |
| <span class="k">return</span> <span class="n">NDArray</span><span class="p">(</span><span class="n">hdl</span><span class="p">)</span> |
| |
| |
| <span class="k">def</span> <span class="nf">_aux_data</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">i</span><span class="p">):</span> |
| <span class="w"> </span><span class="sd">""" Get a deep copy NDArray of the i-th aux data array associated with the</span> |
| <span class="sd"> BaseSparseNDArray.</span> |
| |
| <span class="sd"> This function blocks. Do not use it in performance critical code.</span> |
| <span class="sd"> """</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">wait_to_read</span><span class="p">()</span> |
| <span class="n">hdl</span> <span class="o">=</span> <span class="n">NDArrayHandle</span><span class="p">()</span> |
| <span class="n">check_call</span><span class="p">(</span><span class="n">_LIB</span><span class="o">.</span><span class="n">MXNDArrayGetAuxNDArray</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">handle</span><span class="p">,</span> <span class="n">i</span><span class="p">,</span> <span class="n">ctypes</span><span class="o">.</span><span class="n">byref</span><span class="p">(</span><span class="n">hdl</span><span class="p">)))</span> |
| <span class="k">return</span> <span class="n">NDArray</span><span class="p">(</span><span class="n">hdl</span><span class="p">)</span></div> |
| |
| |
| <span class="c1"># pylint: disable=abstract-method</span> |
| <div class="viewcode-block" id="CSRNDArray"><a class="viewcode-back" href="../../../api/ndarray/sparse/index.html#mxnet.ndarray.sparse.CSRNDArray">[docs]</a><span class="k">class</span> <span class="nc">CSRNDArray</span><span class="p">(</span><span class="n">BaseSparseNDArray</span><span class="p">):</span> |
| <span class="w"> </span><span class="sd">"""A sparse representation of 2D NDArray in the Compressed Sparse Row format.</span> |
| |
| <span class="sd"> A CSRNDArray represents an NDArray as three separate arrays: `data`,</span> |
| <span class="sd"> `indptr` and `indices`. It uses the CSR representation where the column indices for</span> |
| <span class="sd"> row i are stored in ``indices[indptr[i]:indptr[i+1]]`` and their corresponding values are stored</span> |
| <span class="sd"> in ``data[indptr[i]:indptr[i+1]]``.</span> |
| |
| <span class="sd"> The column indices for a given row are expected to be sorted in ascending order.</span> |
| <span class="sd"> Duplicate column entries for the same row are not allowed.</span> |
| |
| <span class="sd"> Example</span> |
| <span class="sd"> -------</span> |
| <span class="sd"> >>> a = mx.nd.array([[0, 1, 0], [2, 0, 0], [0, 0, 0], [0, 0, 3]])</span> |
| <span class="sd"> >>> a = a.tostype('csr')</span> |
| <span class="sd"> >>> a.data.asnumpy()</span> |
| <span class="sd"> array([ 1., 2., 3.], dtype=float32)</span> |
| <span class="sd"> >>> a.indices.asnumpy()</span> |
| <span class="sd"> array([1, 0, 2])</span> |
| <span class="sd"> >>> a.indptr.asnumpy()</span> |
| <span class="sd"> array([0, 1, 2, 2, 3])</span> |
| |
| <span class="sd"> See Also</span> |
| <span class="sd"> --------</span> |
| <span class="sd"> csr_matrix: Several ways to construct a CSRNDArray</span> |
| <span class="sd"> """</span> |
| |
| <span class="k">def</span> <span class="nf">__reduce__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="k">return</span> <span class="n">CSRNDArray</span><span class="p">,</span> <span class="p">(</span><span class="kc">None</span><span class="p">,),</span> <span class="nb">super</span><span class="p">(</span><span class="n">CSRNDArray</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="n">__getstate__</span><span class="p">()</span> |
| |
| <span class="k">def</span> <span class="fm">__iadd__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">other</span><span class="p">):</span> |
| <span class="p">(</span><span class="bp">self</span> <span class="o">+</span> <span class="n">other</span><span class="p">)</span><span class="o">.</span><span class="n">copyto</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="k">def</span> <span class="fm">__isub__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">other</span><span class="p">):</span> |
| <span class="p">(</span><span class="bp">self</span> <span class="o">-</span> <span class="n">other</span><span class="p">)</span><span class="o">.</span><span class="n">copyto</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="k">def</span> <span class="fm">__imul__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">other</span><span class="p">):</span> |
| <span class="p">(</span><span class="bp">self</span> <span class="o">*</span> <span class="n">other</span><span class="p">)</span><span class="o">.</span><span class="n">copyto</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="k">def</span> <span class="nf">__idiv__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">other</span><span class="p">):</span> |
| <span class="p">(</span><span class="bp">self</span> <span class="o">/</span> <span class="n">other</span><span class="p">)</span><span class="o">.</span><span class="n">copyto</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="k">def</span> <span class="fm">__itruediv__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">other</span><span class="p">):</span> |
| <span class="p">(</span><span class="bp">self</span> <span class="o">/</span> <span class="n">other</span><span class="p">)</span><span class="o">.</span><span class="n">copyto</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="k">def</span> <span class="fm">__getitem__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">):</span> |
| <span class="w"> </span><span class="sd">"""x.__getitem__(i) <=> x[i]</span> |
| |
| <span class="sd"> Returns a newly created NDArray based on the indexing key.</span> |
| |
| <span class="sd"> Parameters</span> |
| <span class="sd"> ----------</span> |
| <span class="sd"> key : int or mxnet.ndarray.NDArray.slice</span> |
| <span class="sd"> Indexing key.</span> |
| |
| <span class="sd"> Examples</span> |
| <span class="sd"> --------</span> |
| <span class="sd"> >>> indptr = np.array([0, 2, 3, 6])</span> |
| <span class="sd"> >>> indices = np.array([0, 2, 2, 0, 1, 2])</span> |
| <span class="sd"> >>> data = np.array([1, 2, 3, 4, 5, 6])</span> |
| <span class="sd"> >>> a = mx.nd.sparse.csr_matrix((data, indices, indptr), shape=(3, 3))</span> |
| <span class="sd"> >>> a.asnumpy()</span> |
| <span class="sd"> array([[ 1., 0., 2.],</span> |
| <span class="sd"> [ 0., 0., 3.],</span> |
| <span class="sd"> [ 4., 5., 6.]], dtype=float32)</span> |
| <span class="sd"> >>> a[1:2].asnumpy()</span> |
| <span class="sd"> array([[ 0., 0., 3.]], dtype=float32)</span> |
| <span class="sd"> >>> a[1].asnumpy()</span> |
| <span class="sd"> array([[ 0., 0., 3.]], dtype=float32)</span> |
| <span class="sd"> >>> a[-1].asnumpy()</span> |
| <span class="sd"> array([[ 4., 5., 6.]], dtype=float32)</span> |
| <span class="sd"> """</span> |
| <span class="c1"># pylint: disable= no-member, protected-access</span> |
| <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="nb">int</span><span class="p">):</span> |
| <span class="k">if</span> <span class="n">key</span> <span class="o">==</span> <span class="o">-</span><span class="mi">1</span><span class="p">:</span> |
| <span class="n">begin</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">-</span> <span class="mi">1</span> |
| <span class="k">else</span><span class="p">:</span> |
| <span class="n">begin</span> <span class="o">=</span> <span class="n">key</span> |
| <span class="k">return</span> <span class="n">op</span><span class="o">.</span><span class="n">slice</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">begin</span><span class="o">=</span><span class="n">begin</span><span class="p">,</span> <span class="n">end</span><span class="o">=</span><span class="n">begin</span><span class="o">+</span><span class="mi">1</span><span class="p">)</span> |
| <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="n">py_slice</span><span class="p">):</span> |
| <span class="k">if</span> <span class="n">key</span><span class="o">.</span><span class="n">step</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">'CSRNDArray only supports continuous slicing on axis 0'</span><span class="p">)</span> |
| <span class="k">if</span> <span class="n">key</span><span class="o">.</span><span class="n">start</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span> <span class="ow">or</span> <span class="n">key</span><span class="o">.</span><span class="n">stop</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span> |
| <span class="n">begin</span> <span class="o">=</span> <span class="n">key</span><span class="o">.</span><span class="n">start</span> <span class="k">if</span> <span class="n">key</span><span class="o">.</span><span class="n">start</span> <span class="k">else</span> <span class="mi">0</span> |
| <span class="n">end</span> <span class="o">=</span> <span class="n">key</span><span class="o">.</span><span class="n">stop</span> <span class="k">if</span> <span class="n">key</span><span class="o">.</span><span class="n">stop</span> <span class="k">else</span> <span class="bp">self</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> |
| <span class="k">return</span> <span class="n">op</span><span class="o">.</span><span class="n">slice</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">begin</span><span class="o">=</span><span class="n">begin</span><span class="p">,</span> <span class="n">end</span><span class="o">=</span><span class="n">end</span><span class="p">)</span> |
| <span class="k">else</span><span class="p">:</span> |
| <span class="k">return</span> <span class="bp">self</span> |
| <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">key</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="s1">'Multi-dimension indexing is not supported'</span><span class="p">)</span> |
| <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s1">'Undefined behaviour for </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">key</span><span class="p">))</span> |
| <span class="c1"># pylint: enable= no-member, protected-access</span> |
| |
| <span class="k">def</span> <span class="fm">__setitem__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span> |
| <span class="w"> </span><span class="sd">"""x.__setitem__(i, y) <=> x[i]=y</span> |
| |
| <span class="sd"> Set self[key] to value. Only slice key [:] is supported.</span> |
| |
| <span class="sd"> Parameters</span> |
| <span class="sd"> ----------</span> |
| <span class="sd"> key : mxnet.ndarray.NDArray.slice</span> |
| <span class="sd"> The indexing key.</span> |
| <span class="sd"> value : NDArray or CSRNDArray or numpy.ndarray</span> |
| <span class="sd"> The value to set.</span> |
| |
| <span class="sd"> Examples</span> |
| <span class="sd"> --------</span> |
| <span class="sd"> >>> src = mx.nd.sparse.zeros('csr', (3,3))</span> |
| <span class="sd"> >>> src.asnumpy()</span> |
| <span class="sd"> array([[ 0., 0., 0.],</span> |
| <span class="sd"> [ 0., 0., 0.],</span> |
| <span class="sd"> [ 0., 0., 0.]], dtype=float32)</span> |
| <span class="sd"> >>> # assign CSRNDArray with same storage type</span> |
| <span class="sd"> >>> x = mx.nd.ones((3,3)).tostype('csr')</span> |
| <span class="sd"> >>> x[:] = src</span> |
| <span class="sd"> >>> x.asnumpy()</span> |
| <span class="sd"> array([[ 1., 1., 1.],</span> |
| <span class="sd"> [ 1., 1., 1.],</span> |
| <span class="sd"> [ 1., 1., 1.]], dtype=float32)</span> |
| <span class="sd"> >>> # assign NDArray to CSRNDArray</span> |
| <span class="sd"> >>> x[:] = mx.nd.ones((3,3)) * 2</span> |
| <span class="sd"> >>> x.asnumpy()</span> |
| <span class="sd"> array([[ 2., 2., 2.],</span> |
| <span class="sd"> [ 2., 2., 2.],</span> |
| <span class="sd"> [ 2., 2., 2.]], dtype=float32)</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">writable</span><span class="p">:</span> |
| <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s1">'Failed to assign to a readonly CSRNDArray'</span><span class="p">)</span> |
| <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="n">py_slice</span><span class="p">):</span> |
| <span class="k">if</span> <span class="n">key</span><span class="o">.</span><span class="n">step</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span> <span class="ow">or</span> <span class="n">key</span><span class="o">.</span><span class="n">start</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span> <span class="ow">or</span> <span class="n">key</span><span class="o">.</span><span class="n">stop</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">'Assignment with slice for CSRNDArray is not '</span> \ |
| <span class="s1">'implemented yet.'</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">NDArray</span><span class="p">):</span> |
| <span class="c1"># avoid copying to itself</span> |
| <span class="k">if</span> <span class="n">value</span><span class="o">.</span><span class="n">handle</span> <span class="ow">is</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">handle</span><span class="p">:</span> |
| <span class="n">value</span><span class="o">.</span><span class="n">copyto</span><span class="p">(</span><span class="bp">self</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">numeric_types</span><span class="p">):</span> |
| <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s2">"Assigning numeric types to CSRNDArray is "</span> \ |
| <span class="s2">"not implemented yet."</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="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">ndarray</span><span class="p">,</span> <span class="n">np</span><span class="o">.</span><span class="n">generic</span><span class="p">)):</span> |
| <span class="c1"># TODO(haibin/anisub) check scipy.sparse and use _sync_copy_from to</span> |
| <span class="c1"># avoid the temporary copy</span> |
| <span class="n">warnings</span><span class="o">.</span><span class="n">warn</span><span class="p">(</span><span class="s1">'Assigning non-NDArray object to CSRNDArray is not efficient'</span><span class="p">,</span> |
| <span class="ne">RuntimeWarning</span><span class="p">)</span> |
| <span class="n">tmp</span> <span class="o">=</span> <span class="n">_array</span><span class="p">(</span><span class="n">value</span><span class="p">)</span> |
| <span class="n">tmp</span><span class="o">.</span><span class="n">copyto</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> |
| <span class="k">else</span><span class="p">:</span> |
| <span class="k">raise</span> <span class="ne">TypeError</span><span class="p">(</span><span class="s1">'type </span><span class="si">%s</span><span class="s1"> not supported'</span> <span class="o">%</span> <span class="nb">str</span><span class="p">(</span><span class="nb">type</span><span class="p">(</span><span class="n">value</span><span class="p">)))</span> |
| <span class="k">else</span><span class="p">:</span> |
| <span class="k">assert</span><span class="p">(</span><span class="nb">isinstance</span><span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="p">(</span><span class="nb">int</span><span class="p">,</span> <span class="nb">tuple</span><span class="p">)))</span> |
| <span class="k">raise</span> <span class="ne">Exception</span><span class="p">(</span><span class="s1">'CSRNDArray only supports [:] for assignment'</span><span class="p">)</span> |
| |
| <span class="nd">@property</span> |
| <span class="k">def</span> <span class="nf">indices</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="w"> </span><span class="sd">"""A deep copy NDArray of the indices array of the CSRNDArray.</span> |
| <span class="sd"> This generates a deep copy of the column indices of the current `csr` matrix.</span> |
| |
| <span class="sd"> Returns</span> |
| <span class="sd"> -------</span> |
| <span class="sd"> NDArray</span> |
| <span class="sd"> This CSRNDArray's indices array.</span> |
| <span class="sd"> """</span> |
| <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_aux_data</span><span class="p">(</span><span class="mi">1</span><span class="p">)</span> |
| |
| <span class="nd">@property</span> |
| <span class="k">def</span> <span class="nf">indptr</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="w"> </span><span class="sd">"""A deep copy NDArray of the indptr array of the CSRNDArray.</span> |
| <span class="sd"> This generates a deep copy of the `indptr` of the current `csr` matrix.</span> |
| |
| <span class="sd"> Returns</span> |
| <span class="sd"> -------</span> |
| <span class="sd"> NDArray</span> |
| <span class="sd"> This CSRNDArray's indptr array.</span> |
| <span class="sd"> """</span> |
| <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_aux_data</span><span class="p">(</span><span class="mi">0</span><span class="p">)</span> |
| |
| <span class="nd">@property</span> |
| <span class="k">def</span> <span class="nf">data</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="w"> </span><span class="sd">"""A deep copy NDArray of the data array of the CSRNDArray.</span> |
| <span class="sd"> This generates a deep copy of the `data` of the current `csr` matrix.</span> |
| |
| <span class="sd"> Returns</span> |
| <span class="sd"> -------</span> |
| <span class="sd"> NDArray</span> |
| <span class="sd"> This CSRNDArray's data array.</span> |
| <span class="sd"> """</span> |
| <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_data</span><span class="p">()</span> |
| |
| <span class="nd">@indices</span><span class="o">.</span><span class="n">setter</span> |
| <span class="k">def</span> <span class="nf">indices</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">indices</span><span class="p">):</span> |
| <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span> |
| |
| <span class="nd">@indptr</span><span class="o">.</span><span class="n">setter</span> |
| <span class="k">def</span> <span class="nf">indptr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">indptr</span><span class="p">):</span> |
| <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span> |
| |
| <span class="nd">@data</span><span class="o">.</span><span class="n">setter</span> |
| <span class="k">def</span> <span class="nf">data</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">data</span><span class="p">):</span> |
| <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span> |
| |
| |
| <div class="viewcode-block" id="CSRNDArray.tostype"><a class="viewcode-back" href="../../../api/ndarray/sparse/index.html#mxnet.ndarray.sparse.CSRNDArray.tostype">[docs]</a> <span class="k">def</span> <span class="nf">tostype</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">stype</span><span class="p">):</span> |
| <span class="w"> </span><span class="sd">"""Return a copy of the array with chosen storage type.</span> |
| |
| <span class="sd"> Returns</span> |
| <span class="sd"> -------</span> |
| <span class="sd"> NDArray or CSRNDArray</span> |
| <span class="sd"> A copy of the array with the chosen storage stype</span> |
| <span class="sd"> """</span> |
| <span class="c1"># pylint: disable= no-member, protected-access</span> |
| <span class="k">if</span> <span class="n">stype</span> <span class="o">==</span> <span class="s1">'row_sparse'</span><span class="p">:</span> |
| <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s2">"cast_storage from csr to row_sparse is not supported"</span><span class="p">)</span> |
| <span class="k">return</span> <span class="n">op</span><span class="o">.</span><span class="n">cast_storage</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">stype</span><span class="o">=</span><span class="n">stype</span><span class="p">)</span></div> |
| <span class="c1"># pylint: enable= no-member, protected-access</span> |
| |
| <div class="viewcode-block" id="CSRNDArray.copyto"><a class="viewcode-back" href="../../../api/ndarray/sparse/index.html#mxnet.ndarray.sparse.CSRNDArray.copyto">[docs]</a> <span class="k">def</span> <span class="nf">copyto</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">other</span><span class="p">):</span> |
| <span class="w"> </span><span class="sd">"""Copies the value of this array to another array.</span> |
| |
| <span class="sd"> If ``other`` is a ``NDArray`` or ``CSRNDArray`` object, then ``other.shape`` and</span> |
| <span class="sd"> ``self.shape`` should be the same. This function copies the value from</span> |
| <span class="sd"> ``self`` to ``other``.</span> |
| |
| <span class="sd"> If ``other`` is a context, a new ``CSRNDArray`` will be first created on</span> |
| <span class="sd"> the target context, and the value of ``self`` is copied.</span> |
| |
| <span class="sd"> Parameters</span> |
| <span class="sd"> ----------</span> |
| <span class="sd"> other : NDArray or CSRNDArray or Context</span> |
| <span class="sd"> The destination array or context.</span> |
| |
| <span class="sd"> Returns</span> |
| <span class="sd"> -------</span> |
| <span class="sd"> NDArray or CSRNDArray</span> |
| <span class="sd"> The copied array. If ``other`` is an ``NDArray`` or ``CSRNDArray``, then the return</span> |
| <span class="sd"> value and ``other`` will point to the same ``NDArray`` or ``CSRNDArray``.</span> |
| <span class="sd"> """</span> |
| <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">other</span><span class="p">,</span> <span class="n">Context</span><span class="p">):</span> |
| <span class="k">return</span> <span class="nb">super</span><span class="p">(</span><span class="n">CSRNDArray</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="n">copyto</span><span class="p">(</span><span class="n">other</span><span class="p">)</span> |
| <span class="k">elif</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">other</span><span class="p">,</span> <span class="n">NDArray</span><span class="p">):</span> |
| <span class="n">stype</span> <span class="o">=</span> <span class="n">other</span><span class="o">.</span><span class="n">stype</span> |
| <span class="k">if</span> <span class="n">stype</span> <span class="ow">in</span> <span class="p">(</span><span class="s1">'default'</span><span class="p">,</span> <span class="s1">'csr'</span><span class="p">):</span> |
| <span class="k">return</span> <span class="nb">super</span><span class="p">(</span><span class="n">CSRNDArray</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="n">copyto</span><span class="p">(</span><span class="n">other</span><span class="p">)</span> |
| <span class="k">else</span><span class="p">:</span> |
| <span class="k">raise</span> <span class="ne">TypeError</span><span class="p">(</span><span class="s1">'copyto does not support destination NDArray stype '</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">stype</span><span class="p">))</span> |
| <span class="k">else</span><span class="p">:</span> |
| <span class="k">raise</span> <span class="ne">TypeError</span><span class="p">(</span><span class="s1">'copyto does not support type '</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="nb">type</span><span class="p">(</span><span class="n">other</span><span class="p">)))</span></div> |
| |
| <div class="viewcode-block" id="CSRNDArray.asscipy"><a class="viewcode-back" href="../../../api/ndarray/sparse/index.html#mxnet.ndarray.sparse.CSRNDArray.asscipy">[docs]</a> <span class="k">def</span> <span class="nf">asscipy</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="w"> </span><span class="sd">"""Returns a ``scipy.sparse.csr.csr_matrix`` object with value copied from this array</span> |
| |
| <span class="sd"> Examples</span> |
| <span class="sd"> --------</span> |
| <span class="sd"> >>> x = mx.nd.sparse.zeros('csr', (2,3))</span> |
| <span class="sd"> >>> y = x.asscipy()</span> |
| <span class="sd"> >>> type(y)</span> |
| <span class="sd"> <type 'scipy.sparse.csr.csr_matrix'></span> |
| <span class="sd"> >>> y</span> |
| <span class="sd"> <2x3 sparse matrix of type '<type 'numpy.float32'>'</span> |
| <span class="sd"> with 0 stored elements in Compressed Sparse Row format></span> |
| <span class="sd"> """</span> |
| <span class="n">data</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">data</span><span class="o">.</span><span class="n">asnumpy</span><span class="p">()</span> |
| <span class="n">indices</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">indices</span><span class="o">.</span><span class="n">asnumpy</span><span class="p">()</span> |
| <span class="n">indptr</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">indptr</span><span class="o">.</span><span class="n">asnumpy</span><span class="p">()</span> |
| <span class="k">if</span> <span class="ow">not</span> <span class="n">spsp</span><span class="p">:</span> |
| <span class="k">raise</span> <span class="ne">ImportError</span><span class="p">(</span><span class="s2">"scipy could not be imported. "</span> |
| <span class="s2">"Please make sure that the scipy is installed."</span><span class="p">)</span> |
| <span class="k">return</span> <span class="n">spsp</span><span class="o">.</span><span class="n">csr_matrix</span><span class="p">((</span><span class="n">data</span><span class="p">,</span> <span class="n">indices</span><span class="p">,</span> <span class="n">indptr</span><span class="p">),</span> <span class="n">shape</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">shape</span><span class="p">,</span> <span class="n">dtype</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">dtype</span><span class="p">)</span></div></div> |
| |
| <span class="c1"># pylint: disable=abstract-method</span> |
| <div class="viewcode-block" id="RowSparseNDArray"><a class="viewcode-back" href="../../../api/ndarray/sparse/index.html#mxnet.ndarray.sparse.RowSparseNDArray">[docs]</a><span class="k">class</span> <span class="nc">RowSparseNDArray</span><span class="p">(</span><span class="n">BaseSparseNDArray</span><span class="p">):</span> |
| <span class="w"> </span><span class="sd">"""A sparse representation of a set of NDArray row slices at given indices.</span> |
| |
| <span class="sd"> A RowSparseNDArray represents a multidimensional NDArray using two separate arrays: `data` and</span> |
| <span class="sd"> `indices`. The number of dimensions has to be at least 2.</span> |
| |
| <span class="sd"> - data: an NDArray of any dtype with shape [D0, D1, ..., Dn].</span> |
| <span class="sd"> - indices: a 1-D int64 NDArray with shape [D0] with values sorted in ascending order.</span> |
| |
| <span class="sd"> The `indices` stores the indices of the row slices with non-zeros,</span> |
| <span class="sd"> while the values are stored in `data`. The corresponding NDArray ``dense``</span> |
| <span class="sd"> represented by RowSparseNDArray ``rsp`` has</span> |
| |
| <span class="sd"> ``dense[rsp.indices[i], :, :, :, ...] = rsp.data[i, :, :, :, ...]``</span> |
| |
| <span class="sd"> >>> dense.asnumpy()</span> |
| <span class="sd"> array([[ 1., 2., 3.],</span> |
| <span class="sd"> [ 0., 0., 0.],</span> |
| <span class="sd"> [ 4., 0., 5.],</span> |
| <span class="sd"> [ 0., 0., 0.],</span> |
| <span class="sd"> [ 0., 0., 0.]], dtype=float32)</span> |
| <span class="sd"> >>> rsp = dense.tostype('row_sparse')</span> |
| <span class="sd"> >>> rsp.indices.asnumpy()</span> |
| <span class="sd"> array([0, 2], dtype=int64)</span> |
| <span class="sd"> >>> rsp.data.asnumpy()</span> |
| <span class="sd"> array([[ 1., 2., 3.],</span> |
| <span class="sd"> [ 4., 0., 5.]], dtype=float32)</span> |
| |
| <span class="sd"> A RowSparseNDArray is typically used to represent non-zero row slices of a large NDArray</span> |
| <span class="sd"> of shape [LARGE0, D1, .. , Dn] where LARGE0 >> D0 and most row slices are zeros.</span> |
| |
| <span class="sd"> RowSparseNDArray is used principally in the definition of gradients for operations</span> |
| <span class="sd"> that have sparse gradients (e.g. sparse dot and sparse embedding).</span> |
| |
| <span class="sd"> See Also</span> |
| <span class="sd"> --------</span> |
| <span class="sd"> row_sparse_array: Several ways to construct a RowSparseNDArray</span> |
| <span class="sd"> """</span> |
| <span class="k">def</span> <span class="nf">__reduce__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="k">return</span> <span class="n">RowSparseNDArray</span><span class="p">,</span> <span class="p">(</span><span class="kc">None</span><span class="p">,),</span> <span class="nb">super</span><span class="p">(</span><span class="n">RowSparseNDArray</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="n">__getstate__</span><span class="p">()</span> |
| |
| <span class="k">def</span> <span class="fm">__iadd__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">other</span><span class="p">):</span> |
| <span class="p">(</span><span class="bp">self</span> <span class="o">+</span> <span class="n">other</span><span class="p">)</span><span class="o">.</span><span class="n">copyto</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="k">def</span> <span class="fm">__isub__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">other</span><span class="p">):</span> |
| <span class="p">(</span><span class="bp">self</span> <span class="o">-</span> <span class="n">other</span><span class="p">)</span><span class="o">.</span><span class="n">copyto</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="k">def</span> <span class="fm">__imul__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">other</span><span class="p">):</span> |
| <span class="p">(</span><span class="bp">self</span> <span class="o">*</span> <span class="n">other</span><span class="p">)</span><span class="o">.</span><span class="n">copyto</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="k">def</span> <span class="nf">__idiv__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">other</span><span class="p">):</span> |
| <span class="p">(</span><span class="bp">self</span> <span class="o">/</span> <span class="n">other</span><span class="p">)</span><span class="o">.</span><span class="n">copyto</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="k">def</span> <span class="fm">__itruediv__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">other</span><span class="p">):</span> |
| <span class="p">(</span><span class="bp">self</span> <span class="o">/</span> <span class="n">other</span><span class="p">)</span><span class="o">.</span><span class="n">copyto</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="k">def</span> <span class="fm">__getitem__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">):</span> |
| <span class="w"> </span><span class="sd">"""x.__getitem__(i) <=> x[i]</span> |
| |
| <span class="sd"> Returns a sliced view of this array.</span> |
| |
| <span class="sd"> Parameters</span> |
| <span class="sd"> ----------</span> |
| <span class="sd"> key : mxnet.ndarray.NDArray.slice</span> |
| <span class="sd"> Indexing key.</span> |
| |
| <span class="sd"> Examples</span> |
| <span class="sd"> --------</span> |
| <span class="sd"> >>> x = mx.nd.sparse.zeros('row_sparse', (2, 3))</span> |
| <span class="sd"> >>> x[:].asnumpy()</span> |
| <span class="sd"> array([[ 0., 0., 0.],</span> |
| <span class="sd"> [ 0., 0., 0.]], dtype=float32)</span> |
| <span class="sd"> """</span> |
| <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="nb">int</span><span class="p">):</span> |
| <span class="k">raise</span> <span class="ne">Exception</span><span class="p">(</span><span class="s2">"__getitem__ with int key is not implemented for RowSparseNDArray yet"</span><span class="p">)</span> |
| <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="n">py_slice</span><span class="p">):</span> |
| <span class="k">if</span> <span class="n">key</span><span class="o">.</span><span class="n">step</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span> <span class="ow">or</span> <span class="n">key</span><span class="o">.</span><span class="n">start</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span> <span class="ow">or</span> <span class="n">key</span><span class="o">.</span><span class="n">stop</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">Exception</span><span class="p">(</span><span class="s1">'RowSparseNDArray only supports [:] for __getitem__'</span><span class="p">)</span> |
| |
| <span class="k">return</span> <span class="bp">self</span> |
| <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">key</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="s1">'Multi-dimension indexing is not supported'</span><span class="p">)</span> |
| <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s1">'Undefined behaviour for </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">key</span><span class="p">))</span> |
| |
| <span class="k">def</span> <span class="fm">__setitem__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span> |
| <span class="w"> </span><span class="sd">"""x.__setitem__(i, y) <=> x[i]=y</span> |
| |
| <span class="sd"> Set self[key] to value. Only slice key [:] is supported.</span> |
| |
| <span class="sd"> Parameters</span> |
| <span class="sd"> ----------</span> |
| <span class="sd"> key : mxnet.ndarray.NDArray.slice</span> |
| <span class="sd"> The indexing key.</span> |
| <span class="sd"> value : NDArray or numpy.ndarray</span> |
| <span class="sd"> The value to set.</span> |
| |
| <span class="sd"> Examples</span> |
| <span class="sd"> --------</span> |
| <span class="sd"> >>> src = mx.nd.row_sparse([[1, 0, 2], [4, 5, 6]], [0, 2], (3,3))</span> |
| <span class="sd"> >>> src.asnumpy()</span> |
| <span class="sd"> array([[ 1., 0., 2.],</span> |
| <span class="sd"> [ 0., 0., 0.],</span> |
| <span class="sd"> [ 4., 5., 6.]], dtype=float32)</span> |
| <span class="sd"> >>> # assign RowSparseNDArray with same storage type</span> |
| <span class="sd"> >>> x = mx.nd.sparse.zeros('row_sparse', (3,3))</span> |
| <span class="sd"> >>> x[:] = src</span> |
| <span class="sd"> >>> x.asnumpy()</span> |
| <span class="sd"> array([[ 1., 0., 2.],</span> |
| <span class="sd"> [ 0., 0., 0.],</span> |
| <span class="sd"> [ 4., 5., 6.]], dtype=float32)</span> |
| <span class="sd"> >>> # assign NDArray to RowSparseNDArray</span> |
| <span class="sd"> >>> x[:] = mx.nd.ones((3,3))</span> |
| <span class="sd"> >>> x.asnumpy()</span> |
| <span class="sd"> array([[ 1., 1., 1.],</span> |
| <span class="sd"> [ 1., 1., 1.],</span> |
| <span class="sd"> [ 1., 1., 1.]], dtype=float32)</span> |
| <span class="sd"> """</span> |
| <span class="c1"># pylint: disable= no-member, protected-access</span> |
| <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">writable</span><span class="p">:</span> |
| <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s1">'Failed to assign to a readonly RowSparseNDArray'</span><span class="p">)</span> |
| <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="n">py_slice</span><span class="p">):</span> |
| <span class="k">if</span> <span class="n">key</span><span class="o">.</span><span class="n">step</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span> <span class="ow">or</span> <span class="n">key</span><span class="o">.</span><span class="n">start</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span> <span class="ow">or</span> <span class="n">key</span><span class="o">.</span><span class="n">stop</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">'Assignment with slice for RowSparseNDArray '</span> \ |
| <span class="s1">'is not implmented yet.'</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">NDArray</span><span class="p">):</span> |
| <span class="c1"># avoid copying to itself</span> |
| <span class="k">if</span> <span class="n">value</span><span class="o">.</span><span class="n">handle</span> <span class="ow">is</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">handle</span><span class="p">:</span> |
| <span class="n">value</span><span class="o">.</span><span class="n">copyto</span><span class="p">(</span><span class="bp">self</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">numeric_types</span><span class="p">):</span> |
| <span class="n">_internal</span><span class="o">.</span><span class="n">_set_value</span><span class="p">(</span><span class="nb">float</span><span class="p">(</span><span class="n">value</span><span class="p">),</span> <span class="n">out</span><span class="o">=</span><span class="bp">self</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="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">ndarray</span><span class="p">,</span> <span class="n">np</span><span class="o">.</span><span class="n">generic</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">'Assigning non-NDArray object to RowSparseNDArray is not efficient'</span><span class="p">,</span> |
| <span class="ne">RuntimeWarning</span><span class="p">)</span> |
| <span class="n">tmp</span> <span class="o">=</span> <span class="n">_array</span><span class="p">(</span><span class="n">value</span><span class="p">)</span> |
| <span class="n">tmp</span><span class="o">.</span><span class="n">copyto</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> |
| <span class="k">else</span><span class="p">:</span> |
| <span class="k">raise</span> <span class="ne">TypeError</span><span class="p">(</span><span class="s1">'type </span><span class="si">%s</span><span class="s1"> not supported'</span> <span class="o">%</span> <span class="nb">str</span><span class="p">(</span><span class="nb">type</span><span class="p">(</span><span class="n">value</span><span class="p">)))</span> |
| <span class="k">else</span><span class="p">:</span> |
| <span class="k">assert</span><span class="p">(</span><span class="nb">isinstance</span><span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="p">(</span><span class="nb">int</span><span class="p">,</span> <span class="nb">tuple</span><span class="p">)))</span> |
| <span class="k">raise</span> <span class="ne">TypeError</span><span class="p">(</span><span class="s1">'RowSparseNDArray only supports [:] for assignment'</span><span class="p">)</span> |
| <span class="c1"># pylint: enable= no-member, protected-access</span> |
| |
| <span class="nd">@property</span> |
| <span class="k">def</span> <span class="nf">indices</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="w"> </span><span class="sd">"""A deep copy NDArray of the indices array of the RowSparseNDArray.</span> |
| <span class="sd"> This generates a deep copy of the row indices of the current `row_sparse` matrix.</span> |
| |
| <span class="sd"> Returns</span> |
| <span class="sd"> -------</span> |
| <span class="sd"> NDArray</span> |
| <span class="sd"> This RowSparseNDArray's indices array.</span> |
| <span class="sd"> """</span> |
| <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_aux_data</span><span class="p">(</span><span class="mi">0</span><span class="p">)</span> |
| |
| <span class="nd">@property</span> |
| <span class="k">def</span> <span class="nf">data</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="w"> </span><span class="sd">"""A deep copy NDArray of the data array of the RowSparseNDArray.</span> |
| <span class="sd"> This generates a deep copy of the `data` of the current `row_sparse` matrix.</span> |
| |
| <span class="sd"> Returns</span> |
| <span class="sd"> -------</span> |
| <span class="sd"> NDArray</span> |
| <span class="sd"> This RowSparseNDArray's data array.</span> |
| <span class="sd"> """</span> |
| <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_data</span><span class="p">()</span> |
| |
| <span class="nd">@indices</span><span class="o">.</span><span class="n">setter</span> |
| <span class="k">def</span> <span class="nf">indices</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">indices</span><span class="p">):</span> |
| <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span> |
| |
| <span class="nd">@data</span><span class="o">.</span><span class="n">setter</span> |
| <span class="k">def</span> <span class="nf">data</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">data</span><span class="p">):</span> |
| <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span> |
| |
| <div class="viewcode-block" id="RowSparseNDArray.tostype"><a class="viewcode-back" href="../../../api/ndarray/sparse/index.html#mxnet.ndarray.sparse.RowSparseNDArray.tostype">[docs]</a> <span class="k">def</span> <span class="nf">tostype</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">stype</span><span class="p">):</span> |
| <span class="w"> </span><span class="sd">"""Return a copy of the array with chosen storage type.</span> |
| |
| <span class="sd"> Returns</span> |
| <span class="sd"> -------</span> |
| <span class="sd"> NDArray or RowSparseNDArray</span> |
| <span class="sd"> A copy of the array with the chosen storage stype</span> |
| <span class="sd"> """</span> |
| <span class="c1"># pylint: disable= no-member, protected-access</span> |
| <span class="k">if</span> <span class="n">stype</span> <span class="o">==</span> <span class="s1">'csr'</span><span class="p">:</span> |
| <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s2">"cast_storage from row_sparse to csr is not supported"</span><span class="p">)</span> |
| <span class="k">return</span> <span class="n">op</span><span class="o">.</span><span class="n">cast_storage</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">stype</span><span class="o">=</span><span class="n">stype</span><span class="p">)</span></div> |
| <span class="c1"># pylint: enable= no-member, protected-access</span> |
| |
| <div class="viewcode-block" id="RowSparseNDArray.copyto"><a class="viewcode-back" href="../../../api/ndarray/sparse/index.html#mxnet.ndarray.sparse.RowSparseNDArray.copyto">[docs]</a> <span class="k">def</span> <span class="nf">copyto</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">other</span><span class="p">):</span> |
| <span class="w"> </span><span class="sd">"""Copies the value of this array to another array.</span> |
| |
| <span class="sd"> If ``other`` is a ``NDArray`` or ``RowSparseNDArray`` object, then ``other.shape``</span> |
| <span class="sd"> and ``self.shape`` should be the same. This function copies the value from</span> |
| <span class="sd"> ``self`` to ``other``.</span> |
| |
| <span class="sd"> If ``other`` is a context, a new ``RowSparseNDArray`` will be first created on</span> |
| <span class="sd"> the target context, and the value of ``self`` is copied.</span> |
| |
| <span class="sd"> Parameters</span> |
| <span class="sd"> ----------</span> |
| <span class="sd"> other : NDArray or RowSparseNDArray or Context</span> |
| <span class="sd"> The destination array or context.</span> |
| |
| <span class="sd"> Returns</span> |
| <span class="sd"> -------</span> |
| <span class="sd"> NDArray or RowSparseNDArray</span> |
| <span class="sd"> The copied array. If ``other`` is an ``NDArray`` or ``RowSparseNDArray``, then the</span> |
| <span class="sd"> return value and ``other`` will point to the same ``NDArray`` or ``RowSparseNDArray``.</span> |
| <span class="sd"> """</span> |
| <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">other</span><span class="p">,</span> <span class="n">Context</span><span class="p">):</span> |
| <span class="k">return</span> <span class="nb">super</span><span class="p">(</span><span class="n">RowSparseNDArray</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="n">copyto</span><span class="p">(</span><span class="n">other</span><span class="p">)</span> |
| <span class="k">elif</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">other</span><span class="p">,</span> <span class="n">NDArray</span><span class="p">):</span> |
| <span class="n">stype</span> <span class="o">=</span> <span class="n">other</span><span class="o">.</span><span class="n">stype</span> |
| <span class="k">if</span> <span class="n">stype</span> <span class="ow">in</span> <span class="p">(</span><span class="s1">'default'</span><span class="p">,</span> <span class="s1">'row_sparse'</span><span class="p">):</span> |
| <span class="k">return</span> <span class="nb">super</span><span class="p">(</span><span class="n">RowSparseNDArray</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="n">copyto</span><span class="p">(</span><span class="n">other</span><span class="p">)</span> |
| <span class="k">else</span><span class="p">:</span> |
| <span class="k">raise</span> <span class="ne">TypeError</span><span class="p">(</span><span class="s1">'copyto does not support destination NDArray stype '</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">stype</span><span class="p">))</span> |
| <span class="k">else</span><span class="p">:</span> |
| <span class="k">raise</span> <span class="ne">TypeError</span><span class="p">(</span><span class="s1">'copyto does not support type '</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="nb">type</span><span class="p">(</span><span class="n">other</span><span class="p">)))</span></div> |
| |
| <div class="viewcode-block" id="RowSparseNDArray.retain"><a class="viewcode-back" href="../../../api/ndarray/sparse/index.html#mxnet.ndarray.sparse.RowSparseNDArray.retain">[docs]</a> <span class="k">def</span> <span class="nf">retain</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="o">**</span><span class="n">kwargs</span><span class="p">):</span> |
| <span class="w"> </span><span class="sd">"""Convenience fluent method for :py:func:`retain`.</span> |
| |
| <span class="sd"> The arguments are the same as for :py:func:`retain`, with</span> |
| <span class="sd"> this array as data.</span> |
| <span class="sd"> """</span> |
| <span class="k">if</span> <span class="ow">not</span> <span class="n">gs_retain</span><span class="p">:</span> |
| <span class="k">raise</span> <span class="ne">ImportError</span><span class="p">(</span><span class="s2">"gen_sparse could not be imported"</span><span class="p">)</span> |
| <span class="k">return</span> <span class="n">gs_retain</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></div></div> |
| |
| <span class="k">def</span> <span class="nf">_prepare_src_array</span><span class="p">(</span><span class="n">source_array</span><span class="p">,</span> <span class="n">dtype</span><span class="p">):</span> |
| <span class="w"> </span><span class="sd">"""Prepare `source_array` so that it can be used to construct NDArray.</span> |
| <span class="sd"> `source_array` is converted to a `np.ndarray` if it's neither an `NDArray` \</span> |
| <span class="sd"> nor an `np.ndarray`.</span> |
| <span class="sd"> """</span> |
| <span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">source_array</span><span class="p">,</span> <span class="n">NDArray</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">source_array</span><span class="p">,</span> <span class="n">np</span><span class="o">.</span><span class="n">ndarray</span><span class="p">):</span> |
| <span class="k">try</span><span class="p">:</span> |
| <span class="n">source_array</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">array</span><span class="p">(</span><span class="n">source_array</span><span class="p">,</span> <span class="n">dtype</span><span class="o">=</span><span class="n">dtype</span><span class="p">)</span> |
| <span class="k">except</span><span class="p">:</span> |
| <span class="k">raise</span> <span class="ne">TypeError</span><span class="p">(</span><span class="s1">'values must be array like object'</span><span class="p">)</span> |
| <span class="k">return</span> <span class="n">source_array</span> |
| |
| <span class="k">def</span> <span class="nf">_prepare_default_dtype</span><span class="p">(</span><span class="n">src_array</span><span class="p">,</span> <span class="n">dtype</span><span class="p">):</span> |
| <span class="w"> </span><span class="sd">"""Prepare the value of dtype if `dtype` is None. If `src_array` is an NDArray, numpy.ndarray</span> |
| <span class="sd"> or scipy.sparse.csr.csr_matrix, return src_array.dtype. float32 is returned otherwise."""</span> |
| <span class="k">if</span> <span class="n">dtype</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span> |
| <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">src_array</span><span class="p">,</span> <span class="p">(</span><span class="n">NDArray</span><span class="p">,</span> <span class="n">np</span><span class="o">.</span><span class="n">ndarray</span><span class="p">)):</span> |
| <span class="n">dtype</span> <span class="o">=</span> <span class="n">src_array</span><span class="o">.</span><span class="n">dtype</span> |
| <span class="k">elif</span> <span class="n">spsp</span> <span class="ow">and</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">src_array</span><span class="p">,</span> <span class="n">spsp</span><span class="o">.</span><span class="n">csr</span><span class="o">.</span><span class="n">csr_matrix</span><span class="p">):</span> |
| <span class="n">dtype</span> <span class="o">=</span> <span class="n">src_array</span><span class="o">.</span><span class="n">dtype</span> |
| <span class="k">else</span><span class="p">:</span> |
| <span class="n">dtype</span> <span class="o">=</span> <span class="n">mx_real_t</span> |
| <span class="k">return</span> <span class="n">dtype</span> |
| |
| <span class="k">def</span> <span class="nf">_check_shape</span><span class="p">(</span><span class="n">s1</span><span class="p">,</span> <span class="n">s2</span><span class="p">):</span> |
| <span class="w"> </span><span class="sd">"""check s1 == s2 if both are not None"""</span> |
| <span class="k">if</span> <span class="n">s1</span> <span class="ow">and</span> <span class="n">s2</span> <span class="ow">and</span> <span class="n">s1</span> <span class="o">!=</span> <span class="n">s2</span><span class="p">:</span> |
| <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s2">"Shape mismatch detected. "</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">s1</span><span class="p">)</span> <span class="o">+</span> <span class="s2">" v.s. "</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">s2</span><span class="p">))</span> |
| |
| <div class="viewcode-block" id="csr_matrix"><a class="viewcode-back" href="../../../api/ndarray/sparse/index.html#mxnet.ndarray.sparse.csr_matrix">[docs]</a><span class="k">def</span> <span class="nf">csr_matrix</span><span class="p">(</span><span class="n">arg1</span><span class="p">,</span> <span class="n">shape</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">dtype</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span> |
| <span class="w"> </span><span class="sd">"""Creates a `CSRNDArray`, an 2D array with compressed sparse row (CSR) format.</span> |
| |
| <span class="sd"> The CSRNDArray can be instantiated in several ways:</span> |
| |
| <span class="sd"> - csr_matrix(D):</span> |
| <span class="sd"> to construct a CSRNDArray with a dense 2D array ``D``</span> |
| <span class="sd"> - **D** (*array_like*) - An object exposing the array interface, an object whose \</span> |
| <span class="sd"> `__array__` method returns an array, or any (nested) sequence.</span> |
| <span class="sd"> - **ctx** (*Context, optional*) - Device context \</span> |
| <span class="sd"> (default is the current default context).</span> |
| <span class="sd"> - **dtype** (*str or numpy.dtype, optional*) - The data type of the output array. \</span> |
| <span class="sd"> The default dtype is ``D.dtype`` if ``D`` is an NDArray or numpy.ndarray, \</span> |
| <span class="sd"> float32 otherwise.</span> |
| |
| <span class="sd"> - csr_matrix(S)</span> |
| <span class="sd"> to construct a CSRNDArray with a sparse 2D array ``S``</span> |
| <span class="sd"> - **S** (*CSRNDArray or scipy.sparse.csr.csr_matrix*) - A sparse matrix.</span> |
| <span class="sd"> - **ctx** (*Context, optional*) - Device context \</span> |
| <span class="sd"> (default is the current default context).</span> |
| <span class="sd"> - **dtype** (*str or numpy.dtype, optional*) - The data type of the output array. \</span> |
| <span class="sd"> The default dtype is ``S.dtype``.</span> |
| |
| <span class="sd"> - csr_matrix((M, N))</span> |
| <span class="sd"> to construct an empty CSRNDArray with shape ``(M, N)``</span> |
| <span class="sd"> - **M** (*int*) - Number of rows in the matrix</span> |
| <span class="sd"> - **N** (*int*) - Number of columns in the matrix</span> |
| <span class="sd"> - **ctx** (*Context, optional*) - Device context \</span> |
| <span class="sd"> (default is the current default context).</span> |
| <span class="sd"> - **dtype** (*str or numpy.dtype, optional*) - The data type of the output array. \</span> |
| <span class="sd"> The default dtype is float32.</span> |
| |
| <span class="sd"> - csr_matrix((data, indices, indptr))</span> |
| <span class="sd"> to construct a CSRNDArray based on the definition of compressed sparse row format \</span> |
| <span class="sd"> using three separate arrays, \</span> |
| <span class="sd"> where the column indices for row i are stored in ``indices[indptr[i]:indptr[i+1]]`` \</span> |
| <span class="sd"> and their corresponding values are stored in ``data[indptr[i]:indptr[i+1]]``. \</span> |
| <span class="sd"> The column indices for a given row are expected to be **sorted in ascending order.** \</span> |
| <span class="sd"> Duplicate column entries for the same row are not allowed.</span> |
| <span class="sd"> - **data** (*array_like*) - An object exposing the array interface, which \</span> |
| <span class="sd"> holds all the non-zero entries of the matrix in row-major order.</span> |
| <span class="sd"> - **indices** (*array_like*) - An object exposing the array interface, which \</span> |
| <span class="sd"> stores the column index for each non-zero element in ``data``.</span> |
| <span class="sd"> - **indptr** (*array_like*) - An object exposing the array interface, which \</span> |
| <span class="sd"> stores the offset into ``data`` of the first non-zero element number of each \</span> |
| <span class="sd"> row of the matrix.</span> |
| <span class="sd"> - **shape** (*tuple of int, optional*) - The shape of the array. The default \</span> |
| <span class="sd"> shape is inferred from the indices and indptr arrays.</span> |
| <span class="sd"> - **ctx** (*Context, optional*) - Device context \</span> |
| <span class="sd"> (default is the current default context).</span> |
| <span class="sd"> - **dtype** (*str or numpy.dtype, optional*) - The data type of the output array. \</span> |
| <span class="sd"> The default dtype is ``data.dtype`` if ``data`` is an NDArray or numpy.ndarray, \</span> |
| <span class="sd"> float32 otherwise.</span> |
| |
| <span class="sd"> - csr_matrix((data, (row, col)))</span> |
| <span class="sd"> to construct a CSRNDArray based on the COOrdinate format \</span> |
| <span class="sd"> using three seperate arrays, \</span> |
| <span class="sd"> where ``row[i]`` is the row index of the element, \</span> |
| <span class="sd"> ``col[i]`` is the column index of the element \</span> |
| <span class="sd"> and ``data[i]`` is the data corresponding to the element. All the missing \</span> |
| <span class="sd"> elements in the input are taken to be zeroes.</span> |
| <span class="sd"> - **data** (*array_like*) - An object exposing the array interface, which \</span> |
| <span class="sd"> holds all the non-zero entries of the matrix in COO format.</span> |
| <span class="sd"> - **row** (*array_like*) - An object exposing the array interface, which \</span> |
| <span class="sd"> stores the row index for each non zero element in ``data``.</span> |
| <span class="sd"> - **col** (*array_like*) - An object exposing the array interface, which \</span> |
| <span class="sd"> stores the col index for each non zero element in ``data``.</span> |
| <span class="sd"> - **shape** (*tuple of int, optional*) - The shape of the array. The default \</span> |
| <span class="sd"> shape is inferred from the ``row`` and ``col`` arrays.</span> |
| <span class="sd"> - **ctx** (*Context, optional*) - Device context \</span> |
| <span class="sd"> (default is the current default context).</span> |
| <span class="sd"> - **dtype** (*str or numpy.dtype, optional*) - The data type of the output array. \</span> |
| <span class="sd"> The default dtype is float32.</span> |
| |
| <span class="sd"> Parameters</span> |
| <span class="sd"> ----------</span> |
| <span class="sd"> arg1: tuple of int, tuple of array_like, array_like, CSRNDArray, scipy.sparse.csr_matrix, \</span> |
| <span class="sd"> scipy.sparse.coo_matrix, tuple of int or tuple of array_like</span> |
| <span class="sd"> The argument to help instantiate the csr matrix. See above for further details.</span> |
| <span class="sd"> shape : tuple of int, optional</span> |
| <span class="sd"> The shape of the csr matrix.</span> |
| <span class="sd"> ctx: Context, optional</span> |
| <span class="sd"> Device context (default is the current default context).</span> |
| <span class="sd"> dtype: str or numpy.dtype, optional</span> |
| <span class="sd"> The data type of the output array.</span> |
| |
| <span class="sd"> Returns</span> |
| <span class="sd"> -------</span> |
| <span class="sd"> CSRNDArray</span> |
| <span class="sd"> A `CSRNDArray` with the `csr` storage representation.</span> |
| |
| <span class="sd"> Example</span> |
| <span class="sd"> -------</span> |
| <span class="sd"> >>> a = mx.nd.sparse.csr_matrix(([1, 2, 3], [1, 0, 2], [0, 1, 2, 2, 3]), shape=(4, 3))</span> |
| <span class="sd"> >>> a.asnumpy()</span> |
| <span class="sd"> array([[ 0., 1., 0.],</span> |
| <span class="sd"> [ 2., 0., 0.],</span> |
| <span class="sd"> [ 0., 0., 0.],</span> |
| <span class="sd"> [ 0., 0., 3.]], dtype=float32)</span> |
| |
| <span class="sd"> See Also</span> |
| <span class="sd"> --------</span> |
| <span class="sd"> CSRNDArray : MXNet NDArray in compressed sparse row format.</span> |
| <span class="sd"> """</span> |
| <span class="c1"># construct a csr matrix from (M, N) or (data, indices, indptr)</span> |
| <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">arg1</span><span class="p">,</span> <span class="nb">tuple</span><span class="p">):</span> |
| <span class="n">arg_len</span> <span class="o">=</span> <span class="nb">len</span><span class="p">(</span><span class="n">arg1</span><span class="p">)</span> |
| <span class="k">if</span> <span class="n">arg_len</span> <span class="o">==</span> <span class="mi">2</span><span class="p">:</span> |
| <span class="c1"># construct a sparse csr matrix from</span> |
| <span class="c1"># scipy coo matrix if input format is coo</span> |
| <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">arg1</span><span class="p">[</span><span class="mi">1</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">arg1</span><span class="p">[</span><span class="mi">1</span><span class="p">])</span> <span class="o">==</span> <span class="mi">2</span><span class="p">:</span> |
| <span class="n">data</span><span class="p">,</span> <span class="p">(</span><span class="n">row</span><span class="p">,</span> <span class="n">col</span><span class="p">)</span> <span class="o">=</span> <span class="n">arg1</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="n">NDArray</span><span class="p">):</span> |
| <span class="n">data</span> <span class="o">=</span> <span class="n">data</span><span class="o">.</span><span class="n">asnumpy</span><span class="p">()</span> |
| <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">row</span><span class="p">,</span> <span class="n">NDArray</span><span class="p">):</span> |
| <span class="n">row</span> <span class="o">=</span> <span class="n">row</span><span class="o">.</span><span class="n">asnumpy</span><span class="p">()</span> |
| <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">col</span><span class="p">,</span> <span class="n">NDArray</span><span class="p">):</span> |
| <span class="n">col</span> <span class="o">=</span> <span class="n">col</span><span class="o">.</span><span class="n">asnumpy</span><span class="p">()</span> |
| <span class="k">if</span> <span class="ow">not</span> <span class="n">spsp</span><span class="p">:</span> |
| <span class="k">raise</span> <span class="ne">ImportError</span><span class="p">(</span><span class="s2">"scipy could not be imported. "</span> |
| <span class="s2">"Please make sure that the scipy is installed."</span><span class="p">)</span> |
| <span class="n">coo</span> <span class="o">=</span> <span class="n">spsp</span><span class="o">.</span><span class="n">coo_matrix</span><span class="p">((</span><span class="n">data</span><span class="p">,</span> <span class="p">(</span><span class="n">row</span><span class="p">,</span> <span class="n">col</span><span class="p">)),</span> <span class="n">shape</span><span class="o">=</span><span class="n">shape</span><span class="p">)</span> |
| <span class="n">_check_shape</span><span class="p">(</span><span class="n">coo</span><span class="o">.</span><span class="n">shape</span><span class="p">,</span> <span class="n">shape</span><span class="p">)</span> |
| <span class="n">csr</span> <span class="o">=</span> <span class="n">coo</span><span class="o">.</span><span class="n">tocsr</span><span class="p">()</span> |
| <span class="k">return</span> <span class="n">array</span><span class="p">(</span><span class="n">csr</span><span class="p">,</span> <span class="n">ctx</span><span class="o">=</span><span class="n">ctx</span><span class="p">,</span> <span class="n">dtype</span><span class="o">=</span><span class="n">dtype</span><span class="p">)</span> |
| <span class="k">else</span><span class="p">:</span> |
| <span class="c1"># empty matrix with shape</span> |
| <span class="n">_check_shape</span><span class="p">(</span><span class="n">arg1</span><span class="p">,</span> <span class="n">shape</span><span class="p">)</span> |
| <span class="k">return</span> <span class="n">empty</span><span class="p">(</span><span class="s1">'csr'</span><span class="p">,</span> <span class="n">arg1</span><span class="p">,</span> <span class="n">ctx</span><span class="o">=</span><span class="n">ctx</span><span class="p">,</span> <span class="n">dtype</span><span class="o">=</span><span class="n">dtype</span><span class="p">)</span> |
| <span class="k">elif</span> <span class="n">arg_len</span> <span class="o">==</span> <span class="mi">3</span><span class="p">:</span> |
| <span class="c1"># data, indices, indptr</span> |
| <span class="k">return</span> <span class="n">_csr_matrix_from_definition</span><span class="p">(</span><span class="n">arg1</span><span class="p">[</span><span class="mi">0</span><span class="p">],</span> <span class="n">arg1</span><span class="p">[</span><span class="mi">1</span><span class="p">],</span> <span class="n">arg1</span><span class="p">[</span><span class="mi">2</span><span class="p">],</span> <span class="n">shape</span><span class="o">=</span><span class="n">shape</span><span class="p">,</span> |
| <span class="n">ctx</span><span class="o">=</span><span class="n">ctx</span><span class="p">,</span> <span class="n">dtype</span><span class="o">=</span><span class="n">dtype</span><span class="p">)</span> |
| <span class="k">else</span><span class="p">:</span> |
| <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s2">"Unexpected length of input tuple: "</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">arg_len</span><span class="p">))</span> |
| <span class="k">else</span><span class="p">:</span> |
| <span class="c1"># construct a csr matrix from a sparse / dense one</span> |
| <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">arg1</span><span class="p">,</span> <span class="n">CSRNDArray</span><span class="p">)</span> <span class="ow">or</span> <span class="p">(</span><span class="n">spsp</span> <span class="ow">and</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">arg1</span><span class="p">,</span> <span class="n">spsp</span><span class="o">.</span><span class="n">csr</span><span class="o">.</span><span class="n">csr_matrix</span><span class="p">)):</span> |
| <span class="c1"># construct a csr matrix from scipy or CSRNDArray</span> |
| <span class="n">_check_shape</span><span class="p">(</span><span class="n">arg1</span><span class="o">.</span><span class="n">shape</span><span class="p">,</span> <span class="n">shape</span><span class="p">)</span> |
| <span class="k">return</span> <span class="n">array</span><span class="p">(</span><span class="n">arg1</span><span class="p">,</span> <span class="n">ctx</span><span class="o">=</span><span class="n">ctx</span><span class="p">,</span> <span class="n">dtype</span><span class="o">=</span><span class="n">dtype</span><span class="p">)</span> |
| <span class="k">elif</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">arg1</span><span class="p">,</span> <span class="n">RowSparseNDArray</span><span class="p">):</span> |
| <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s2">"Unexpected input type: RowSparseNDArray"</span><span class="p">)</span> |
| <span class="k">else</span><span class="p">:</span> |
| <span class="c1"># construct a csr matrix from a dense one</span> |
| <span class="c1"># prepare default ctx and dtype since mx.nd.array doesn't use default values</span> |
| <span class="c1"># based on source_array</span> |
| <span class="n">dtype</span> <span class="o">=</span> <span class="n">_prepare_default_dtype</span><span class="p">(</span><span class="n">arg1</span><span class="p">,</span> <span class="n">dtype</span><span class="p">)</span> |
| <span class="c1"># create dns array with provided dtype. ctx is not passed since copy across</span> |
| <span class="c1"># ctx requires dtype to be the same</span> |
| <span class="n">dns</span> <span class="o">=</span> <span class="n">_array</span><span class="p">(</span><span class="n">arg1</span><span class="p">,</span> <span class="n">dtype</span><span class="o">=</span><span class="n">dtype</span><span class="p">)</span> |
| <span class="k">if</span> <span class="n">ctx</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span> <span class="ow">and</span> <span class="n">dns</span><span class="o">.</span><span class="n">context</span> <span class="o">!=</span> <span class="n">ctx</span><span class="p">:</span> |
| <span class="n">dns</span> <span class="o">=</span> <span class="n">dns</span><span class="o">.</span><span class="n">as_in_context</span><span class="p">(</span><span class="n">ctx</span><span class="p">)</span> |
| <span class="n">_check_shape</span><span class="p">(</span><span class="n">dns</span><span class="o">.</span><span class="n">shape</span><span class="p">,</span> <span class="n">shape</span><span class="p">)</span> |
| <span class="k">return</span> <span class="n">dns</span><span class="o">.</span><span class="n">tostype</span><span class="p">(</span><span class="s1">'csr'</span><span class="p">)</span></div> |
| |
| <span class="k">def</span> <span class="nf">_csr_matrix_from_definition</span><span class="p">(</span><span class="n">data</span><span class="p">,</span> <span class="n">indices</span><span class="p">,</span> <span class="n">indptr</span><span class="p">,</span> <span class="n">shape</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">dtype</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">indices_type</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">indptr_type</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span> |
| <span class="w"> </span><span class="sd">"""Create a `CSRNDArray` based on data, indices and indptr"""</span> |
| <span class="c1"># pylint: disable= no-member, protected-access</span> |
| <span class="n">storage_type</span> <span class="o">=</span> <span class="s1">'csr'</span> |
| <span class="c1"># context</span> |
| <span class="n">ctx</span> <span class="o">=</span> <span class="n">current_context</span><span class="p">()</span> <span class="k">if</span> <span class="n">ctx</span> <span class="ow">is</span> <span class="kc">None</span> <span class="k">else</span> <span class="n">ctx</span> |
| <span class="c1"># types</span> |
| <span class="n">dtype</span> <span class="o">=</span> <span class="n">_prepare_default_dtype</span><span class="p">(</span><span class="n">data</span><span class="p">,</span> <span class="n">dtype</span><span class="p">)</span> |
| <span class="n">indptr_type</span> <span class="o">=</span> <span class="n">_STORAGE_AUX_TYPES</span><span class="p">[</span><span class="n">storage_type</span><span class="p">][</span><span class="mi">0</span><span class="p">]</span> <span class="k">if</span> <span class="n">indptr_type</span> <span class="ow">is</span> <span class="kc">None</span> <span class="k">else</span> <span class="n">indptr_type</span> |
| <span class="n">indices_type</span> <span class="o">=</span> <span class="n">_STORAGE_AUX_TYPES</span><span class="p">[</span><span class="n">storage_type</span><span class="p">][</span><span class="mi">1</span><span class="p">]</span> <span class="k">if</span> <span class="n">indices_type</span> <span class="ow">is</span> <span class="kc">None</span> <span class="k">else</span> <span class="n">indices_type</span> |
| <span class="c1"># prepare src array and types</span> |
| <span class="n">data</span> <span class="o">=</span> <span class="n">_prepare_src_array</span><span class="p">(</span><span class="n">data</span><span class="p">,</span> <span class="n">dtype</span><span class="p">)</span> |
| <span class="n">indptr</span> <span class="o">=</span> <span class="n">_prepare_src_array</span><span class="p">(</span><span class="n">indptr</span><span class="p">,</span> <span class="n">indptr_type</span><span class="p">)</span> |
| <span class="n">indices</span> <span class="o">=</span> <span class="n">_prepare_src_array</span><span class="p">(</span><span class="n">indices</span><span class="p">,</span> <span class="n">indices_type</span><span class="p">)</span> |
| |
| <span class="c1"># TODO(junwu): Convert data, indptr, and indices to mxnet NDArrays</span> |
| <span class="c1"># if they are not for now. In the future, we should provide a c-api</span> |
| <span class="c1"># to accept np.ndarray types to copy from to result.data and aux_data</span> |
| <span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">data</span><span class="p">,</span> <span class="n">NDArray</span><span class="p">):</span> |
| <span class="n">data</span> <span class="o">=</span> <span class="n">_array</span><span class="p">(</span><span class="n">data</span><span class="p">,</span> <span class="n">ctx</span><span class="p">,</span> <span class="n">dtype</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">indptr</span><span class="p">,</span> <span class="n">NDArray</span><span class="p">):</span> |
| <span class="n">indptr</span> <span class="o">=</span> <span class="n">_array</span><span class="p">(</span><span class="n">indptr</span><span class="p">,</span> <span class="n">ctx</span><span class="p">,</span> <span class="n">indptr_type</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">indices</span><span class="p">,</span> <span class="n">NDArray</span><span class="p">):</span> |
| <span class="n">indices</span> <span class="o">=</span> <span class="n">_array</span><span class="p">(</span><span class="n">indices</span><span class="p">,</span> <span class="n">ctx</span><span class="p">,</span> <span class="n">indices_type</span><span class="p">)</span> |
| <span class="k">if</span> <span class="n">shape</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span> |
| <span class="k">if</span> <span class="n">indices</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span> |
| <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s1">'invalid shape'</span><span class="p">)</span> |
| <span class="n">shape</span> <span class="o">=</span> <span class="p">(</span><span class="nb">len</span><span class="p">(</span><span class="n">indptr</span><span class="p">)</span> <span class="o">-</span> <span class="mi">1</span><span class="p">,</span> <span class="n">op</span><span class="o">.</span><span class="n">max</span><span class="p">(</span><span class="n">indices</span><span class="p">)</span><span class="o">.</span><span class="n">asscalar</span><span class="p">()</span> <span class="o">+</span> <span class="mi">1</span><span class="p">)</span> |
| <span class="c1"># verify shapes</span> |
| <span class="n">aux_shapes</span> <span class="o">=</span> <span class="p">[</span><span class="n">indptr</span><span class="o">.</span><span class="n">shape</span><span class="p">,</span> <span class="n">indices</span><span class="o">.</span><span class="n">shape</span><span class="p">]</span> |
| <span class="k">if</span> <span class="n">data</span><span class="o">.</span><span class="n">ndim</span> <span class="o">!=</span> <span class="mi">1</span> <span class="ow">or</span> <span class="n">indptr</span><span class="o">.</span><span class="n">ndim</span> <span class="o">!=</span> <span class="mi">1</span> <span class="ow">or</span> <span class="n">indices</span><span class="o">.</span><span class="n">ndim</span> <span class="o">!=</span> <span class="mi">1</span> <span class="ow">or</span> \ |
| <span class="n">indptr</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">==</span> <span class="mi">0</span> <span class="ow">or</span> <span class="nb">len</span><span class="p">(</span><span class="n">shape</span><span class="p">)</span> <span class="o">!=</span> <span class="mi">2</span><span class="p">:</span> |
| <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s1">'invalid shape'</span><span class="p">)</span> |
| <span class="n">result</span> <span class="o">=</span> <span class="n">CSRNDArray</span><span class="p">(</span><span class="n">_new_alloc_handle</span><span class="p">(</span><span class="n">storage_type</span><span class="p">,</span> <span class="n">shape</span><span class="p">,</span> <span class="n">ctx</span><span class="p">,</span> <span class="kc">False</span><span class="p">,</span> <span class="n">dtype</span><span class="p">,</span> |
| <span class="p">[</span><span class="n">indptr_type</span><span class="p">,</span> <span class="n">indices_type</span><span class="p">],</span> <span class="n">aux_shapes</span><span class="p">))</span> |
| <span class="n">check_call</span><span class="p">(</span><span class="n">_LIB</span><span class="o">.</span><span class="n">MXNDArraySyncCopyFromNDArray</span><span class="p">(</span><span class="n">result</span><span class="o">.</span><span class="n">handle</span><span class="p">,</span> <span class="n">data</span><span class="o">.</span><span class="n">handle</span><span class="p">,</span> <span class="n">ctypes</span><span class="o">.</span><span class="n">c_int</span><span class="p">(</span><span class="o">-</span><span class="mi">1</span><span class="p">)))</span> |
| <span class="n">check_call</span><span class="p">(</span><span class="n">_LIB</span><span class="o">.</span><span class="n">MXNDArraySyncCopyFromNDArray</span><span class="p">(</span><span class="n">result</span><span class="o">.</span><span class="n">handle</span><span class="p">,</span> <span class="n">indptr</span><span class="o">.</span><span class="n">handle</span><span class="p">,</span> <span class="n">ctypes</span><span class="o">.</span><span class="n">c_int</span><span class="p">(</span><span class="mi">0</span><span class="p">)))</span> |
| <span class="n">check_call</span><span class="p">(</span><span class="n">_LIB</span><span class="o">.</span><span class="n">MXNDArraySyncCopyFromNDArray</span><span class="p">(</span><span class="n">result</span><span class="o">.</span><span class="n">handle</span><span class="p">,</span> <span class="n">indices</span><span class="o">.</span><span class="n">handle</span><span class="p">,</span> <span class="n">ctypes</span><span class="o">.</span><span class="n">c_int</span><span class="p">(</span><span class="mi">1</span><span class="p">)))</span> |
| <span class="k">return</span> <span class="n">result</span> |
| <span class="c1"># pylint: enable= no-member, protected-access</span> |
| |
| <div class="viewcode-block" id="row_sparse_array"><a class="viewcode-back" href="../../../api/ndarray/sparse/index.html#mxnet.ndarray.sparse.row_sparse_array">[docs]</a><span class="k">def</span> <span class="nf">row_sparse_array</span><span class="p">(</span><span class="n">arg1</span><span class="p">,</span> <span class="n">shape</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">dtype</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span> |
| <span class="w"> </span><span class="sd">"""Creates a `RowSparseNDArray`, a multidimensional row sparse array with a set of \</span> |
| <span class="sd"> tensor slices at given indices.</span> |
| |
| <span class="sd"> The RowSparseNDArray can be instantiated in several ways:</span> |
| |
| <span class="sd"> - row_sparse_array(D):</span> |
| <span class="sd"> to construct a RowSparseNDArray with a dense ndarray ``D``</span> |
| <span class="sd"> - **D** (*array_like*) - An object exposing the array interface, an object whose \</span> |
| <span class="sd"> `__array__` method returns an array, or any (nested) sequence.</span> |
| <span class="sd"> - **ctx** (*Context, optional*) - Device context \</span> |
| <span class="sd"> (default is the current default context).</span> |
| <span class="sd"> - **dtype** (*str or numpy.dtype, optional*) - The data type of the output array. \</span> |
| <span class="sd"> The default dtype is ``D.dtype`` if ``D`` is an NDArray or numpy.ndarray, \</span> |
| <span class="sd"> float32 otherwise.</span> |
| |
| <span class="sd"> - row_sparse_array(S)</span> |
| <span class="sd"> to construct a RowSparseNDArray with a sparse ndarray ``S``</span> |
| <span class="sd"> - **S** (*RowSparseNDArray*) - A sparse ndarray.</span> |
| <span class="sd"> - **ctx** (*Context, optional*) - Device context \</span> |
| <span class="sd"> (default is the current default context).</span> |
| <span class="sd"> - **dtype** (*str or numpy.dtype, optional*) - The data type of the output array. \</span> |
| <span class="sd"> The default dtype is ``S.dtype``.</span> |
| |
| <span class="sd"> - row_sparse_array((D0, D1 .. Dn))</span> |
| <span class="sd"> to construct an empty RowSparseNDArray with shape ``(D0, D1, ... Dn)``</span> |
| <span class="sd"> - **D0, D1 .. Dn** (*int*) - The shape of the ndarray</span> |
| <span class="sd"> - **ctx** (*Context, optional*) - Device context \</span> |
| <span class="sd"> (default is the current default context).</span> |
| <span class="sd"> - **dtype** (*str or numpy.dtype, optional*) - The data type of the output array. \</span> |
| <span class="sd"> The default dtype is float32.</span> |
| |
| <span class="sd"> - row_sparse_array((data, indices))</span> |
| <span class="sd"> to construct a RowSparseNDArray based on the definition of row sparse format \</span> |
| <span class="sd"> using two separate arrays, \</span> |
| <span class="sd"> where the `indices` stores the indices of the row slices with non-zeros,</span> |
| <span class="sd"> while the values are stored in `data`. The corresponding NDArray ``dense``</span> |
| <span class="sd"> represented by RowSparseNDArray ``rsp`` has \</span> |
| <span class="sd"> ``dense[rsp.indices[i], :, :, :, ...] = rsp.data[i, :, :, :, ...]``</span> |
| <span class="sd"> The row indices for are expected to be **sorted in ascending order.** \</span> |
| <span class="sd"> - **data** (*array_like*) - An object exposing the array interface, which \</span> |
| <span class="sd"> holds all the non-zero row slices of the array.</span> |
| <span class="sd"> - **indices** (*array_like*) - An object exposing the array interface, which \</span> |
| <span class="sd"> stores the row index for each row slice with non-zero elements.</span> |
| <span class="sd"> - **shape** (*tuple of int, optional*) - The shape of the array. The default \</span> |
| <span class="sd"> shape is inferred from the indices and indptr arrays.</span> |
| <span class="sd"> - **ctx** (*Context, optional*) - Device context \</span> |
| <span class="sd"> (default is the current default context).</span> |
| <span class="sd"> - **dtype** (*str or numpy.dtype, optional*) - The data type of the output array. \</span> |
| <span class="sd"> The default dtype is float32.</span> |
| |
| <span class="sd"> Parameters</span> |
| <span class="sd"> ----------</span> |
| <span class="sd"> arg1 : NDArray, numpy.ndarray, RowSparseNDArray, tuple of int or tuple of array_like</span> |
| <span class="sd"> The argument to help instantiate the row sparse ndarray. See above for further details.</span> |
| <span class="sd"> shape : tuple of int, optional</span> |
| <span class="sd"> The shape of the row sparse ndarray. (Default value = None)</span> |
| <span class="sd"> ctx : Context, optional</span> |
| <span class="sd"> Device context (default is the current default context).</span> |
| <span class="sd"> dtype : str or numpy.dtype, optional</span> |
| <span class="sd"> The data type of the output array. (Default value = None)</span> |
| |
| <span class="sd"> Returns</span> |
| <span class="sd"> -------</span> |
| <span class="sd"> RowSparseNDArray</span> |
| <span class="sd"> An `RowSparseNDArray` with the `row_sparse` storage representation.</span> |
| |
| <span class="sd"> Examples</span> |
| <span class="sd"> --------</span> |
| <span class="sd"> >>> a = mx.nd.sparse.row_sparse_array(([[1, 2], [3, 4]], [1, 4]), shape=(6, 2))</span> |
| <span class="sd"> >>> a.asnumpy()</span> |
| <span class="sd"> array([[ 0., 0.],</span> |
| <span class="sd"> [ 1., 2.],</span> |
| <span class="sd"> [ 0., 0.],</span> |
| <span class="sd"> [ 0., 0.],</span> |
| <span class="sd"> [ 3., 4.],</span> |
| <span class="sd"> [ 0., 0.]], dtype=float32)</span> |
| |
| <span class="sd"> See Also</span> |
| <span class="sd"> --------</span> |
| <span class="sd"> RowSparseNDArray : MXNet NDArray in row sparse format.</span> |
| <span class="sd"> """</span> |
| <span class="c1"># construct a row sparse array from (D0, D1 ..) or (data, indices)</span> |
| <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">arg1</span><span class="p">,</span> <span class="nb">tuple</span><span class="p">):</span> |
| <span class="n">arg_len</span> <span class="o">=</span> <span class="nb">len</span><span class="p">(</span><span class="n">arg1</span><span class="p">)</span> |
| <span class="k">if</span> <span class="n">arg_len</span> <span class="o"><</span> <span class="mi">2</span><span class="p">:</span> |
| <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s2">"Unexpected length of input tuple: "</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">arg_len</span><span class="p">))</span> |
| <span class="k">if</span> <span class="n">arg_len</span> <span class="o">></span> <span class="mi">2</span><span class="p">:</span> |
| <span class="c1"># empty ndarray with shape</span> |
| <span class="n">_check_shape</span><span class="p">(</span><span class="n">arg1</span><span class="p">,</span> <span class="n">shape</span><span class="p">)</span> |
| <span class="k">return</span> <span class="n">empty</span><span class="p">(</span><span class="s1">'row_sparse'</span><span class="p">,</span> <span class="n">arg1</span><span class="p">,</span> <span class="n">ctx</span><span class="o">=</span><span class="n">ctx</span><span class="p">,</span> <span class="n">dtype</span><span class="o">=</span><span class="n">dtype</span><span class="p">)</span> |
| <span class="k">else</span><span class="p">:</span> |
| <span class="c1"># len(arg1) = 2, is either shape or (data, indices)</span> |
| <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">arg1</span><span class="p">[</span><span class="mi">0</span><span class="p">],</span> <span class="n">integer_types</span><span class="p">)</span> <span class="ow">and</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">arg1</span><span class="p">[</span><span class="mi">1</span><span class="p">],</span> <span class="n">integer_types</span><span class="p">):</span> |
| <span class="c1"># empty ndarray with shape</span> |
| <span class="n">_check_shape</span><span class="p">(</span><span class="n">arg1</span><span class="p">,</span> <span class="n">shape</span><span class="p">)</span> |
| <span class="k">return</span> <span class="n">empty</span><span class="p">(</span><span class="s1">'row_sparse'</span><span class="p">,</span> <span class="n">arg1</span><span class="p">,</span> <span class="n">ctx</span><span class="o">=</span><span class="n">ctx</span><span class="p">,</span> <span class="n">dtype</span><span class="o">=</span><span class="n">dtype</span><span class="p">)</span> |
| <span class="k">else</span><span class="p">:</span> |
| <span class="c1"># data, indices, indptr</span> |
| <span class="k">return</span> <span class="n">_row_sparse_ndarray_from_definition</span><span class="p">(</span><span class="n">arg1</span><span class="p">[</span><span class="mi">0</span><span class="p">],</span> <span class="n">arg1</span><span class="p">[</span><span class="mi">1</span><span class="p">],</span> <span class="n">shape</span><span class="o">=</span><span class="n">shape</span><span class="p">,</span> |
| <span class="n">ctx</span><span class="o">=</span><span class="n">ctx</span><span class="p">,</span> <span class="n">dtype</span><span class="o">=</span><span class="n">dtype</span><span class="p">)</span> |
| <span class="k">else</span><span class="p">:</span> |
| <span class="c1"># construct a row sparse ndarray from a dense / sparse array</span> |
| <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">arg1</span><span class="p">,</span> <span class="n">RowSparseNDArray</span><span class="p">):</span> |
| <span class="c1"># construct a row sparse ndarray from RowSparseNDArray</span> |
| <span class="n">_check_shape</span><span class="p">(</span><span class="n">arg1</span><span class="o">.</span><span class="n">shape</span><span class="p">,</span> <span class="n">shape</span><span class="p">)</span> |
| <span class="k">return</span> <span class="n">array</span><span class="p">(</span><span class="n">arg1</span><span class="p">,</span> <span class="n">ctx</span><span class="o">=</span><span class="n">ctx</span><span class="p">,</span> <span class="n">dtype</span><span class="o">=</span><span class="n">dtype</span><span class="p">)</span> |
| <span class="k">elif</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">arg1</span><span class="p">,</span> <span class="n">CSRNDArray</span><span class="p">):</span> |
| <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s2">"Unexpected input type: CSRNDArray"</span><span class="p">)</span> |
| <span class="k">else</span><span class="p">:</span> |
| <span class="c1"># construct a csr matrix from a dense one</span> |
| <span class="c1"># prepare default dtype since mx.nd.array doesn't use default values</span> |
| <span class="c1"># based on source_array</span> |
| <span class="n">dtype</span> <span class="o">=</span> <span class="n">_prepare_default_dtype</span><span class="p">(</span><span class="n">arg1</span><span class="p">,</span> <span class="n">dtype</span><span class="p">)</span> |
| <span class="c1"># create dns array with provided dtype. ctx is not passed since copy across</span> |
| <span class="c1"># ctx requires dtype to be the same</span> |
| <span class="n">dns</span> <span class="o">=</span> <span class="n">_array</span><span class="p">(</span><span class="n">arg1</span><span class="p">,</span> <span class="n">dtype</span><span class="o">=</span><span class="n">dtype</span><span class="p">)</span> |
| <span class="k">if</span> <span class="n">ctx</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span> <span class="ow">and</span> <span class="n">dns</span><span class="o">.</span><span class="n">context</span> <span class="o">!=</span> <span class="n">ctx</span><span class="p">:</span> |
| <span class="n">dns</span> <span class="o">=</span> <span class="n">dns</span><span class="o">.</span><span class="n">as_in_context</span><span class="p">(</span><span class="n">ctx</span><span class="p">)</span> |
| <span class="n">_check_shape</span><span class="p">(</span><span class="n">dns</span><span class="o">.</span><span class="n">shape</span><span class="p">,</span> <span class="n">shape</span><span class="p">)</span> |
| <span class="k">return</span> <span class="n">dns</span><span class="o">.</span><span class="n">tostype</span><span class="p">(</span><span class="s1">'row_sparse'</span><span class="p">)</span></div> |
| |
| <span class="k">def</span> <span class="nf">_row_sparse_ndarray_from_definition</span><span class="p">(</span><span class="n">data</span><span class="p">,</span> <span class="n">indices</span><span class="p">,</span> <span class="n">shape</span><span class="o">=</span><span class="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">dtype</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">indices_type</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span> |
| <span class="w"> </span><span class="sd">"""Create a `RowSparseNDArray` based on data and indices"""</span> |
| <span class="n">storage_type</span> <span class="o">=</span> <span class="s1">'row_sparse'</span> |
| <span class="c1"># context</span> |
| <span class="n">ctx</span> <span class="o">=</span> <span class="n">current_context</span><span class="p">()</span> <span class="k">if</span> <span class="n">ctx</span> <span class="ow">is</span> <span class="kc">None</span> <span class="k">else</span> <span class="n">ctx</span> |
| <span class="c1"># types</span> |
| <span class="n">dtype</span> <span class="o">=</span> <span class="n">_prepare_default_dtype</span><span class="p">(</span><span class="n">data</span><span class="p">,</span> <span class="n">dtype</span><span class="p">)</span> |
| <span class="n">indices_type</span> <span class="o">=</span> <span class="n">_STORAGE_AUX_TYPES</span><span class="p">[</span><span class="n">storage_type</span><span class="p">][</span><span class="mi">0</span><span class="p">]</span> <span class="k">if</span> <span class="n">indices_type</span> <span class="ow">is</span> <span class="kc">None</span> <span class="k">else</span> <span class="n">indices_type</span> |
| <span class="c1"># prepare src array and types</span> |
| <span class="n">data</span> <span class="o">=</span> <span class="n">_prepare_src_array</span><span class="p">(</span><span class="n">data</span><span class="p">,</span> <span class="n">dtype</span><span class="p">)</span> |
| <span class="n">indices</span> <span class="o">=</span> <span class="n">_prepare_src_array</span><span class="p">(</span><span class="n">indices</span><span class="p">,</span> <span class="n">indices_type</span><span class="p">)</span> |
| |
| <span class="c1"># TODO(junwu): Convert data, indptr, and indices to mxnet NDArrays</span> |
| <span class="c1"># if they are not for now. In the future, we should provide a c-api</span> |
| <span class="c1"># to accept np.ndarray types to copy from to result.data and aux_data</span> |
| <span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">data</span><span class="p">,</span> <span class="n">NDArray</span><span class="p">):</span> |
| <span class="n">data</span> <span class="o">=</span> <span class="n">_array</span><span class="p">(</span><span class="n">data</span><span class="p">,</span> <span class="n">ctx</span><span class="p">,</span> <span class="n">dtype</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">indices</span><span class="p">,</span> <span class="n">NDArray</span><span class="p">):</span> |
| <span class="n">indices</span> <span class="o">=</span> <span class="n">_array</span><span class="p">(</span><span class="n">indices</span><span class="p">,</span> <span class="n">ctx</span><span class="p">,</span> <span class="n">indices_type</span><span class="p">)</span> |
| <span class="k">if</span> <span class="n">shape</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span> |
| <span class="n">num_indices</span> <span class="o">=</span> <span class="n">indices</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> |
| <span class="k">if</span> <span class="n">num_indices</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">'invalid shape'</span><span class="p">)</span> |
| <span class="n">dim0</span> <span class="o">=</span> <span class="n">indices</span><span class="p">[</span><span class="n">num_indices</span> <span class="o">-</span> <span class="mi">1</span><span class="p">]</span><span class="o">.</span><span class="n">asscalar</span><span class="p">()</span> <span class="o">+</span> <span class="mi">1</span> |
| <span class="n">shape</span> <span class="o">=</span> <span class="p">(</span><span class="n">dim0</span><span class="p">,</span> <span class="p">)</span> <span class="o">+</span> <span class="n">data</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="mi">1</span><span class="p">:]</span> |
| <span class="c1"># verify shapes</span> |
| <span class="k">if</span> <span class="n">data</span><span class="o">.</span><span class="n">ndim</span> <span class="o">!=</span> <span class="nb">len</span><span class="p">(</span><span class="n">shape</span><span class="p">)</span> <span class="ow">or</span> <span class="n">indices</span><span class="o">.</span><span class="n">ndim</span> <span class="o">!=</span> <span class="mi">1</span> <span class="ow">or</span> <span class="n">np</span><span class="o">.</span><span class="n">prod</span><span class="p">(</span><span class="n">shape</span><span class="p">[</span><span class="mi">1</span><span class="p">:])</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="s2">"invalid shape"</span><span class="p">)</span> |
| <span class="n">result</span> <span class="o">=</span> <span class="n">RowSparseNDArray</span><span class="p">(</span><span class="n">_new_alloc_handle</span><span class="p">(</span><span class="n">storage_type</span><span class="p">,</span> <span class="n">shape</span><span class="p">,</span> <span class="n">ctx</span><span class="p">,</span> <span class="kc">False</span><span class="p">,</span> <span class="n">dtype</span><span class="p">,</span> |
| <span class="p">[</span><span class="n">indices_type</span><span class="p">],</span> <span class="p">[</span><span class="n">indices</span><span class="o">.</span><span class="n">shape</span><span class="p">]))</span> |
| <span class="n">check_call</span><span class="p">(</span><span class="n">_LIB</span><span class="o">.</span><span class="n">MXNDArraySyncCopyFromNDArray</span><span class="p">(</span><span class="n">result</span><span class="o">.</span><span class="n">handle</span><span class="p">,</span> <span class="n">data</span><span class="o">.</span><span class="n">handle</span><span class="p">,</span> <span class="n">ctypes</span><span class="o">.</span><span class="n">c_int</span><span class="p">(</span><span class="o">-</span><span class="mi">1</span><span class="p">)))</span> |
| <span class="n">check_call</span><span class="p">(</span><span class="n">_LIB</span><span class="o">.</span><span class="n">MXNDArraySyncCopyFromNDArray</span><span class="p">(</span><span class="n">result</span><span class="o">.</span><span class="n">handle</span><span class="p">,</span> <span class="n">indices</span><span class="o">.</span><span class="n">handle</span><span class="p">,</span> <span class="n">ctypes</span><span class="o">.</span><span class="n">c_int</span><span class="p">(</span><span class="mi">0</span><span class="p">)))</span> |
| <span class="k">return</span> <span class="n">result</span> |
| |
| <span class="k">def</span> <span class="nf">_ndarray_cls</span><span class="p">(</span><span class="n">handle</span><span class="p">,</span> <span class="n">writable</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">stype</span><span class="o">=</span><span class="n">_STORAGE_TYPE_UNDEFINED</span><span class="p">):</span> |
| <span class="k">if</span> <span class="n">stype</span> <span class="o">==</span> <span class="n">_STORAGE_TYPE_UNDEFINED</span><span class="p">:</span> |
| <span class="n">stype</span> <span class="o">=</span> <span class="n">_storage_type</span><span class="p">(</span><span class="n">handle</span><span class="p">)</span> |
| <span class="k">if</span> <span class="n">stype</span> <span class="o">==</span> <span class="n">_STORAGE_TYPE_DEFAULT</span><span class="p">:</span> |
| <span class="k">return</span> <span class="n">NDArray</span><span class="p">(</span><span class="n">handle</span><span class="p">,</span> <span class="n">writable</span><span class="o">=</span><span class="n">writable</span><span class="p">)</span> |
| <span class="k">elif</span> <span class="n">stype</span> <span class="o">==</span> <span class="n">_STORAGE_TYPE_CSR</span><span class="p">:</span> |
| <span class="k">return</span> <span class="n">CSRNDArray</span><span class="p">(</span><span class="n">handle</span><span class="p">,</span> <span class="n">writable</span><span class="o">=</span><span class="n">writable</span><span class="p">)</span> |
| <span class="k">elif</span> <span class="n">stype</span> <span class="o">==</span> <span class="n">_STORAGE_TYPE_ROW_SPARSE</span><span class="p">:</span> |
| <span class="k">return</span> <span class="n">RowSparseNDArray</span><span class="p">(</span><span class="n">handle</span><span class="p">,</span> <span class="n">writable</span><span class="o">=</span><span class="n">writable</span><span class="p">)</span> |
| <span class="k">else</span><span class="p">:</span> |
| <span class="k">raise</span> <span class="ne">Exception</span><span class="p">(</span><span class="s2">"unknown storage type: </span><span class="si">%s</span><span class="s2">"</span><span class="o">%</span><span class="n">stype</span><span class="p">)</span> |
| |
| |
| <span class="n">_set_ndarray_class</span><span class="p">(</span><span class="n">_ndarray_cls</span><span class="p">)</span> |
| |
| |
| <div class="viewcode-block" id="add"><a class="viewcode-back" href="../../../api/ndarray/sparse/index.html#mxnet.ndarray.sparse.add">[docs]</a><span class="k">def</span> <span class="nf">add</span><span class="p">(</span><span class="n">lhs</span><span class="p">,</span> <span class="n">rhs</span><span class="p">):</span> |
| <span class="w"> </span><span class="sd">"""Returns element-wise sum of the input arrays with broadcasting.</span> |
| |
| <span class="sd"> Equivalent to ``lhs + rhs``, ``mx.nd.broadcast_add(lhs, rhs)`` and</span> |
| <span class="sd"> ``mx.nd.broadcast_plus(lhs, rhs)`` when shapes of lhs and rhs do not</span> |
| <span class="sd"> match. If lhs.shape == rhs.shape, this is equivalent to</span> |
| <span class="sd"> ``mx.nd.elemwise_add(lhs, rhs)``</span> |
| |
| <span class="sd"> .. note::</span> |
| |
| <span class="sd"> If the corresponding dimensions of two arrays have the same size or one of them has size 1,</span> |
| <span class="sd"> then the arrays are broadcastable to a common shape.abs</span> |
| |
| <span class="sd"> Parameters</span> |
| <span class="sd"> ----------</span> |
| <span class="sd"> lhs : scalar or mxnet.ndarray.sparse.array</span> |
| <span class="sd"> First array to be added.</span> |
| <span class="sd"> rhs : scalar or mxnet.ndarray.sparse.array</span> |
| <span class="sd"> Second array to be added.</span> |
| <span class="sd"> If ``lhs.shape != rhs.shape``, they must be</span> |
| <span class="sd"> broadcastable to a common shape.</span> |
| |
| <span class="sd"> Returns</span> |
| <span class="sd"> -------</span> |
| <span class="sd"> NDArray</span> |
| <span class="sd"> The element-wise sum of the input arrays.</span> |
| |
| <span class="sd"> Examples</span> |
| <span class="sd"> --------</span> |
| <span class="sd"> >>> a = mx.nd.ones((2,3)).tostype('csr')</span> |
| <span class="sd"> >>> b = mx.nd.ones((2,3)).tostype('csr')</span> |
| <span class="sd"> >>> a.asnumpy()</span> |
| <span class="sd"> array([[ 1., 1., 1.],</span> |
| <span class="sd"> [ 1., 1., 1.]], dtype=float32)</span> |
| <span class="sd"> >>> b.asnumpy()</span> |
| <span class="sd"> array([[ 1., 1., 1.],</span> |
| <span class="sd"> [ 1., 1., 1.]], dtype=float32)</span> |
| <span class="sd"> >>> (a+b).asnumpy()</span> |
| <span class="sd"> array([[ 2., 2., 2.],</span> |
| <span class="sd"> [ 2., 2., 2.]], dtype=float32)</span> |
| <span class="sd"> >>> c = mx.nd.ones((2,3)).tostype('row_sparse')</span> |
| <span class="sd"> >>> d = mx.nd.ones((2,3)).tostype('row_sparse')</span> |
| <span class="sd"> >>> c.asnumpy()</span> |
| <span class="sd"> array([[ 1., 1., 1.],</span> |
| <span class="sd"> [ 1., 1., 1.]], dtype=float32)</span> |
| <span class="sd"> >>> d.asnumpy()</span> |
| <span class="sd"> array([[ 1., 1., 1.],</span> |
| <span class="sd"> [ 1., 1., 1.]], dtype=float32)</span> |
| <span class="sd"> >>> (c+d).asnumpy()</span> |
| <span class="sd"> array([[ 2., 2., 2.],</span> |
| <span class="sd"> [ 2., 2., 2.]], dtype=float32)</span> |
| <span class="sd"> """</span> |
| <span class="c1"># pylint: disable= no-member, protected-access</span> |
| <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">lhs</span><span class="p">,</span> <span class="n">NDArray</span><span class="p">)</span> <span class="ow">and</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">rhs</span><span class="p">,</span> <span class="n">NDArray</span><span class="p">)</span> <span class="ow">and</span> <span class="n">lhs</span><span class="o">.</span><span class="n">shape</span> <span class="o">==</span> <span class="n">rhs</span><span class="o">.</span><span class="n">shape</span><span class="p">:</span> |
| <span class="k">return</span> <span class="n">_ufunc_helper</span><span class="p">(</span> |
| <span class="n">lhs</span><span class="p">,</span> |
| <span class="n">rhs</span><span class="p">,</span> |
| <span class="n">op</span><span class="o">.</span><span class="n">elemwise_add</span><span class="p">,</span> |
| <span class="n">operator</span><span class="o">.</span><span class="n">add</span><span class="p">,</span> |
| <span class="n">_internal</span><span class="o">.</span><span class="n">_plus_scalar</span><span class="p">,</span> |
| <span class="kc">None</span><span class="p">)</span> |
| |
| <span class="k">return</span> <span class="n">_ufunc_helper</span><span class="p">(</span> |
| <span class="n">lhs</span><span class="p">,</span> |
| <span class="n">rhs</span><span class="p">,</span> |
| <span class="n">op</span><span class="o">.</span><span class="n">broadcast_add</span><span class="p">,</span> |
| <span class="n">operator</span><span class="o">.</span><span class="n">add</span><span class="p">,</span> |
| <span class="n">_internal</span><span class="o">.</span><span class="n">_plus_scalar</span><span class="p">,</span> |
| <span class="kc">None</span><span class="p">)</span></div> |
| <span class="c1"># pylint: enable= no-member, protected-access</span> |
| |
| |
| <div class="viewcode-block" id="subtract"><a class="viewcode-back" href="../../../api/ndarray/sparse/index.html#mxnet.ndarray.sparse.subtract">[docs]</a><span class="k">def</span> <span class="nf">subtract</span><span class="p">(</span><span class="n">lhs</span><span class="p">,</span> <span class="n">rhs</span><span class="p">):</span> |
| <span class="w"> </span><span class="sd">"""Returns element-wise difference of the input arrays with broadcasting.</span> |
| |
| <span class="sd"> Equivalent to ``lhs - rhs``, ``mx.nd.broadcast_sub(lhs, rhs)`` and</span> |
| <span class="sd"> ``mx.nd.broadcast_minus(lhs, rhs)`` when shapes of lhs and rhs do not</span> |
| <span class="sd"> match. If lhs.shape == rhs.shape, this is equivalent to</span> |
| <span class="sd"> ``mx.nd.elemwise_sub(lhs, rhs)``</span> |
| |
| <span class="sd"> .. note::</span> |
| |
| <span class="sd"> If the corresponding dimensions of two arrays have the same size or one of them has size 1,</span> |
| <span class="sd"> then the arrays are broadcastable to a common shape.</span> |
| |
| <span class="sd"> Parameters</span> |
| <span class="sd"> ----------</span> |
| <span class="sd"> lhs : scalar or mxnet.ndarray.sparse.array</span> |
| <span class="sd"> First array to be subtracted.</span> |
| <span class="sd"> rhs : scalar or mxnet.ndarray.sparse.array</span> |
| <span class="sd"> Second array to be subtracted.</span> |
| <span class="sd"> If ``lhs.shape != rhs.shape``, they must be</span> |
| <span class="sd"> broadcastable to a common shape.__spec__</span> |
| |
| <span class="sd"> Returns</span> |
| <span class="sd"> -------</span> |
| <span class="sd"> NDArray</span> |
| <span class="sd"> The element-wise difference of the input arrays.</span> |
| |
| <span class="sd"> Examples</span> |
| <span class="sd"> --------</span> |
| <span class="sd"> >>> a = mx.nd.ones((2,3)).tostype('csr')</span> |
| <span class="sd"> >>> b = mx.nd.ones((2,3)).tostype('csr')</span> |
| <span class="sd"> >>> a.asnumpy()</span> |
| <span class="sd"> array([[ 1., 1., 1.],</span> |
| <span class="sd"> [ 1., 1., 1.]], dtype=float32)</span> |
| <span class="sd"> >>> b.asnumpy()</span> |
| <span class="sd"> array([[ 1., 1., 1.],</span> |
| <span class="sd"> [ 1., 1., 1.]], dtype=float32)</span> |
| <span class="sd"> >>> (a-b).asnumpy()</span> |
| <span class="sd"> array([[ 0., 0., 0.],</span> |
| <span class="sd"> [ 0., 0., 0.]], dtype=float32)</span> |
| <span class="sd"> >>> c = mx.nd.ones((2,3)).tostype('row_sparse')</span> |
| <span class="sd"> >>> d = mx.nd.ones((2,3)).tostype('row_sparse')</span> |
| <span class="sd"> >>> c.asnumpy()</span> |
| <span class="sd"> array([[ 1., 1., 1.],</span> |
| <span class="sd"> [ 1., 1., 1.]], dtype=float32)</span> |
| <span class="sd"> >>> d.asnumpy()</span> |
| <span class="sd"> array([[ 1., 1., 1.],</span> |
| <span class="sd"> [ 1., 1., 1.]], dtype=float32)</span> |
| <span class="sd"> >>> (c-d).asnumpy()</span> |
| <span class="sd"> array([[ 0., 0., 0.],</span> |
| <span class="sd"> [ 0., 0., 0.]], dtype=float32)</span> |
| <span class="sd"> """</span> |
| <span class="c1"># pylint: disable= no-member, protected-access</span> |
| <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">lhs</span><span class="p">,</span> <span class="n">NDArray</span><span class="p">)</span> <span class="ow">and</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">rhs</span><span class="p">,</span> <span class="n">NDArray</span><span class="p">)</span> <span class="ow">and</span> <span class="n">lhs</span><span class="o">.</span><span class="n">shape</span> <span class="o">==</span> <span class="n">rhs</span><span class="o">.</span><span class="n">shape</span><span class="p">:</span> |
| <span class="k">return</span> <span class="n">_ufunc_helper</span><span class="p">(</span> |
| <span class="n">lhs</span><span class="p">,</span> |
| <span class="n">rhs</span><span class="p">,</span> |
| <span class="n">op</span><span class="o">.</span><span class="n">elemwise_sub</span><span class="p">,</span> |
| <span class="n">operator</span><span class="o">.</span><span class="n">sub</span><span class="p">,</span> |
| <span class="n">_internal</span><span class="o">.</span><span class="n">_minus_scalar</span><span class="p">,</span> |
| <span class="kc">None</span><span class="p">)</span> |
| |
| <span class="k">return</span> <span class="n">_ufunc_helper</span><span class="p">(</span> |
| <span class="n">lhs</span><span class="p">,</span> |
| <span class="n">rhs</span><span class="p">,</span> |
| <span class="n">op</span><span class="o">.</span><span class="n">broadcast_sub</span><span class="p">,</span> |
| <span class="n">operator</span><span class="o">.</span><span class="n">sub</span><span class="p">,</span> |
| <span class="n">_internal</span><span class="o">.</span><span class="n">_minus_scalar</span><span class="p">,</span> |
| <span class="kc">None</span><span class="p">)</span></div> |
| <span class="c1"># pylint: enable= no-member, protected-access</span> |
| |
| |
| <div class="viewcode-block" id="multiply"><a class="viewcode-back" href="../../../api/ndarray/sparse/index.html#mxnet.ndarray.sparse.multiply">[docs]</a><span class="k">def</span> <span class="nf">multiply</span><span class="p">(</span><span class="n">lhs</span><span class="p">,</span> <span class="n">rhs</span><span class="p">):</span> |
| <span class="w"> </span><span class="sd">"""Returns element-wise product of the input arrays with broadcasting.</span> |
| |
| <span class="sd"> Equivalent to ``lhs * rhs`` and ``mx.nd.broadcast_mul(lhs, rhs)``</span> |
| <span class="sd"> when shapes of lhs and rhs do not match. If lhs.shape == rhs.shape,</span> |
| <span class="sd"> this is equivalent to ``mx.nd.elemwise_mul(lhs, rhs)``</span> |
| |
| <span class="sd"> .. note::</span> |
| |
| <span class="sd"> If the corresponding dimensions of two arrays have the same size or one of them has size 1,</span> |
| <span class="sd"> then the arrays are broadcastable to a common shape.</span> |
| |
| <span class="sd"> Parameters</span> |
| <span class="sd"> ----------</span> |
| <span class="sd"> lhs : scalar or mxnet.ndarray.sparse.array</span> |
| <span class="sd"> First array to be multiplied.</span> |
| <span class="sd"> rhs : scalar or mxnet.ndarray.sparse.array</span> |
| <span class="sd"> Second array to be multiplied.</span> |
| <span class="sd"> If ``lhs.shape != rhs.shape``, they must be</span> |
| <span class="sd"> broadcastable to a common shape.</span> |
| |
| <span class="sd"> Returns</span> |
| <span class="sd"> -------</span> |
| <span class="sd"> NDArray</span> |
| <span class="sd"> The element-wise multiplication of the input arrays.</span> |
| |
| <span class="sd"> Examples</span> |
| <span class="sd"> --------</span> |
| <span class="sd"> >>> x = mx.nd.ones((2,3)).tostype('csr')</span> |
| <span class="sd"> >>> y = mx.nd.arange(2).reshape((2,1))</span> |
| <span class="sd"> >>> z = mx.nd.arange(3)</span> |
| <span class="sd"> >>> x.asnumpy()</span> |
| <span class="sd"> array([[ 1., 1., 1.],</span> |
| <span class="sd"> [ 1., 1., 1.]], dtype=float32)</span> |
| <span class="sd"> >>> y.asnumpy()</span> |
| <span class="sd"> array([[ 0.],</span> |
| <span class="sd"> [ 1.]], dtype=float32)</span> |
| <span class="sd"> >>> z.asnumpy()</span> |
| <span class="sd"> array([ 0., 1., 2.], dtype=float32)</span> |
| <span class="sd"> >>> (x*2).asnumpy()</span> |
| <span class="sd"> array([[ 2., 2., 2.],</span> |
| <span class="sd"> [ 2., 2., 2.]], dtype=float32)</span> |
| <span class="sd"> >>> (x*y).asnumpy()</span> |
| <span class="sd"> array([[ 0., 0., 0.],</span> |
| <span class="sd"> [ 1., 1., 1.]], dtype=float32)</span> |
| <span class="sd"> >>> mx.nd.sparse.multiply(x, y).asnumpy()</span> |
| <span class="sd"> array([[ 0., 0., 0.],</span> |
| <span class="sd"> [ 1., 1., 1.]], dtype=float32)</span> |
| <span class="sd"> >>> (x*z).asnumpy()</span> |
| <span class="sd"> array([[ 0., 1., 2.],</span> |
| <span class="sd"> [ 0., 1., 2.]], dtype=float32)</span> |
| <span class="sd"> >>> mx.nd.sparse.multiply(x, z).asnumpy()</span> |
| <span class="sd"> array([[ 0., 1., 2.],</span> |
| <span class="sd"> [ 0., 1., 2.]], dtype=float32)</span> |
| <span class="sd"> >>> z = z.reshape((1, 3))</span> |
| <span class="sd"> >>> z.asnumpy()</span> |
| <span class="sd"> array([[ 0., 1., 2.]], dtype=float32)</span> |
| <span class="sd"> >>> (x*z).asnumpy()</span> |
| <span class="sd"> array([[ 0., 1., 2.],</span> |
| <span class="sd"> [ 0., 1., 2.]], dtype=float32)</span> |
| <span class="sd"> >>> mx.nd.sparse.multiply(x, z).asnumpy()</span> |
| <span class="sd"> array([[ 0., 1., 2.],</span> |
| <span class="sd"> [ 0., 1., 2.]], dtype=float32)</span> |
| <span class="sd"> """</span> |
| <span class="c1"># pylint: disable= no-member, protected-access</span> |
| <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">lhs</span><span class="p">,</span> <span class="n">NDArray</span><span class="p">)</span> <span class="ow">and</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">rhs</span><span class="p">,</span> <span class="n">NDArray</span><span class="p">)</span> <span class="ow">and</span> <span class="n">lhs</span><span class="o">.</span><span class="n">shape</span> <span class="o">==</span> <span class="n">rhs</span><span class="o">.</span><span class="n">shape</span><span class="p">:</span> |
| <span class="k">return</span> <span class="n">_ufunc_helper</span><span class="p">(</span> |
| <span class="n">lhs</span><span class="p">,</span> |
| <span class="n">rhs</span><span class="p">,</span> |
| <span class="n">op</span><span class="o">.</span><span class="n">elemwise_mul</span><span class="p">,</span> |
| <span class="n">operator</span><span class="o">.</span><span class="n">mul</span><span class="p">,</span> |
| <span class="n">_internal</span><span class="o">.</span><span class="n">_mul_scalar</span><span class="p">,</span> |
| <span class="kc">None</span><span class="p">)</span> |
| |
| <span class="k">return</span> <span class="n">_ufunc_helper</span><span class="p">(</span> |
| <span class="n">lhs</span><span class="p">,</span> |
| <span class="n">rhs</span><span class="p">,</span> |
| <span class="n">op</span><span class="o">.</span><span class="n">broadcast_mul</span><span class="p">,</span> |
| <span class="n">operator</span><span class="o">.</span><span class="n">mul</span><span class="p">,</span> |
| <span class="n">_internal</span><span class="o">.</span><span class="n">_mul_scalar</span><span class="p">,</span> |
| <span class="kc">None</span><span class="p">)</span></div> |
| <span class="c1"># pylint: enable= no-member, protected-access</span> |
| |
| |
| <div class="viewcode-block" id="divide"><a class="viewcode-back" href="../../../api/ndarray/sparse/index.html#mxnet.ndarray.sparse.divide">[docs]</a><span class="k">def</span> <span class="nf">divide</span><span class="p">(</span><span class="n">lhs</span><span class="p">,</span> <span class="n">rhs</span><span class="p">):</span> |
| <span class="w"> </span><span class="sd">"""Returns element-wise division of the input arrays with broadcasting.</span> |
| |
| <span class="sd"> Equivalent to ``lhs / rhs`` and ``mx.nd.broadcast_div(lhs, rhs)``</span> |
| <span class="sd"> when shapes of lhs and rhs do not match. If lhs.shape == rhs.shape,</span> |
| <span class="sd"> this is equivalent to ``mx.nd.elemwise_div(lhs, rhs)``</span> |
| |
| <span class="sd"> .. note::</span> |
| |
| <span class="sd"> If the corresponding dimensions of two arrays have the same size or one of them has size 1,</span> |
| <span class="sd"> then the arrays are broadcastable to a common shape.</span> |
| |
| <span class="sd"> Parameters</span> |
| <span class="sd"> ----------</span> |
| <span class="sd"> lhs : scalar or mxnet.ndarray.sparse.array</span> |
| <span class="sd"> First array in division.</span> |
| <span class="sd"> rhs : scalar or mxnet.ndarray.sparse.array</span> |
| <span class="sd"> Second array in division.</span> |
| <span class="sd"> The arrays to be divided. If ``lhs.shape != rhs.shape``, they must be</span> |
| <span class="sd"> broadcastable to a common shape.</span> |
| |
| <span class="sd"> Returns</span> |
| <span class="sd"> -------</span> |
| <span class="sd"> NDArray</span> |
| <span class="sd"> The element-wise division of the input arrays.</span> |
| |
| <span class="sd"> Examples</span> |
| <span class="sd"> --------</span> |
| <span class="sd"> >>> x = (mx.nd.ones((2,3))*6).tostype('csr')</span> |
| <span class="sd"> >>> y = mx.nd.arange(2).reshape((2,1)) + 1</span> |
| <span class="sd"> >>> z = mx.nd.arange(3) + 1</span> |
| <span class="sd"> >>> x.asnumpy()</span> |
| <span class="sd"> array([[ 6., 6., 6.],</span> |
| <span class="sd"> [ 6., 6., 6.]], dtype=float32)</span> |
| <span class="sd"> >>> y.asnumpy()</span> |
| <span class="sd"> array([[ 1.],</span> |
| <span class="sd"> [ 2.]], dtype=float32)</span> |
| <span class="sd"> >>> z.asnumpy()</span> |
| <span class="sd"> array([ 1., 2., 3.], dtype=float32)</span> |
| <span class="sd"> >>> x/2</span> |
| <span class="sd"> <NDArray 2x3 @cpu(0)></span> |
| <span class="sd"> >>> (x/3).asnumpy()</span> |
| <span class="sd"> array([[ 2., 2., 2.],</span> |
| <span class="sd"> [ 2., 2., 2.]], dtype=float32)</span> |
| <span class="sd"> >>> (x/y).asnumpy()</span> |
| <span class="sd"> array([[ 6., 6., 6.],</span> |
| <span class="sd"> [ 3., 3., 3.]], dtype=float32)</span> |
| <span class="sd"> >>> mx.nd.sparse.divide(x,y).asnumpy()</span> |
| <span class="sd"> array([[ 6., 6., 6.],</span> |
| <span class="sd"> [ 3., 3., 3.]], dtype=float32)</span> |
| <span class="sd"> >>> (x/z).asnumpy()</span> |
| <span class="sd"> array([[ 6., 3., 2.],</span> |
| <span class="sd"> [ 6., 3., 2.]], dtype=float32)</span> |
| <span class="sd"> >>> mx.nd.sprase.divide(x,z).asnumpy()</span> |
| <span class="sd"> array([[ 6., 3., 2.],</span> |
| <span class="sd"> [ 6., 3., 2.]], dtype=float32)</span> |
| <span class="sd"> >>> z = z.reshape((1,3))</span> |
| <span class="sd"> >>> z.asnumpy()</span> |
| <span class="sd"> array([[ 1., 2., 3.]], dtype=float32)</span> |
| <span class="sd"> >>> (x/z).asnumpy()</span> |
| <span class="sd"> array([[ 6., 3., 2.],</span> |
| <span class="sd"> [ 6., 3., 2.]], dtype=float32)</span> |
| <span class="sd"> >>> mx.nd.sparse.divide(x,z).asnumpy()</span> |
| <span class="sd"> array([[ 6., 3., 2.],</span> |
| <span class="sd"> [ 6., 3., 2.]], dtype=float32)</span> |
| <span class="sd"> """</span> |
| <span class="c1"># pylint: disable= no-member, protected-access</span> |
| <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">lhs</span><span class="p">,</span> <span class="n">NDArray</span><span class="p">)</span> <span class="ow">and</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">rhs</span><span class="p">,</span> <span class="n">NDArray</span><span class="p">)</span> <span class="ow">and</span> <span class="n">lhs</span><span class="o">.</span><span class="n">shape</span> <span class="o">==</span> <span class="n">rhs</span><span class="o">.</span><span class="n">shape</span><span class="p">:</span> |
| <span class="k">return</span> <span class="n">_ufunc_helper</span><span class="p">(</span> |
| <span class="n">lhs</span><span class="p">,</span> |
| <span class="n">rhs</span><span class="p">,</span> |
| <span class="n">op</span><span class="o">.</span><span class="n">elemwise_div</span><span class="p">,</span> |
| <span class="n">operator</span><span class="o">.</span><span class="n">truediv</span><span class="p">,</span> |
| <span class="n">_internal</span><span class="o">.</span><span class="n">_div_scalar</span><span class="p">,</span> |
| <span class="kc">None</span><span class="p">)</span> |
| |
| <span class="k">return</span> <span class="n">_ufunc_helper</span><span class="p">(</span> |
| <span class="n">lhs</span><span class="p">,</span> |
| <span class="n">rhs</span><span class="p">,</span> |
| <span class="n">op</span><span class="o">.</span><span class="n">broadcast_div</span><span class="p">,</span> |
| <span class="n">operator</span><span class="o">.</span><span class="n">truediv</span><span class="p">,</span> |
| <span class="n">_internal</span><span class="o">.</span><span class="n">_div_scalar</span><span class="p">,</span> |
| <span class="kc">None</span><span class="p">)</span></div> |
| <span class="c1"># pylint: enable= no-member, protected-access</span> |
| |
| |
| <span class="k">def</span> <span class="nf">zeros</span><span class="p">(</span><span class="n">stype</span><span class="p">,</span> <span class="n">shape</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">dtype</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="w"> </span><span class="sd">"""Return a new array of given shape and type, filled with zeros.</span> |
| |
| <span class="sd"> Parameters</span> |
| <span class="sd"> ----------</span> |
| <span class="sd"> stype: string</span> |
| <span class="sd"> The storage type of the empty array, such as 'row_sparse', 'csr', etc</span> |
| <span class="sd"> shape : int or tuple of int</span> |
| <span class="sd"> The shape of the empty array</span> |
| <span class="sd"> ctx : Context, optional</span> |
| <span class="sd"> An optional device context (default is the current default context)</span> |
| <span class="sd"> dtype : str or numpy.dtype, optional</span> |
| <span class="sd"> An optional value type (default is `float32`)</span> |
| |
| <span class="sd"> Returns</span> |
| <span class="sd"> -------</span> |
| <span class="sd"> RowSparseNDArray or CSRNDArray</span> |
| <span class="sd"> A created array</span> |
| <span class="sd"> Examples</span> |
| <span class="sd"> --------</span> |
| <span class="sd"> >>> mx.nd.sparse.zeros('csr', (1,2))</span> |
| <span class="sd"> <CSRNDArray 1x2 @cpu(0)></span> |
| <span class="sd"> >>> mx.nd.sparse.zeros('row_sparse', (1,2), ctx=mx.cpu(), dtype='float16').asnumpy()</span> |
| <span class="sd"> array([[ 0., 0.]], dtype=float16)</span> |
| <span class="sd"> """</span> |
| <span class="c1"># pylint: disable= no-member, protected-access</span> |
| <span class="k">if</span> <span class="n">stype</span> <span class="o">==</span> <span class="s1">'default'</span><span class="p">:</span> |
| <span class="k">return</span> <span class="n">_zeros_ndarray</span><span class="p">(</span><span class="n">shape</span><span class="p">,</span> <span class="n">ctx</span><span class="o">=</span><span class="n">ctx</span><span class="p">,</span> <span class="n">dtype</span><span class="o">=</span><span class="n">dtype</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span> |
| <span class="k">if</span> <span class="n">ctx</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span> |
| <span class="n">ctx</span> <span class="o">=</span> <span class="n">current_context</span><span class="p">()</span> |
| <span class="n">dtype</span> <span class="o">=</span> <span class="n">mx_real_t</span> <span class="k">if</span> <span class="n">dtype</span> <span class="ow">is</span> <span class="kc">None</span> <span class="k">else</span> <span class="n">dtype</span> |
| <span class="k">if</span> <span class="n">stype</span> <span class="ow">in</span> <span class="p">(</span><span class="s1">'row_sparse'</span><span class="p">,</span> <span class="s1">'csr'</span><span class="p">):</span> |
| <span class="n">aux_types</span> <span class="o">=</span> <span class="n">_STORAGE_AUX_TYPES</span><span class="p">[</span><span class="n">stype</span><span class="p">]</span> |
| <span class="k">else</span><span class="p">:</span> |
| <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s2">"unknown storage type"</span> <span class="o">+</span> <span class="n">stype</span><span class="p">)</span> |
| <span class="n">out</span> <span class="o">=</span> <span class="n">_ndarray_cls</span><span class="p">(</span><span class="n">_new_alloc_handle</span><span class="p">(</span><span class="n">stype</span><span class="p">,</span> <span class="n">shape</span><span class="p">,</span> <span class="n">ctx</span><span class="p">,</span> <span class="kc">True</span><span class="p">,</span> <span class="n">dtype</span><span class="p">,</span> <span class="n">aux_types</span><span class="p">))</span> |
| <span class="k">return</span> <span class="n">_internal</span><span class="o">.</span><span class="n">_zeros</span><span class="p">(</span><span class="n">shape</span><span class="o">=</span><span class="n">shape</span><span class="p">,</span> <span class="n">ctx</span><span class="o">=</span><span class="n">ctx</span><span class="p">,</span> <span class="n">dtype</span><span class="o">=</span><span class="n">dtype</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="o">**</span><span class="n">kwargs</span><span class="p">)</span> |
| <span class="c1"># pylint: enable= no-member, protected-access</span> |
| |
| |
| <span class="k">def</span> <span class="nf">empty</span><span class="p">(</span><span class="n">stype</span><span class="p">,</span> <span class="n">shape</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">dtype</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span> |
| <span class="w"> </span><span class="sd">"""Returns a new array of given shape and type, without initializing entries.</span> |
| |
| <span class="sd"> Parameters</span> |
| <span class="sd"> ----------</span> |
| <span class="sd"> stype: string</span> |
| <span class="sd"> The storage type of the empty array, such as 'row_sparse', 'csr', etc</span> |
| <span class="sd"> shape : int or tuple of int</span> |
| <span class="sd"> The shape of the empty array.</span> |
| <span class="sd"> ctx : Context, optional</span> |
| <span class="sd"> An optional device context (default is the current default context).</span> |
| <span class="sd"> dtype : str or numpy.dtype, optional</span> |
| <span class="sd"> An optional value type (default is `float32`).</span> |
| |
| <span class="sd"> Returns</span> |
| <span class="sd"> -------</span> |
| <span class="sd"> CSRNDArray or RowSparseNDArray</span> |
| <span class="sd"> A created array.</span> |
| <span class="sd"> """</span> |
| <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">shape</span><span class="p">,</span> <span class="nb">int</span><span class="p">):</span> |
| <span class="n">shape</span> <span class="o">=</span> <span class="p">(</span><span class="n">shape</span><span class="p">,</span> <span class="p">)</span> |
| <span class="k">if</span> <span class="n">ctx</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span> |
| <span class="n">ctx</span> <span class="o">=</span> <span class="n">current_context</span><span class="p">()</span> |
| <span class="k">if</span> <span class="n">dtype</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span> |
| <span class="n">dtype</span> <span class="o">=</span> <span class="n">mx_real_t</span> |
| <span class="k">assert</span><span class="p">(</span><span class="n">stype</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">stype</span> <span class="ow">in</span> <span class="p">(</span><span class="s1">'csr'</span><span class="p">,</span> <span class="s1">'row_sparse'</span><span class="p">):</span> |
| <span class="k">return</span> <span class="n">zeros</span><span class="p">(</span><span class="n">stype</span><span class="p">,</span> <span class="n">shape</span><span class="p">,</span> <span class="n">ctx</span><span class="o">=</span><span class="n">ctx</span><span class="p">,</span> <span class="n">dtype</span><span class="o">=</span><span class="n">dtype</span><span class="p">)</span> |
| <span class="k">else</span><span class="p">:</span> |
| <span class="k">raise</span> <span class="ne">Exception</span><span class="p">(</span><span class="s2">"unknown stype : "</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">stype</span><span class="p">))</span> |
| |
| |
| <span class="k">def</span> <span class="nf">array</span><span class="p">(</span><span class="n">source_array</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">dtype</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span> |
| <span class="w"> </span><span class="sd">"""Creates a sparse array from any object exposing the array interface.</span> |
| |
| <span class="sd"> Parameters</span> |
| <span class="sd"> ----------</span> |
| <span class="sd"> source_array : RowSparseNDArray, CSRNDArray or scipy.sparse.csr.csr_matrix</span> |
| <span class="sd"> The source sparse array</span> |
| <span class="sd"> ctx : Context, optional</span> |
| <span class="sd"> The default context is ``source_array.context`` if ``source_array`` is an NDArray. \</span> |
| <span class="sd"> The current default context otherwise.</span> |
| <span class="sd"> dtype : str or numpy.dtype, optional</span> |
| <span class="sd"> The data type of the output array. The default dtype is ``source_array.dtype``</span> |
| <span class="sd"> if `source_array` is an `NDArray`, `numpy.ndarray` or `scipy.sparse.csr.csr_matrix`, \</span> |
| <span class="sd"> `float32` otherwise.</span> |
| |
| <span class="sd"> Returns</span> |
| <span class="sd"> -------</span> |
| <span class="sd"> RowSparseNDArray or CSRNDArray</span> |
| <span class="sd"> An array with the same contents as the `source_array`.</span> |
| |
| <span class="sd"> Examples</span> |
| <span class="sd"> --------</span> |
| <span class="sd"> >>> import scipy.sparse as spsp</span> |
| <span class="sd"> >>> csr = spsp.csr_matrix((2, 100))</span> |
| <span class="sd"> >>> mx.nd.sparse.array(csr)</span> |
| <span class="sd"> <CSRNDArray 2x100 @cpu(0)></span> |
| <span class="sd"> >>> mx.nd.sparse.array(mx.nd.sparse.zeros('csr', (3, 2)))</span> |
| <span class="sd"> <CSRNDArray 3x2 @cpu(0)></span> |
| <span class="sd"> >>> mx.nd.sparse.array(mx.nd.sparse.zeros('row_sparse', (3, 2)))</span> |
| <span class="sd"> <RowSparseNDArray 3x2 @cpu(0)></span> |
| <span class="sd"> """</span> |
| <span class="n">ctx</span> <span class="o">=</span> <span class="n">current_context</span><span class="p">()</span> <span class="k">if</span> <span class="n">ctx</span> <span class="ow">is</span> <span class="kc">None</span> <span class="k">else</span> <span class="n">ctx</span> |
| <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">source_array</span><span class="p">,</span> <span class="n">NDArray</span><span class="p">):</span> |
| <span class="k">assert</span><span class="p">(</span><span class="n">source_array</span><span class="o">.</span><span class="n">stype</span> <span class="o">!=</span> <span class="s1">'default'</span><span class="p">),</span> \ |
| <span class="s2">"Please use `tostype` to create RowSparseNDArray or CSRNDArray from an NDArray"</span> |
| <span class="c1"># prepare dtype and ctx based on source_array, if not provided</span> |
| <span class="n">dtype</span> <span class="o">=</span> <span class="n">_prepare_default_dtype</span><span class="p">(</span><span class="n">source_array</span><span class="p">,</span> <span class="n">dtype</span><span class="p">)</span> |
| <span class="c1"># if both dtype and ctx are different from source_array, we cannot copy directly</span> |
| <span class="k">if</span> <span class="n">source_array</span><span class="o">.</span><span class="n">dtype</span> <span class="o">!=</span> <span class="n">dtype</span> <span class="ow">and</span> <span class="n">source_array</span><span class="o">.</span><span class="n">context</span> <span class="o">!=</span> <span class="n">ctx</span><span class="p">:</span> |
| <span class="n">arr</span> <span class="o">=</span> <span class="n">empty</span><span class="p">(</span><span class="n">source_array</span><span class="o">.</span><span class="n">stype</span><span class="p">,</span> <span class="n">source_array</span><span class="o">.</span><span class="n">shape</span><span class="p">,</span> <span class="n">dtype</span><span class="o">=</span><span class="n">dtype</span><span class="p">)</span> |
| <span class="n">arr</span><span class="p">[:]</span> <span class="o">=</span> <span class="n">source_array</span> |
| <span class="n">arr</span> <span class="o">=</span> <span class="n">arr</span><span class="o">.</span><span class="n">as_in_context</span><span class="p">(</span><span class="n">ctx</span><span class="p">)</span> |
| <span class="k">else</span><span class="p">:</span> |
| <span class="n">arr</span> <span class="o">=</span> <span class="n">empty</span><span class="p">(</span><span class="n">source_array</span><span class="o">.</span><span class="n">stype</span><span class="p">,</span> <span class="n">source_array</span><span class="o">.</span><span class="n">shape</span><span class="p">,</span> <span class="n">dtype</span><span class="o">=</span><span class="n">dtype</span><span class="p">,</span> <span class="n">ctx</span><span class="o">=</span><span class="n">ctx</span><span class="p">)</span> |
| <span class="n">arr</span><span class="p">[:]</span> <span class="o">=</span> <span class="n">source_array</span> |
| <span class="k">return</span> <span class="n">arr</span> |
| <span class="k">elif</span> <span class="n">spsp</span> <span class="ow">and</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">source_array</span><span class="p">,</span> <span class="n">spsp</span><span class="o">.</span><span class="n">csr</span><span class="o">.</span><span class="n">csr_matrix</span><span class="p">):</span> |
| <span class="c1"># TODO(haibin) implement `_sync_copy_from` with scipy csr object to reduce a copy</span> |
| <span class="c1"># preprocess scipy csr to canonical form</span> |
| <span class="n">csr</span> <span class="o">=</span> <span class="n">source_array</span><span class="o">.</span><span class="n">sorted_indices</span><span class="p">()</span> |
| <span class="n">csr</span><span class="o">.</span><span class="n">sum_duplicates</span><span class="p">()</span> |
| <span class="n">dtype</span> <span class="o">=</span> <span class="n">_prepare_default_dtype</span><span class="p">(</span><span class="n">source_array</span><span class="p">,</span> <span class="n">dtype</span><span class="p">)</span> |
| <span class="k">return</span> <span class="n">csr_matrix</span><span class="p">((</span><span class="n">csr</span><span class="o">.</span><span class="n">data</span><span class="p">,</span> <span class="n">csr</span><span class="o">.</span><span class="n">indices</span><span class="p">,</span> <span class="n">csr</span><span class="o">.</span><span class="n">indptr</span><span class="p">),</span> <span class="n">shape</span><span class="o">=</span><span class="n">csr</span><span class="o">.</span><span class="n">shape</span><span class="p">,</span> \ |
| <span class="n">dtype</span><span class="o">=</span><span class="n">dtype</span><span class="p">,</span> <span class="n">ctx</span><span class="o">=</span><span class="n">ctx</span><span class="p">)</span> |
| <span class="k">elif</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">source_array</span><span class="p">,</span> <span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">ndarray</span><span class="p">,</span> <span class="n">np</span><span class="o">.</span><span class="n">generic</span><span class="p">)):</span> |
| <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s2">"Please use mx.nd.array to create an NDArray with source_array of type "</span><span class="p">,</span> |
| <span class="nb">type</span><span class="p">(</span><span class="n">source_array</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="s2">"Unexpected source_array type: "</span><span class="p">,</span> <span class="nb">type</span><span class="p">(</span><span class="n">source_array</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/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/mxnet"><svg class="svg-icon"><use xlink:href="../../../_static/minima-social-icons.svg#github"></use></svg> <span class="username">apache/mxnet</span></a></li><li><a href="https://www.twitter.com/apachemxnet"><svg class="svg-icon"><use xlink:href="../../../_static/minima-social-icons.svg#twitter"></use></svg> <span class="username">apachemxnet</span></a></li><li><a href="https://youtube.com/apachemxnet"><svg class="svg-icon"><use xlink:href="../../../_static/minima-social-icons.svg#youtube"></use></svg> <span class="username">apachemxnet</span></a></li></ul> |
| </div> |
| |
| <div class="col-4 footer-text"> |
| <p>A flexible and efficient library for deep learning.</p> |
| </div> |
| </div> |
| </div> |
| </footer> |
| |
| <footer class="site-footer2"> |
| <div class="wrapper"> |
| <div class="row"> |
| <div class="col-3"> |
| <img src="../../../_static/apache_incubator_logo.png" class="footer-logo col-2"> |
| </div> |
| <div class="footer-bottom-warning col-9"> |
| <p>Apache MXNet is an effort undergoing incubation at <a href="http://www.apache.org/">The Apache Software Foundation</a> (ASF), <span style="font-weight:bold">sponsored by the <i>Apache Incubator</i></span>. Incubation is required |
| of all newly accepted projects until a further review indicates that the infrastructure, |
| communications, and decision making process have stabilized in a manner consistent with other |
| successful ASF projects. While incubation status is not necessarily a reflection of the completeness |
| or stability of the code, it does indicate that the project has yet to be fully endorsed by the ASF. |
| </p><p>"Copyright © 2017-2018, The Apache Software Foundation Apache MXNet, MXNet, Apache, the Apache |
| feather, and the Apache MXNet project logo are either registered trademarks or trademarks of the |
| Apache Software Foundation."</p> |
| </div> |
| </div> |
| </div> |
| </footer> |
| |
| </body> |
| </html> |
