| <!DOCTYPE html> |
| |
| <!--- |
| Licensed to the Apache Software Foundation (ASF) under one |
| or more contributor license agreements. See the NOTICE file |
| distributed with this work for additional information |
| regarding copyright ownership. The ASF licenses this file |
| to you under the Apache License, Version 2.0 (the |
| "License"); you may not use this file except in compliance |
| with the License. You may obtain a copy of the License at |
| http://www.apache.org/licenses/LICENSE-2.0 |
| Unless required by applicable law or agreed to in writing, |
| software distributed under the License is distributed on an |
| "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| KIND, either express or implied. See the License for the |
| specific language governing permissions and limitations |
| under the License. |
| --> |
| |
| <html lang=" en"><head> |
| <meta charset="utf-8"> |
| <meta http-equiv="X-UA-Compatible" content="IE=edge"> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <link href="/versions/1.9.1/assets/img/mxnet-icon.png" rel="icon" type="image/png"><!-- Begin Jekyll SEO tag v2.6.1 --> |
| <title>Symbol API | Apache MXNet</title> |
| <meta name="generator" content="Jekyll v3.8.6" /> |
| <meta property="og:title" content="Symbol API" /> |
| <meta property="og:locale" content="en_US" /> |
| <meta name="description" content="A flexible and efficient library for deep learning." /> |
| <meta property="og:description" content="A flexible and efficient library for deep learning." /> |
| <link rel="canonical" href="https://mxnet.apache.org/versions/1.9.1/api/perl/docs/tutorials/symbol" /> |
| <meta property="og:url" content="https://mxnet.apache.org/versions/1.9.1/api/perl/docs/tutorials/symbol" /> |
| <meta property="og:site_name" content="Apache MXNet" /> |
| <script type="application/ld+json"> |
| {"description":"A flexible and efficient library for deep learning.","headline":"Symbol API","@type":"WebPage","url":"https://mxnet.apache.org/versions/1.9.1/api/perl/docs/tutorials/symbol","@context":"https://schema.org"}</script> |
| <!-- End Jekyll SEO tag --> |
| <link rel="stylesheet" href="/versions/1.9.1/assets/docsearch.min.css" /><link rel="stylesheet" href="/versions/1.9.1/assets/main.css"><link type="application/atom+xml" rel="alternate" href="https://mxnet.apache.org/versions/1.9.1/feed.xml" title="Apache MXNet" /><!-- Matomo --> |
| <script> |
| var _paq = window._paq = window._paq || []; |
| /* tracker methods like "setCustomDimension" should be called before "trackPageView" */ |
| /* We explicitly disable cookie tracking to avoid privacy issues */ |
| _paq.push(['disableCookies']); |
| _paq.push(['trackPageView']); |
| _paq.push(['enableLinkTracking']); |
| (function() { |
| var u="https://analytics.apache.org/"; |
| _paq.push(['setTrackerUrl', u+'matomo.php']); |
| _paq.push(['setSiteId', '23']); |
| var d=document, g=d.createElement('script'), s=d.getElementsByTagName('script')[0]; |
| g.async=true; g.src=u+'matomo.js'; s.parentNode.insertBefore(g,s); |
| })(); |
| </script> |
| <!-- End Matomo Code --> |
| |
| <script src="/versions/1.9.1/assets/js/jquery-3.3.1.min.js"></script> |
| <script src="/versions/1.9.1/assets/js/docsearch.min.js"></script><script src="/versions/1.9.1/assets/js/globalSearch.js" defer></script> |
| <script src="/versions/1.9.1/assets/js/clipboard.js" defer></script> |
| <script src="/versions/1.9.1/assets/js/copycode.js" defer></script></head> |
| <body><header class="site-header" role="banner"> |
| |
| <script> |
| $(document).ready(function () { |
| |
| // HEADER OPACITY LOGIC |
| |
| function opacity_header() { |
| var value = "rgba(4,140,204," + ($(window).scrollTop() / 300 + 0.4) + ")" |
| $('.site-header').css("background-color", value) |
| } |
| |
| $(window).scroll(function () { |
| opacity_header() |
| }) |
| opacity_header(); |
| |
| // MENU SELECTOR LOGIC |
| $('.page-link').each( function () { |
| if (window.location.href.includes(this.href)) { |
| $(this).addClass("page-current"); |
| } |
| }); |
| }) |
| </script> |
| <div class="wrapper"> |
| <a class="site-title" rel="author" href="/versions/1.9.1/"><img |
| src="/versions/1.9.1/assets/img/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="gs-search-border"> |
| <div id="gs-search-icon"></div> |
| <form id="global-search-form"> |
| <input id="global-search" type="text" title="Search" placeholder="Search" /> |
| <div id="global-search-dropdown-container"> |
| <button class="gs-current-version btn" type="button" data-toggle="dropdown"> |
| <span id="gs-current-version-label">1.9.1</span> |
| <svg class="gs-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> |
| </button> |
| <ul class="gs-opt-group gs-version-dropdown"> |
| |
| |
| <li class="gs-opt gs-versions">master</li> |
| |
| |
| |
| <li class="gs-opt gs-versions active">1.9.1</li> |
| |
| |
| |
| <li class="gs-opt gs-versions">1.8.0</li> |
| |
| |
| |
| <li class="gs-opt gs-versions">1.7.0</li> |
| |
| |
| |
| <li class="gs-opt gs-versions">1.6.0</li> |
| |
| |
| |
| <li class="gs-opt gs-versions">1.5.0</li> |
| |
| |
| |
| <li class="gs-opt gs-versions">1.4.1</li> |
| |
| |
| |
| <li class="gs-opt gs-versions">1.3.1</li> |
| |
| |
| |
| <li class="gs-opt gs-versions">1.2.1</li> |
| |
| |
| |
| <li class="gs-opt gs-versions">1.1.0</li> |
| |
| |
| |
| <li class="gs-opt gs-versions">1.0.0</li> |
| |
| |
| |
| <li class="gs-opt gs-versions">0.12.1</li> |
| |
| |
| |
| <li class="gs-opt gs-versions">0.11.0</li> |
| |
| |
| </ul> |
| </div> |
| <span id="global-search-close">x</span> |
| </form> |
| </div> |
| <div class="trigger"> |
| <div id="global-search-mobile-border"> |
| <div id="gs-search-icon-mobile"></div> |
| <input id="global-search-mobile" placeholder="Search..." type="text"/> |
| <div id="global-search-dropdown-container-mobile"> |
| <button class="gs-current-version-mobile btn" type="button" data-toggle="dropdown"> |
| <svg class="gs-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> |
| </button> |
| <ul class="gs-opt-group gs-version-dropdown-mobile"> |
| |
| |
| <li class="gs-opt gs-versions">master</li> |
| |
| |
| |
| <li class="gs-opt gs-versions active">1.9.1</li> |
| |
| |
| |
| <li class="gs-opt gs-versions">1.8.0</li> |
| |
| |
| |
| <li class="gs-opt gs-versions">1.7.0</li> |
| |
| |
| |
| <li class="gs-opt gs-versions">1.6.0</li> |
| |
| |
| |
| <li class="gs-opt gs-versions">1.5.0</li> |
| |
| |
| |
| <li class="gs-opt gs-versions">1.4.1</li> |
| |
| |
| |
| <li class="gs-opt gs-versions">1.3.1</li> |
| |
| |
| |
| <li class="gs-opt gs-versions">1.2.1</li> |
| |
| |
| |
| <li class="gs-opt gs-versions">1.1.0</li> |
| |
| |
| |
| <li class="gs-opt gs-versions">1.0.0</li> |
| |
| |
| |
| <li class="gs-opt gs-versions">0.12.1</li> |
| |
| |
| |
| <li class="gs-opt gs-versions">0.11.0</li> |
| |
| |
| </ul> |
| </div> |
| </div> |
| <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" 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://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 href="/">master</a> |
| <a class="dropdown-option-active" href="/versions/1.9.1/">1.9.1</a> |
| <a href="/versions/1.8.0/">1.8.0</a> |
| <a href="/versions/1.7.0/">1.7.0</a> |
| <a href="/versions/1.6.0/">1.6.0</a> |
| <a href="/versions/1.5.0/">1.5.0</a> |
| <a href="/versions/1.4.1/">1.4.1</a> |
| <a href="/versions/1.3.1/">1.3.1</a> |
| <a href="/versions/1.2.1/">1.2.1</a> |
| <a href="/versions/1.1.0/">1.1.0</a> |
| <a href="/versions/1.0.0/">1.0.0</a> |
| <a href="/versions/0.12.1/">0.12.1</a> |
| <a href="/versions/0.11.0/">0.11.0</a> |
| </div> |
| </div> |
| </div> |
| </nav> |
| </div> |
| </header> |
| <main class="page-content" aria-label="Content"> |
| <script> |
| |
| </script> |
| <article class="post"> |
| |
| <header class="post-header wrapper"> |
| <h1 class="post-title">Symbol API</h1> |
| <h3></h3></header> |
| |
| <div class="post-content"> |
| <div class="wrapper"> |
| <div class="row"> |
| <div class="col-3 docs-side-bar"> |
| |
| |
| <!-- resource-p --> |
| |
| <!-- resource-p --> |
| |
| <!-- resource-p --> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <div class="docs-card docs-side"> |
| <ul> |
| <div class="docs-action-btn"> |
| <a href="/versions/1.9.1/api/perl"> <img src="/versions/1.9.1/assets/img/compass.svg" |
| class="docs-logo-docs">Perl Guide <span |
| class="span-accented">›</span></a> |
| </div> |
| <div class="docs-action-btn"> |
| <a href="/versions/1.9.1/api/perl/docs/tutorials"> <img |
| src="/versions/1.9.1/assets/img/video-tutorial.svg" class="docs-logo-docs">Perl |
| Tutorials <span class="span-accented">›</span></a> |
| </div> |
| <div class="docs-action-btn"> |
| <a href="https://metacpan.org/release/AI-MXNet"> <img src="/versions/1.9.1/assets/img/api.svg" |
| class="docs-logo-docs">Perl API Reference |
| <span class="span-accented">›</span></a> |
| </div> |
| |
| <!-- Let's show the list of tutorials --> |
| <br> |
| |
| <h3>Tutorials</h3> |
| |
| <!-- resource-p --> |
| |
| <!-- resource-p --> |
| |
| <!-- resource-p --> |
| |
| <!-- resource-p --> |
| |
| |
| <!-- page-category --> |
| <!-- resource-p --> |
| |
| <!-- resource-p --> |
| |
| <!-- resource-p --> |
| |
| |
| <!-- page-category --> |
| <!-- resource-p --> |
| |
| |
| <!-- page-category --> |
| <!-- resource-p --> |
| |
| |
| <!-- page-category --> |
| <!-- resource-p --> |
| |
| |
| <!-- page-category --> |
| <!-- resource-p --> |
| |
| <!-- resource-p --> |
| |
| <!-- resource-p --> |
| |
| |
| <!-- page-category --> |
| <!-- resource-p --> |
| |
| |
| <!-- page-category --> |
| <!-- resource-p --> |
| |
| <!-- resource-p --> |
| |
| <!-- resource-p --> |
| |
| <!-- resource-p --> |
| |
| <!-- resource-p --> |
| |
| <!-- resource-p --> |
| |
| <!-- resource-p --> |
| |
| <!-- resource-p --> |
| |
| <!-- resource-p --> |
| |
| <!-- resource-p --> |
| |
| |
| <!-- page-category --> |
| <!-- resource-p --> |
| |
| <!-- resource-p --> |
| |
| <!-- resource-p --> |
| |
| <!-- resource-p --> |
| |
| <!-- resource-p --> |
| |
| <!-- resource-p --> |
| |
| <!-- resource-p --> |
| |
| <!-- resource-p --> |
| |
| <!-- resource-p --> |
| |
| <!-- resource-p --> |
| |
| <!-- resource-p --> |
| |
| <!-- resource-p --> |
| |
| <!-- resource-p --> |
| |
| <!-- resource-p --> |
| |
| <!-- resource-p --> |
| |
| <!-- resource-p --> |
| |
| <!-- resource-p --> |
| |
| <!-- resource-p --> |
| |
| <!-- resource-p --> |
| |
| |
| <!-- page-category --> |
| <!-- resource-p --> |
| |
| |
| |
| <li><a href="/versions/1.9.1/api/perl/docs/tutorials/io">Data Loading API</a></li> |
| <!-- page-category --> |
| <!-- resource-p --> |
| |
| |
| <!-- page-category --> |
| <!-- resource-p --> |
| |
| <!-- resource-p --> |
| |
| <!-- resource-p --> |
| |
| |
| |
| <li><a href="/versions/1.9.1/api/perl/docs/tutorials/kvstore">KVStore API</a></li> |
| <!-- page-category --> |
| <!-- resource-p --> |
| |
| |
| <!-- page-category --> |
| <!-- resource-p --> |
| |
| |
| <!-- page-category --> |
| <!-- resource-p --> |
| |
| <!-- resource-p --> |
| |
| <!-- resource-p --> |
| |
| |
| <!-- page-category --> |
| <!-- resource-p --> |
| |
| |
| <!-- page-category --> |
| <!-- resource-p --> |
| |
| |
| <!-- page-category --> |
| <!-- resource-p --> |
| |
| <!-- resource-p --> |
| |
| |
| |
| <li><a href="/versions/1.9.1/api/perl/docs/tutorials/module">Module API</a></li> |
| <!-- page-category --> |
| <!-- resource-p --> |
| |
| |
| <!-- page-category --> |
| <!-- resource-p --> |
| |
| |
| <!-- page-category --> |
| <!-- resource-p --> |
| |
| <!-- resource-p --> |
| |
| |
| <!-- page-category --> |
| <!-- resource-p --> |
| |
| |
| <!-- page-category --> |
| <!-- resource-p --> |
| |
| |
| <!-- page-category --> |
| <!-- resource-p --> |
| |
| |
| <!-- page-category --> |
| <!-- resource-p --> |
| |
| |
| <!-- page-category --> |
| <!-- resource-p --> |
| |
| |
| |
| <li><a href="/versions/1.9.1/api/perl/docs/tutorials/ndarray">NDArray API</a></li> |
| <!-- page-category --> |
| <!-- resource-p --> |
| |
| |
| <!-- page-category --> |
| <!-- resource-p --> |
| |
| |
| <!-- page-category --> |
| <!-- resource-p --> |
| |
| |
| <!-- page-category --> |
| <!-- resource-p --> |
| |
| <!-- resource-p --> |
| |
| <!-- resource-p --> |
| |
| <!-- resource-p --> |
| |
| <!-- resource-p --> |
| |
| <!-- resource-p --> |
| |
| <!-- resource-p --> |
| |
| <!-- resource-p --> |
| |
| <!-- resource-p --> |
| |
| <!-- resource-p --> |
| |
| <!-- resource-p --> |
| |
| <!-- resource-p --> |
| |
| <!-- resource-p --> |
| |
| <!-- resource-p --> |
| |
| <!-- resource-p --> |
| |
| <!-- resource-p --> |
| |
| |
| <!-- page-category --> |
| <!-- resource-p --> |
| |
| |
| <!-- page-category --> |
| <!-- resource-p --> |
| |
| |
| |
| <li><a href="/versions/1.9.1/api/perl/docs/tutorials/symbol">Symbol API</a></li> |
| <!-- page-category --> |
| <!-- resource-p --> |
| |
| |
| <!-- page-category --> |
| <!-- resource-p --> |
| |
| |
| <!-- page-category --> |
| <!-- resource-p --> |
| |
| |
| <!-- page-category --> |
| <!-- resource-p --> |
| |
| |
| <!-- page-category --> |
| <!-- resource-p --> |
| |
| |
| <!-- page-category --> |
| <!-- resource-p --> |
| |
| <!-- resource-p --> |
| |
| <!-- resource-p --> |
| |
| <!-- resource-p --> |
| |
| <!-- resource-p --> |
| |
| <!-- resource-p --> |
| |
| <!-- resource-p --> |
| |
| <!-- resource-p --> |
| <!-- page --> |
| |
| </ul> |
| </div> |
| |
| |
| <!-- resource-p --> |
| |
| <!-- resource-p --> |
| |
| <!-- resource-p --> |
| |
| <!-- resource-p --> |
| |
| <!-- resource-p --> |
| |
| <!-- resource-p --> |
| |
| <!-- resource-p --> |
| |
| <!-- resource-p --> |
| |
| <!-- resource-p --> |
| |
| <!-- resource-p --> |
| |
| <!-- resource-p --> |
| |
| <!-- resource-p --> |
| |
| <!-- resource-p --> |
| |
| <!-- resource-p --> |
| |
| <!-- resource-p --> |
| |
| <!-- resource-p --> |
| |
| <!-- resource-p --> |
| |
| <!-- resource-p --> |
| |
| <!-- resource-p --> |
| |
| <!-- resource-p --> |
| |
| <!-- resource-p --> |
| |
| <!-- resource-p --> |
| |
| <!-- resource-p --> |
| |
| <!-- resource-p --> |
| |
| <!-- resource-p --> |
| |
| <!-- resource-p --> |
| |
| <!-- resource-p --> |
| |
| <!-- resource-p --> |
| |
| <!-- resource-p --> |
| |
| <!-- resource-p --> |
| |
| <!-- resource-p --> |
| |
| <!-- resource-p --> |
| |
| <!-- resource-p --> |
| |
| <!-- resource-p --> |
| |
| <!-- resource-p --> |
| |
| <!-- resource-p --> |
| |
| <!-- resource-p --> |
| |
| <!-- resource-p --> |
| |
| <!-- resource-p --> |
| |
| <!-- resource-p --> |
| |
| <!-- resource-p --> |
| |
| <!-- resource-p --> |
| |
| <!-- resource-p --> |
| |
| <!-- resource-p --> |
| |
| <!-- resource-p --> |
| |
| <!-- resource-p --> |
| |
| <!-- resource-p --> |
| |
| <!-- resource-p --> |
| |
| <!-- resource-p --> |
| |
| <!-- resource-p --> |
| |
| <!-- resource-p --> |
| |
| <!-- resource-p --> |
| |
| <!-- resource-p --> |
| |
| <!-- resource-p --> |
| |
| <!-- resource-p --> |
| |
| <!-- resource-p --> |
| |
| <!-- resource-p --> |
| |
| <!-- resource-p --> |
| |
| <!-- resource-p --> |
| |
| <!-- resource-p --> |
| |
| <!-- resource-p --> |
| |
| <!-- resource-p --> |
| |
| <!-- resource-p --> |
| |
| <!-- resource-p --> |
| |
| <!-- resource-p --> |
| |
| <!-- resource-p --> |
| |
| <!-- resource-p --> |
| |
| <!-- resource-p --> |
| |
| <!-- resource-p --> |
| |
| <!-- resource-p --> |
| |
| <!-- resource-p --> |
| |
| <!-- resource-p --> |
| |
| <!-- resource-p --> |
| |
| <!-- resource-p --> |
| |
| <!-- resource-p --> |
| |
| <!-- resource-p --> |
| |
| <!-- resource-p --> |
| |
| <!-- resource-p --> |
| |
| <!-- resource-p --> |
| |
| <!-- resource-p --> |
| |
| <!-- resource-p --> |
| |
| <!-- resource-p --> |
| |
| <!-- resource-p --> |
| |
| <!-- resource-p --> |
| |
| <!-- resource-p --> |
| |
| <!-- resource-p --> |
| |
| <!-- resource-p --> |
| |
| <!-- resource-p --> |
| |
| <!-- resource-p --> |
| |
| <!-- resource-p --> |
| |
| <!-- resource-p --> |
| |
| <!-- resource-p --> |
| |
| <!-- resource-p --> |
| |
| <!-- resource-p --> |
| |
| <!-- resource-p --> |
| |
| <!-- resource-p --> |
| |
| <!-- resource-p --> |
| <!-- page --> |
| </ul> |
| </div> |
| <div class="col-9"> |
| <!--- Licensed to the Apache Software Foundation (ASF) under one --> |
| |
| <!--- or more contributor license agreements. See the NOTICE file --> |
| |
| <!--- distributed with this work for additional information --> |
| |
| <!--- regarding copyright ownership. The ASF licenses this file --> |
| |
| <!--- to you under the Apache License, Version 2.0 (the --> |
| |
| <!--- "License"); you may not use this file except in compliance --> |
| |
| <!--- with the License. You may obtain a copy of the License at --> |
| |
| <!--- http://www.apache.org/licenses/LICENSE-2.0 --> |
| |
| <!--- Unless required by applicable law or agreed to in writing, --> |
| |
| <!--- software distributed under the License is distributed on an --> |
| |
| <!--- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY --> |
| |
| <!--- KIND, either express or implied. See the License for the --> |
| |
| <!--- specific language governing permissions and limitations --> |
| |
| <!--- under the License. --> |
| |
| <h1 id="mxnet-perl-symbolic-api">MXNet Perl Symbolic API</h1> |
| |
| <p>Topics:</p> |
| |
| <ul> |
| <li><a href="#how-to-compose-symbols">How to Compose Symbols</a> introduces operator overloading of symbols.</li> |
| <li><a href="#symbol-attributes">Symbol Attributes</a> describes how to attach attributes to symbols.</li> |
| <li><a href="#serialization">Serialization</a> explains how to save and load symbols.</li> |
| <li><a href="#executing-symbols">Executing Symbols</a> explains how to evaluate the symbols with data.</li> |
| <li><a href="#multiple-outputs">Multiple Outputs</a> explains how to configure multiple outputs.</li> |
| </ul> |
| |
| <h2 id="how-to-compose-symbols">How to Compose Symbols</h2> |
| |
| <p>The symbolic API provides a way to configure computation graphs. |
| You can configure the graphs either at the level of neural network layer operations or as fine-grained operations.</p> |
| |
| <p>The following example configures a two-layer neural network.</p> |
| <div class="highlight"><pre><code class="language-perl" data-lang="perl"><span class="nv">pdl</span><span class="o">></span> <span class="k">use</span> <span class="nn">AI::</span><span class="nv">MXNet</span> <span class="sx">qw(mx)</span> |
| <span class="nv">pdl</span><span class="o">></span> <span class="nv">$data</span> <span class="o">=</span> <span class="nv">mx</span><span class="o">-></span><span class="nv">symbol</span><span class="o">-></span><span class="nv">Variable</span><span class="p">("</span><span class="s2">data</span><span class="p">")</span> |
| <span class="nv">pdl</span><span class="o">></span> <span class="nv">$fc1</span> <span class="o">=</span> <span class="nv">mx</span><span class="o">-></span><span class="nv">symbol</span><span class="o">-></span><span class="nv">FullyConnected</span><span class="p">(</span><span class="nv">data</span> <span class="o">=></span> <span class="nv">$data</span><span class="p">,</span> <span class="nv">name</span> <span class="o">=></span> <span class="p">"</span><span class="s2">fc1</span><span class="p">",</span> <span class="nv">num_hidden</span> <span class="o">=></span> <span class="mi">128</span><span class="p">)</span> |
| <span class="nv">pdl</span><span class="o">></span> <span class="nv">$act1</span> <span class="o">=</span> <span class="nv">mx</span><span class="o">-></span><span class="nv">symbol</span><span class="o">-></span><span class="nv">Activation</span><span class="p">(</span><span class="nv">data</span> <span class="o">=></span> <span class="nv">$fc1</span><span class="p">,</span> <span class="nv">name</span> <span class="o">=></span> <span class="p">"</span><span class="s2">relu1</span><span class="p">",</span> <span class="nv">act_type</span> <span class="o">=></span> <span class="p">"</span><span class="s2">relu</span><span class="p">")</span> |
| <span class="nv">pdl</span><span class="o">></span> <span class="nv">$fc2</span> <span class="o">=</span> <span class="nv">mx</span><span class="o">-></span><span class="nv">symbol</span><span class="o">-></span><span class="nv">FullyConnected</span><span class="p">(</span><span class="nv">data</span> <span class="o">=></span> <span class="nv">$act1</span><span class="p">,</span> <span class="nv">name</span> <span class="o">=></span> <span class="p">"</span><span class="s2">fc2</span><span class="p">",</span> <span class="nv">num_hidden</span> <span class="o">=></span> <span class="mi">64</span><span class="p">)</span> |
| <span class="nv">pdl</span><span class="o">></span> <span class="nv">$net</span> <span class="o">=</span> <span class="nv">mx</span><span class="o">-></span><span class="nv">symbol</span><span class="o">-></span><span class="nv">SoftmaxOutput</span><span class="p">(</span><span class="nv">data</span> <span class="o">=></span> <span class="nv">$fc2</span><span class="p">,</span> <span class="nv">name</span> <span class="o">=></span> <span class="p">"</span><span class="s2">out</span><span class="p">")</span> |
| </code></pre></div> |
| <p>The basic arithmetic operators (plus, minus, div, multiplication) are overloaded for |
| <em>element-wise operations</em> of symbols.</p> |
| |
| <p>The following example creates a computation graph that adds two inputs together.</p> |
| <div class="highlight"><pre><code class="language-perl" data-lang="perl"><span class="nv">pdl</span><span class="o">></span> <span class="k">use</span> <span class="nn">AI::</span><span class="nv">MXNet</span> <span class="sx">qw(mx)</span> |
| <span class="nv">pdl</span><span class="o">></span> <span class="nv">$a</span> <span class="o">=</span> <span class="nv">mx</span><span class="o">-></span><span class="nv">symbol</span><span class="o">-></span><span class="nv">Variable</span><span class="p">("</span><span class="s2">a</span><span class="p">")</span> |
| <span class="nv">pdl</span><span class="o">></span> <span class="nv">$b</span> <span class="o">=</span> <span class="nv">mx</span><span class="o">-></span><span class="nv">symbol</span><span class="o">-></span><span class="nv">Variable</span><span class="p">("</span><span class="s2">b</span><span class="p">")</span> |
| <span class="nv">pdl</span><span class="o">></span> <span class="nv">$c</span> <span class="o">=</span> <span class="nv">$a</span> <span class="o">+</span> <span class="nv">$b</span> |
| </code></pre></div> |
| <h2 id="symbol-attributes">Symbol Attributes</h2> |
| |
| <p>You can add an attribute to a symbol by providing an attribute hash when you create a symbol.</p> |
| <div class="highlight"><pre><code class="language-perl" data-lang="perl"><span class="nv">$data</span> <span class="o">=</span> <span class="nv">mx</span><span class="o">-></span><span class="nv">symbol</span><span class="o">-></span><span class="nv">Variable</span><span class="p">("</span><span class="s2">data</span><span class="p">",</span> <span class="nv">attr</span> <span class="o">=></span> <span class="p">{</span> <span class="nv">mood</span> <span class="o">=></span> <span class="p">"</span><span class="s2">angry</span><span class="p">"</span> <span class="p">})</span> |
| <span class="nv">$op</span> <span class="o">=</span> <span class="nv">mx</span><span class="o">-></span><span class="nv">symbol</span><span class="o">-></span><span class="nv">Convolution</span><span class="p">(</span><span class="nv">data</span> <span class="o">=></span> <span class="nv">$data</span><span class="p">,</span> <span class="nv">kernel</span> <span class="o">=></span> <span class="p">[</span><span class="mi">1</span><span class="p">,</span> <span class="mi">1</span><span class="p">],</span> <span class="nv">num_filter</span> <span class="o">=></span> <span class="mi">1</span><span class="p">,</span> <span class="nv">attr</span> <span class="o">=></span> <span class="p">{</span> <span class="nv">mood</span> <span class="o">=></span> <span class="p">"</span><span class="s2">so so</span><span class="p">"</span> <span class="p">})</span> |
| </code></pre></div> |
| <p>For proper communication with the C++ backend, both the key and values of the attribute dictionary should be strings. To retrieve the attributes, use <code>->attr($key)</code>:</p> |
| <div class="highlight"><pre><code class="language-" data-lang=""> $data->attr("mood") |
| </code></pre></div> |
| <p>To attach attributes, you can use <code>AI::MXNet::AttrScope</code>. <code>AI::MXNet::AttrScopeAttrScope</code> automatically adds |
| the specified attributes to all of the symbols created within that scope. |
| The user can also inherit this object to change naming behavior. For example:</p> |
| <div class="highlight"><pre><code class="language-perl" data-lang="perl"><span class="k">use</span> <span class="nn">AI::</span><span class="nv">MXNet</span> <span class="sx">qw(mx)</span><span class="p">;</span> |
| <span class="k">use</span> <span class="nn">Test::</span><span class="nv">More</span> <span class="nv">tests</span> <span class="o">=></span> <span class="mi">3</span><span class="p">;</span> |
| <span class="k">my</span> <span class="p">(</span><span class="nv">$data</span><span class="p">,</span> <span class="nv">$gdata</span><span class="p">);</span> |
| <span class="p">{</span> |
| <span class="nb">local</span><span class="p">(</span><span class="nv">$</span><span class="nn">mx::</span><span class="nv">AttrScope</span><span class="p">)</span> <span class="o">=</span> <span class="nv">mx</span><span class="o">-></span><span class="nv">AttrScope</span><span class="p">(</span><span class="nv">group</span><span class="o">=></span><span class="mi">4</span><span class="p">,</span> <span class="nv">data</span><span class="o">=></span><span class="p">'</span><span class="s1">great</span><span class="p">');</span> |
| <span class="nv">$data</span> <span class="o">=</span> <span class="nv">mx</span><span class="o">-></span><span class="nv">sym</span><span class="o">-></span><span class="nv">Variable</span><span class="p">("</span><span class="s2">data</span><span class="p">",</span> <span class="nv">attr</span> <span class="o">=></span> <span class="p">{</span> <span class="nv">dtype</span> <span class="o">=></span> <span class="p">"</span><span class="s2">data</span><span class="p">",</span> <span class="nv">group</span> <span class="o">=></span> <span class="p">"</span><span class="s2">1</span><span class="p">"</span> <span class="p">});</span> |
| <span class="nv">$gdata</span> <span class="o">=</span> <span class="nv">mx</span><span class="o">-></span><span class="nv">sym</span><span class="o">-></span><span class="nv">Variable</span><span class="p">("</span><span class="s2">data2</span><span class="p">");</span> |
| <span class="p">}</span> |
| <span class="nv">ok</span><span class="p">(</span><span class="nv">$gdata</span><span class="o">-></span><span class="nv">attr</span><span class="p">("</span><span class="s2">group</span><span class="p">")</span> <span class="o">==</span> <span class="mi">4</span><span class="p">);</span> |
| <span class="nv">ok</span><span class="p">(</span><span class="nv">$data</span><span class="o">-></span><span class="nv">attr</span><span class="p">("</span><span class="s2">group</span><span class="p">")</span> <span class="o">==</span> <span class="mi">1</span><span class="p">);</span> |
| |
| <span class="k">my</span> <span class="nv">$exceedScopeData</span> <span class="o">=</span> <span class="nv">mx</span><span class="o">-></span><span class="nv">sym</span><span class="o">-></span><span class="nv">Variable</span><span class="p">("</span><span class="s2">data3</span><span class="p">");</span> |
| <span class="nv">ok</span><span class="p">((</span><span class="ow">not</span> <span class="nb">defined</span> <span class="nv">$exceedScopeData</span><span class="o">-></span><span class="nv">attr</span><span class="p">("</span><span class="s2">group</span><span class="p">")),</span> <span class="p">"</span><span class="s2">No group attr in global attr scope</span><span class="p">");</span> |
| </code></pre></div> |
| <h2 id="serialization">Serialization</h2> |
| |
| <p>There are two ways to save and load the symbols. You can use the <code>mx->symbol->save</code> and <code>mxnet->symbol->load</code> functions to serialize the <code>AI::MXNet::Symbol</code> objects. |
| The advantage of using <code>save</code> and <code>load</code> functions is that it is language agnostic and cloud friendly. |
| The symbol is saved in JSON format. You can also get a JSON string directly using <code>$symbol->tojson</code>.</p> |
| |
| <p>The following example shows how to save a symbol to an S3 bucket, load it back, and compare two symbols using a JSON string.</p> |
| <div class="highlight"><pre><code class="language-perl" data-lang="perl"><span class="nv">pdl</span><span class="o">></span> <span class="k">use</span> <span class="nn">AI::</span><span class="nv">MXNet</span> <span class="sx">qw(mx)</span> |
| <span class="nv">pdl</span><span class="o">></span> <span class="nv">$a</span> <span class="o">=</span> <span class="nv">mx</span><span class="o">-></span><span class="nv">sym</span><span class="o">-></span><span class="nv">Variable</span><span class="p">("</span><span class="s2">a</span><span class="p">")</span> |
| <span class="nv">pdl</span><span class="o">></span> <span class="nv">$b</span> <span class="o">=</span> <span class="nv">mx</span><span class="o">-></span><span class="nv">sym</span><span class="o">-></span><span class="nv">Variable</span><span class="p">("</span><span class="s2">b</span><span class="p">")</span> |
| <span class="nv">pdl</span><span class="o">></span> <span class="nv">$c</span> <span class="o">=</span> <span class="nv">$a</span> <span class="o">+</span> <span class="nv">$b</span> |
| <span class="nv">pdl</span><span class="o">></span> <span class="nv">$c</span><span class="o">-></span><span class="nv">save</span><span class="p">("</span><span class="s2">s3://my-bucket/symbol-c.json</span><span class="p">")</span> |
| <span class="nv">pdl</span><span class="o">></span> <span class="nv">$c2</span> <span class="o">=</span> <span class="nv">$c</span><span class="o">-></span><span class="nv">load</span><span class="p">("</span><span class="s2">s3://my-bucket/symbol-c.json</span><span class="p">")</span> |
| <span class="nv">pdl</span><span class="o">></span> <span class="nv">ok</span><span class="p">(</span><span class="nv">$c</span><span class="o">-></span><span class="nv">tojson</span> <span class="ow">eq</span> <span class="nv">$c2</span><span class="o">-></span><span class="nv">tojson</span><span class="p">)</span> |
| <span class="nv">ok</span> <span class="mi">1</span> |
| </code></pre></div> |
| <h2 id="executing-symbols">Executing Symbols</h2> |
| |
| <p>After you have assembled a set of symbols into a computation graph, the MXNet engine can evaluate them. |
| If you are training a neural network, this is typically |
| handled by the high-level <a href="module">AI::MXNet::Module package</a> and the [<code>fit()</code>] function.</p> |
| |
| <p>For neural networks used in "feed-forward", "prediction", or "inference" mode (all terms for the same |
| thing: running a trained network), the input arguments are the |
| input data, and the weights of the neural network that were learned during training.</p> |
| |
| <p>To manually execute a set of symbols, you need to create an [<code>AI::MXNet::Executor</code>] object, |
| which is typically constructed by calling the [<code>simple_bind(<parameters>)</code>] method on a AI::MXNet::Symbol.</p> |
| |
| <h2 id="multiple-outputs">Multiple Outputs</h2> |
| |
| <p>To group the symbols together, use the <a href="#mxnet.symbol.Group">AI::MXNet::Symbol->Group</a> function.</p> |
| <div class="highlight"><pre><code class="language-perl" data-lang="perl"><span class="nv">pdl</span><span class="o">></span> <span class="k">use</span> <span class="nn">AI::</span><span class="nv">MXNet</span> <span class="sx">qw(mx)</span> |
| <span class="nv">pdl</span><span class="o">></span> <span class="k">use</span> <span class="nn">Data::</span><span class="nv">Dumper</span> |
| <span class="nv">pdl</span><span class="o">></span> <span class="nv">$data</span> <span class="o">=</span> <span class="nv">mx</span><span class="o">-></span><span class="nv">sym</span><span class="o">-></span><span class="nv">Variable</span><span class="p">("</span><span class="s2">data</span><span class="p">")</span> |
| <span class="nv">pdl</span><span class="o">></span> <span class="nv">$fc1</span> <span class="o">=</span> <span class="nv">mx</span><span class="o">-></span><span class="nv">sym</span><span class="o">-></span><span class="nv">FullyConnected</span><span class="p">(</span><span class="nv">$data</span><span class="p">,</span> <span class="nv">name</span> <span class="o">=></span> <span class="p">"</span><span class="s2">fc1</span><span class="p">",</span> <span class="nv">num_hidden</span> <span class="o">=></span> <span class="mi">128</span><span class="p">)</span> |
| <span class="nv">pdl</span><span class="o">></span> <span class="nv">$act1</span> <span class="o">=</span> <span class="nv">mx</span><span class="o">-></span><span class="nv">sym</span><span class="o">-></span><span class="nv">Activation</span><span class="p">(</span><span class="nv">$fc1</span><span class="p">,</span> <span class="nv">name</span> <span class="o">=></span> <span class="p">"</span><span class="s2">relu1</span><span class="p">",</span> <span class="nv">act_type</span> <span class="o">=></span> <span class="p">"</span><span class="s2">relu</span><span class="p">")</span> |
| <span class="nv">pdl</span><span class="o">></span> <span class="nv">$fc2</span> <span class="o">=</span> <span class="nv">mx</span><span class="o">-></span><span class="nv">sym</span><span class="o">-></span><span class="nv">FullyConnected</span><span class="p">(</span><span class="nv">$act1</span><span class="p">,</span> <span class="nv">name</span> <span class="o">=></span> <span class="p">"</span><span class="s2">fc2</span><span class="p">",</span> <span class="nv">num_hidden</span> <span class="o">=></span> <span class="mi">64</span><span class="p">)</span> |
| <span class="nv">pdl</span><span class="o">></span> <span class="nv">$net</span> <span class="o">=</span> <span class="nv">mx</span><span class="o">-></span><span class="nv">sym</span><span class="o">-></span><span class="nv">SoftmaxOutput</span><span class="p">(</span><span class="nv">$fc2</span><span class="p">,</span> <span class="nv">name</span> <span class="o">=></span> <span class="p">"</span><span class="s2">softmax</span><span class="p">")</span> |
| <span class="nv">pdl</span><span class="o">></span> <span class="nv">$group</span> <span class="o">=</span> <span class="nv">mx</span><span class="o">-></span><span class="nv">sym</span><span class="o">-></span><span class="nv">Group</span><span class="p">([</span><span class="nv">$fc1</span><span class="p">,</span> <span class="nv">$net</span><span class="p">])</span> |
| <span class="nv">pdl</span><span class="o">></span> <span class="k">print</span> <span class="nv">Dumper</span><span class="p">(</span><span class="nv">$group</span><span class="o">-></span><span class="nv">list_outputs</span><span class="p">())</span> |
| <span class="nv">$VAR1</span> <span class="o">=</span> <span class="p">[</span> |
| <span class="p">'</span><span class="s1">fc1_output</span><span class="p">',</span> |
| <span class="p">'</span><span class="s1">softmax_output</span><span class="p">'</span> |
| <span class="p">];</span> |
| </code></pre></div> |
| <p>After you get the <code>Group</code>, you can bind on <code>group</code> instead. |
| The resulting executor will have two outputs, one for fc1_output and one for softmax_output.</p> |
| </div> |
| </div> |
| |
| </div> |
| </div> |
| |
| </article> |
| |
| </main><footer class="site-footer h-card"> |
| <div class="wrapper"> |
| <div class="row"> |
| <div class="col-4"> |
| <h4 class="footer-category-title">Resources</h4> |
| <ul class="contact-list"> |
| <li><a href="/versions/1.9.1/community/contribute#mxnet-dev-communications">Mailing lists</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="/versions/1.9.1/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="/versions/1.9.1/assets/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="/versions/1.9.1/assets/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="/versions/1.9.1/assets/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="/versions/1.9.1/assets/img/asf_logo.svg" class="footer-logo col-2"> |
| </div> |
| <div class="footer-bottom-warning col-9"> |
| </p><p>"Copyright © 2017-2022, The Apache Software Foundation. Licensed under the Apache License, Version 2.0. 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> |
