| <!DOCTYPE html> |
| |
| <html lang="en"> |
| <head> |
| <meta charset="utf-8"/> |
| <meta content="IE=edge" http-equiv="X-UA-Compatible"/> |
| <meta content="width=device-width, initial-scale=1" name="viewport"/> |
| <meta content="mxnet.profiler" property="og:title"> |
| <meta content="https://raw.githubusercontent.com/dmlc/web-data/master/mxnet/image/og-logo.png" property="og:image"> |
| <meta content="https://raw.githubusercontent.com/dmlc/web-data/master/mxnet/image/og-logo.png" property="og:image:secure_url"> |
| <meta content="mxnet.profiler" property="og:description"/> |
| <title>mxnet.profiler — mxnet documentation</title> |
| <link crossorigin="anonymous" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.6/css/bootstrap.min.css" integrity="sha384-1q8mTJOASx8j1Au+a5WDVnPi2lkFfwwEAa8hDDdjZlpLegxhjVME1fgjWPGmkzs7" rel="stylesheet"/> |
| <link href="https://maxcdn.bootstrapcdn.com/font-awesome/4.5.0/css/font-awesome.min.css" rel="stylesheet"/> |
| <link href="../../_static/basic.css" rel="stylesheet" type="text/css"> |
| <link href="../../_static/pygments.css" rel="stylesheet" type="text/css"> |
| <link href="../../_static/mxnet.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript"> |
| var DOCUMENTATION_OPTIONS = { |
| URL_ROOT: '../../', |
| VERSION: '', |
| COLLAPSE_INDEX: false, |
| FILE_SUFFIX: '.html', |
| HAS_SOURCE: true, |
| SOURCELINK_SUFFIX: '.txt' |
| }; |
| </script> |
| <script src="https://code.jquery.com/jquery-1.11.1.min.js" type="text/javascript"></script> |
| <script src="../../_static/underscore.js" type="text/javascript"></script> |
| <script src="../../_static/searchtools_custom.js" type="text/javascript"></script> |
| <script src="../../_static/doctools.js" type="text/javascript"></script> |
| <script src="../../_static/selectlang.js" type="text/javascript"></script> |
| <script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML" type="text/javascript"></script> |
| <script type="text/javascript"> jQuery(function() { Search.loadIndex("/versions/1.3.1/searchindex.js"); Search.init();}); </script> |
| <script> |
| (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ |
| (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new |
| Date();a=s.createElement(o), |
| m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) |
| })(window,document,'script','https://www.google-analytics.com/analytics.js','ga'); |
| |
| ga('create', 'UA-96378503-1', 'auto'); |
| ga('send', 'pageview'); |
| |
| </script> |
| <!-- --> |
| <!-- <script type="text/javascript" src="../../_static/jquery.js"></script> --> |
| <!-- --> |
| <!-- <script type="text/javascript" src="../../_static/underscore.js"></script> --> |
| <!-- --> |
| <!-- <script type="text/javascript" src="../../_static/doctools.js"></script> --> |
| <!-- --> |
| <!-- <script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.0/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script> --> |
| <!-- --> |
| <link href="../../genindex.html" rel="index" title="Index"> |
| <link href="../../search.html" rel="search" title="Search"/> |
| <link href="../index.html" rel="up" title="Module code"/> |
| <link href="https://raw.githubusercontent.com/dmlc/web-data/master/mxnet/image/mxnet-icon.png" rel="icon" type="image/png"/> |
| </link></link></link></meta></meta></meta></head> |
| <body background="https://raw.githubusercontent.com/dmlc/web-data/master/mxnet/image/mxnet-background-compressed.jpeg" role="document"> |
| <div class="content-block"><div class="navbar navbar-fixed-top"> |
| <div class="container" id="navContainer"> |
| <div class="innder" id="header-inner"> |
| <h1 id="logo-wrap"> |
| <a href="../../" id="logo"><img src="https://raw.githubusercontent.com/dmlc/web-data/master/mxnet/image/mxnet_logo.png"/></a> |
| </h1> |
| <nav class="nav-bar" id="main-nav"> |
| <a class="main-nav-link" href="/versions/1.3.1/install/index.html">Install</a> |
| <span id="dropdown-menu-position-anchor"> |
| <a aria-expanded="true" aria-haspopup="true" class="main-nav-link dropdown-toggle" data-toggle="dropdown" href="#" role="button">Gluon <span class="caret"></span></a> |
| <ul class="dropdown-menu navbar-menu" id="package-dropdown-menu"> |
| <li><a class="main-nav-link" href="/versions/1.3.1/tutorials/gluon/gluon.html">About</a></li> |
| <li><a class="main-nav-link" href="https://www.d2l.ai/">Dive into Deep Learning</a></li> |
| <li><a class="main-nav-link" href="https://gluon-cv.mxnet.io">GluonCV Toolkit</a></li> |
| <li><a class="main-nav-link" href="https://gluon-nlp.mxnet.io/">GluonNLP Toolkit</a></li> |
| </ul> |
| </span> |
| <span id="dropdown-menu-position-anchor"> |
| <a aria-expanded="true" aria-haspopup="true" class="main-nav-link dropdown-toggle" data-toggle="dropdown" href="#" role="button">API <span class="caret"></span></a> |
| <ul class="dropdown-menu navbar-menu" id="package-dropdown-menu"> |
| <li><a class="main-nav-link" href="/versions/1.3.1/api/python/index.html">Python</a></li> |
| <li><a class="main-nav-link" href="/versions/1.3.1/api/c++/index.html">C++</a></li> |
| <li><a class="main-nav-link" href="/versions/1.3.1/api/clojure/index.html">Clojure</a></li> |
| <li><a class="main-nav-link" href="/versions/1.3.1/api/julia/index.html">Julia</a></li> |
| <li><a class="main-nav-link" href="/versions/1.3.1/api/perl/index.html">Perl</a></li> |
| <li><a class="main-nav-link" href="/versions/1.3.1/api/r/index.html">R</a></li> |
| <li><a class="main-nav-link" href="/versions/1.3.1/api/scala/index.html">Scala</a></li> |
| </ul> |
| </span> |
| <span id="dropdown-menu-position-anchor-docs"> |
| <a aria-expanded="true" aria-haspopup="true" class="main-nav-link dropdown-toggle" data-toggle="dropdown" href="#" role="button">Docs <span class="caret"></span></a> |
| <ul class="dropdown-menu navbar-menu" id="package-dropdown-menu-docs"> |
| <li><a class="main-nav-link" href="/versions/1.3.1/faq/index.html">FAQ</a></li> |
| <li><a class="main-nav-link" href="/versions/1.3.1/tutorials/index.html">Tutorials</a> |
| <li><a class="main-nav-link" href="https://github.com/apache/incubator-mxnet/tree/1.3.1/example">Examples</a></li> |
| <li><a class="main-nav-link" href="/versions/1.3.1/architecture/index.html">Architecture</a></li> |
| <li><a class="main-nav-link" href="https://cwiki.apache.org/confluence/display/MXNET/Apache+MXNet+Home">Developer Wiki</a></li> |
| <li><a class="main-nav-link" href="/versions/1.3.1/model_zoo/index.html">Model Zoo</a></li> |
| <li><a class="main-nav-link" href="https://github.com/onnx/onnx-mxnet">ONNX</a></li> |
| </li></ul> |
| </span> |
| <span id="dropdown-menu-position-anchor-community"> |
| <a aria-expanded="true" aria-haspopup="true" class="main-nav-link dropdown-toggle" data-toggle="dropdown" href="#" role="button">Community <span class="caret"></span></a> |
| <ul class="dropdown-menu navbar-menu" id="package-dropdown-menu-community"> |
| <li><a class="main-nav-link" href="http://discuss.mxnet.io">Forum</a></li> |
| <li><a class="main-nav-link" href="https://github.com/apache/incubator-mxnet/tree/1.3.1">Github</a></li> |
| <li><a class="main-nav-link" href="/versions/1.3.1/community/contribute.html">Contribute</a></li> |
| <li><a class="main-nav-link" href="/versions/1.3.1/community/ecosystem.html">Ecosystem</a></li> |
| <li><a class="main-nav-link" href="/versions/1.3.1/community/powered_by.html">Powered By</a></li> |
| </ul> |
| </span> |
| <span id="dropdown-menu-position-anchor-version" style="position: relative"><a href="#" class="main-nav-link dropdown-toggle" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="true">1.3.1<span class="caret"></span></a><ul id="package-dropdown-menu" class="dropdown-menu"><li><a href="/">master</a></li><li><a href="/versions/1.7.0/">1.7.0</a></li><li><a href=/versions/1.6.0/>1.6.0</a></li><li><a href=/versions/1.5.0/>1.5.0</a></li><li><a href=/versions/1.4.1/>1.4.1</a></li><li><a href=/versions/1.3.1/>1.3.1</a></li><li><a href=/versions/1.2.1/>1.2.1</a></li><li><a href=/versions/1.1.0/>1.1.0</a></li><li><a href=/versions/1.0.0/>1.0.0</a></li><li><a href=/versions/0.12.1/>0.12.1</a></li><li><a href=/versions/0.11.0/>0.11.0</a></li></ul></span></nav> |
| <script> function getRootPath(){ return "../../" } </script> |
| <div class="burgerIcon dropdown"> |
| <a class="dropdown-toggle" data-toggle="dropdown" href="#" role="button">☰</a> |
| <ul class="dropdown-menu" id="burgerMenu"> |
| <li><a href="/versions/1.3.1/install/index.html">Install</a></li> |
| <li><a class="main-nav-link" href="/versions/1.3.1/tutorials/index.html">Tutorials</a></li> |
| <li class="dropdown-submenu dropdown"> |
| <a aria-expanded="true" aria-haspopup="true" class="dropdown-toggle burger-link" data-toggle="dropdown" href="#" tabindex="-1">Gluon</a> |
| <ul class="dropdown-menu navbar-menu" id="package-dropdown-menu"> |
| <li><a class="main-nav-link" href="/versions/1.3.1/tutorials/gluon/gluon.html">About</a></li> |
| <li><a class="main-nav-link" href="http://gluon.mxnet.io">The Straight Dope (Tutorials)</a></li> |
| <li><a class="main-nav-link" href="https://gluon-cv.mxnet.io">GluonCV Toolkit</a></li> |
| <li><a class="main-nav-link" href="https://gluon-nlp.mxnet.io/">GluonNLP Toolkit</a></li> |
| </ul> |
| </li> |
| <li class="dropdown-submenu"> |
| <a aria-expanded="true" aria-haspopup="true" class="dropdown-toggle burger-link" data-toggle="dropdown" href="#" tabindex="-1">API</a> |
| <ul class="dropdown-menu"> |
| <li><a class="main-nav-link" href="/versions/1.3.1/api/python/index.html">Python</a></li> |
| <li><a class="main-nav-link" href="/versions/1.3.1/api/c++/index.html">C++</a></li> |
| <li><a class="main-nav-link" href="/versions/1.3.1/api/clojure/index.html">Clojure</a></li> |
| <li><a class="main-nav-link" href="/versions/1.3.1/api/julia/index.html">Julia</a></li> |
| <li><a class="main-nav-link" href="/versions/1.3.1/api/perl/index.html">Perl</a></li> |
| <li><a class="main-nav-link" href="/versions/1.3.1/api/r/index.html">R</a></li> |
| <li><a class="main-nav-link" href="/versions/1.3.1/api/scala/index.html">Scala</a></li> |
| </ul> |
| </li> |
| <li class="dropdown-submenu"> |
| <a aria-expanded="true" aria-haspopup="true" class="dropdown-toggle burger-link" data-toggle="dropdown" href="#" tabindex="-1">Docs</a> |
| <ul class="dropdown-menu"> |
| <li><a href="/versions/1.3.1/faq/index.html" tabindex="-1">FAQ</a></li> |
| <li><a href="/versions/1.3.1/tutorials/index.html" tabindex="-1">Tutorials</a></li> |
| <li><a href="https://github.com/apache/incubator-mxnet/tree/1.3.1/example" tabindex="-1">Examples</a></li> |
| <li><a href="/versions/1.3.1/architecture/index.html" tabindex="-1">Architecture</a></li> |
| <li><a href="https://cwiki.apache.org/confluence/display/MXNET/Apache+MXNet+Home" tabindex="-1">Developer Wiki</a></li> |
| <li><a href="/versions/1.3.1/model_zoo/index.html" tabindex="-1">Gluon Model Zoo</a></li> |
| <li><a href="https://github.com/onnx/onnx-mxnet" tabindex="-1">ONNX</a></li> |
| </ul> |
| </li> |
| <li class="dropdown-submenu dropdown"> |
| <a aria-haspopup="true" class="dropdown-toggle burger-link" data-toggle="dropdown" href="#" role="button" tabindex="-1">Community</a> |
| <ul class="dropdown-menu"> |
| <li><a href="http://discuss.mxnet.io" tabindex="-1">Forum</a></li> |
| <li><a href="https://github.com/apache/incubator-mxnet/tree/1.3.1" tabindex="-1">Github</a></li> |
| <li><a href="/versions/1.3.1/community/contribute.html" tabindex="-1">Contribute</a></li> |
| <li><a href="/versions/1.3.1/community/ecosystem.html" tabindex="-1">Ecosystem</a></li> |
| <li><a href="/versions/1.3.1/community/powered_by.html" tabindex="-1">Powered By</a></li> |
| </ul> |
| </li> |
| <li id="dropdown-menu-position-anchor-version-mobile" class="dropdown-submenu" style="position: relative"><a href="#" tabindex="-1">1.3.1</a><ul class="dropdown-menu"><li><a tabindex="-1" href=/>master</a></li><li><a tabindex="-1" href=/versions/1.6.0/>1.6.0</a></li><li><a tabindex="-1" href=/versions/1.5.0/>1.5.0</a></li><li><a tabindex="-1" href=/versions/1.4.1/>1.4.1</a></li><li><a tabindex="-1" href=/versions/1.3.1/>1.3.1</a></li><li><a tabindex="-1" href=/versions/1.2.1/>1.2.1</a></li><li><a tabindex="-1" href=/versions/1.1.0/>1.1.0</a></li><li><a tabindex="-1" href=/versions/1.0.0/>1.0.0</a></li><li><a tabindex="-1" href=/versions/0.12.1/>0.12.1</a></li><li><a tabindex="-1" href=/versions/0.11.0/>0.11.0</a></li></ul></li></ul> |
| </div> |
| <div class="plusIcon dropdown"> |
| <a class="dropdown-toggle" data-toggle="dropdown" href="#" role="button"><span aria-hidden="true" class="glyphicon glyphicon-plus"></span></a> |
| <ul class="dropdown-menu dropdown-menu-right" id="plusMenu"></ul> |
| </div> |
| <div id="search-input-wrap"> |
| <form action="../../search.html" autocomplete="off" class="" method="get" role="search"> |
| <div class="form-group inner-addon left-addon"> |
| <i class="glyphicon glyphicon-search"></i> |
| <input class="form-control" name="q" placeholder="Search" type="text"/> |
| </div> |
| <input name="check_keywords" type="hidden" value="yes"> |
| <input name="area" type="hidden" value="default"/> |
| </input></form> |
| <div id="search-preview"></div> |
| </div> |
| <div id="searchIcon"> |
| <span aria-hidden="true" class="glyphicon glyphicon-search"></span> |
| </div> |
| <!-- <div id="lang-select-wrap"> --> |
| <!-- <label id="lang-select-label"> --> |
| <!-- <\!-- <i class="fa fa-globe"></i> -\-> --> |
| <!-- <span></span> --> |
| <!-- </label> --> |
| <!-- <select id="lang-select"> --> |
| <!-- <option value="en">Eng</option> --> |
| <!-- <option value="zh">中文</option> --> |
| <!-- </select> --> |
| <!-- </div> --> |
| <!-- <a id="mobile-nav-toggle"> |
| <span class="mobile-nav-toggle-bar"></span> |
| <span class="mobile-nav-toggle-bar"></span> |
| <span class="mobile-nav-toggle-bar"></span> |
| </a> --> |
| </div> |
| </div> |
| </div> |
| <script type="text/javascript"> |
| $('body').css('background', 'white'); |
| </script> |
| <div class="container"> |
| <div class="row"> |
| <div aria-label="main navigation" class="sphinxsidebar leftsidebar" role="navigation"> |
| <div class="sphinxsidebarwrapper"> |
| <ul> |
| <li class="toctree-l1"><a class="reference internal" href="../../api/python/index.html">Python Documents</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../api/r/index.html">R Documents</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../api/julia/index.html">Julia Documents</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../api/c++/index.html">C++ Documents</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../api/scala/index.html">Scala Documents</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../api/perl/index.html">Perl Documents</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../faq/index.html">HowTo Documents</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../architecture/index.html">System Documents</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../tutorials/index.html">Tutorials</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../community/contribute.html">Community</a></li> |
| </ul> |
| </div> |
| </div> |
| <div class="content"> |
| <div class="page-tracker"></div> |
| <h1>Source code for mxnet.profiler</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=fixme, invalid-name, too-many-arguments, too-many-locals, too-many-lines</span> |
| <span class="c1"># pylint: disable=too-many-branches, too-many-statements</span> |
| <span class="sd">"""Profiler setting methods."""</span> |
| <span class="kn">from</span> <span class="nn">__future__</span> <span class="k">import</span> <span class="n">absolute_import</span> |
| <span class="kn">import</span> <span class="nn">ctypes</span> |
| <span class="kn">import</span> <span class="nn">warnings</span> |
| <span class="kn">from</span> <span class="nn">.base</span> <span class="k">import</span> <span class="n">_LIB</span><span class="p">,</span> <span class="n">check_call</span><span class="p">,</span> <span class="n">c_str</span><span class="p">,</span> <span class="n">ProfileHandle</span><span class="p">,</span> <span class="n">c_str_array</span><span class="p">,</span> <span class="n">py_str</span><span class="p">,</span> <span class="n">KVStoreHandle</span> |
| |
| <span class="n">profiler_kvstore_handle</span> <span class="o">=</span> <span class="n">KVStoreHandle</span><span class="p">()</span> |
| |
| <span class="k">def</span> <span class="nf">set_kvstore_handle</span><span class="p">(</span><span class="n">handle</span><span class="p">):</span> |
| <span class="k">global</span> <span class="n">profiler_kvstore_handle</span> |
| <span class="n">profiler_kvstore_handle</span> <span class="o">=</span> <span class="n">handle</span> |
| |
| <div class="viewcode-block" id="set_config"><a class="viewcode-back" href="../../api/python/profiler/profiler.html#mxnet.profiler.set_config">[docs]</a><span class="k">def</span> <span class="nf">set_config</span><span class="p">(</span><span class="o">**</span><span class="n">kwargs</span><span class="p">):</span> |
| <span class="sd">"""Set up the configure of profiler (only accepts keyword arguments).</span> |
| |
| <span class="sd"> Parameters</span> |
| <span class="sd"> ----------</span> |
| <span class="sd"> filename : string,</span> |
| <span class="sd"> output file for profile data</span> |
| <span class="sd"> profile_all : boolean,</span> |
| <span class="sd"> all profile types enabled</span> |
| <span class="sd"> profile_symbolic : boolean,</span> |
| <span class="sd"> whether to profile symbolic operators</span> |
| <span class="sd"> profile_imperative : boolean,</span> |
| <span class="sd"> whether to profile imperative operators</span> |
| <span class="sd"> profile_memory : boolean,</span> |
| <span class="sd"> whether to profile memory usage</span> |
| <span class="sd"> profile_api : boolean,</span> |
| <span class="sd"> whether to profile the C API</span> |
| <span class="sd"> contiguous_dump : boolean,</span> |
| <span class="sd"> whether to periodically dump profiling data to file</span> |
| <span class="sd"> dump_period : float,</span> |
| <span class="sd"> seconds between profile data dumps</span> |
| <span class="sd"> aggregate_stats : boolean,</span> |
| <span class="sd"> whether to maintain aggregate stats in memory for console</span> |
| <span class="sd"> dump. Has some negative performance impact.</span> |
| <span class="sd"> profile_process : string</span> |
| <span class="sd"> whether to profile kvstore `server` or `worker`.</span> |
| <span class="sd"> server can only be profiled when kvstore is of type dist.</span> |
| <span class="sd"> if this is not passed, defaults to `worker`</span> |
| <span class="sd"> """</span> |
| <span class="n">kk</span> <span class="o">=</span> <span class="n">kwargs</span><span class="o">.</span><span class="n">keys</span><span class="p">()</span> |
| <span class="n">vv</span> <span class="o">=</span> <span class="n">kwargs</span><span class="o">.</span><span class="n">values</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">MXSetProcessProfilerConfig</span><span class="p">(</span><span class="nb">len</span><span class="p">(</span><span class="n">kwargs</span><span class="p">),</span> |
| <span class="n">c_str_array</span><span class="p">([</span><span class="n">key</span> <span class="k">for</span> <span class="n">key</span> <span class="ow">in</span> <span class="n">kk</span><span class="p">]),</span> |
| <span class="n">c_str_array</span><span class="p">([</span><span class="nb">str</span><span class="p">(</span><span class="n">val</span><span class="p">)</span> <span class="k">for</span> <span class="n">val</span> <span class="ow">in</span> <span class="n">vv</span><span class="p">]),</span> |
| <span class="n">profiler_kvstore_handle</span><span class="p">))</span></div> |
| |
| |
| <div class="viewcode-block" id="profiler_set_config"><a class="viewcode-back" href="../../api/python/profiler/profiler.html#mxnet.profiler.profiler_set_config">[docs]</a><span class="k">def</span> <span class="nf">profiler_set_config</span><span class="p">(</span><span class="n">mode</span><span class="o">=</span><span class="s1">'symbolic'</span><span class="p">,</span> <span class="n">filename</span><span class="o">=</span><span class="s1">'profile.json'</span><span class="p">):</span> |
| <span class="sd">"""Set up the configure of profiler (Deprecated).</span> |
| |
| <span class="sd"> Parameters</span> |
| <span class="sd"> ----------</span> |
| <span class="sd"> mode : string, optional</span> |
| <span class="sd"> Indicates whether to enable the profiler, can</span> |
| <span class="sd"> be 'symbolic', or 'all'. Defaults to `symbolic`.</span> |
| <span class="sd"> filename : string, optional</span> |
| <span class="sd"> The name of output trace file. Defaults to 'profile.json'.</span> |
| <span class="sd"> """</span> |
| <span class="n">warnings</span><span class="o">.</span><span class="n">warn</span><span class="p">(</span><span class="s1">'profiler.profiler_set_config() is deprecated. '</span> |
| <span class="s1">'Please use profiler.set_config() instead'</span><span class="p">)</span> |
| <span class="n">keys</span> <span class="o">=</span> <span class="n">c_str_array</span><span class="p">([</span><span class="n">key</span> <span class="k">for</span> <span class="n">key</span> <span class="ow">in</span> <span class="p">[</span><span class="s2">"profile_"</span> <span class="o">+</span> <span class="n">mode</span><span class="p">,</span> <span class="s2">"filename"</span><span class="p">]])</span> |
| <span class="n">values</span> <span class="o">=</span> <span class="n">c_str_array</span><span class="p">([</span><span class="nb">str</span><span class="p">(</span><span class="n">val</span><span class="p">)</span> <span class="k">for</span> <span class="n">val</span> <span class="ow">in</span> <span class="p">[</span><span class="kc">True</span><span class="p">,</span> <span class="n">filename</span><span class="p">]])</span> |
| <span class="k">assert</span> <span class="nb">len</span><span class="p">(</span><span class="n">keys</span><span class="p">)</span> <span class="o">==</span> <span class="nb">len</span><span class="p">(</span><span class="n">values</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">MXSetProcessProfilerConfig</span><span class="p">(</span><span class="nb">len</span><span class="p">(</span><span class="n">keys</span><span class="p">),</span> <span class="n">keys</span><span class="p">,</span> <span class="n">values</span><span class="p">,</span> <span class="n">profiler_kvstore_handle</span><span class="p">))</span></div> |
| |
| |
| <div class="viewcode-block" id="set_state"><a class="viewcode-back" href="../../api/python/profiler/profiler.html#mxnet.profiler.set_state">[docs]</a><span class="k">def</span> <span class="nf">set_state</span><span class="p">(</span><span class="n">state</span><span class="o">=</span><span class="s1">'stop'</span><span class="p">,</span> <span class="n">profile_process</span><span class="o">=</span><span class="s1">'worker'</span><span class="p">):</span> |
| <span class="sd">"""Set up the profiler state to 'run' or 'stop'.</span> |
| |
| <span class="sd"> Parameters</span> |
| <span class="sd"> ----------</span> |
| <span class="sd"> state : string, optional</span> |
| <span class="sd"> Indicates whether to run the profiler, can</span> |
| <span class="sd"> be 'stop' or 'run'. Default is `stop`.</span> |
| <span class="sd"> profile_process : string</span> |
| <span class="sd"> whether to profile kvstore `server` or `worker`.</span> |
| <span class="sd"> server can only be profiled when kvstore is of type dist.</span> |
| <span class="sd"> if this is not passed, defaults to `worker`</span> |
| <span class="sd"> """</span> |
| <span class="n">state2int</span> <span class="o">=</span> <span class="p">{</span><span class="s1">'stop'</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span> <span class="s1">'run'</span><span class="p">:</span> <span class="mi">1</span><span class="p">}</span> |
| <span class="n">profile_process2int</span> <span class="o">=</span> <span class="p">{</span><span class="s1">'worker'</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span> <span class="s1">'server'</span><span class="p">:</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">MXSetProcessProfilerState</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">state2int</span><span class="p">[</span><span class="n">state</span><span class="p">]),</span> |
| <span class="n">profile_process2int</span><span class="p">[</span><span class="n">profile_process</span><span class="p">],</span> |
| <span class="n">profiler_kvstore_handle</span><span class="p">))</span></div> |
| |
| |
| <div class="viewcode-block" id="profiler_set_state"><a class="viewcode-back" href="../../api/python/profiler/profiler.html#mxnet.profiler.profiler_set_state">[docs]</a><span class="k">def</span> <span class="nf">profiler_set_state</span><span class="p">(</span><span class="n">state</span><span class="o">=</span><span class="s1">'stop'</span><span class="p">):</span> |
| <span class="sd">"""Set up the profiler state to 'run' or 'stop' (Deprecated).</span> |
| |
| <span class="sd"> Parameters</span> |
| <span class="sd"> ----------</span> |
| <span class="sd"> state : string, optional</span> |
| <span class="sd"> Indicates whether to run the profiler, can</span> |
| <span class="sd"> be 'stop' or 'run'. Default is `stop`.</span> |
| <span class="sd"> """</span> |
| <span class="n">warnings</span><span class="o">.</span><span class="n">warn</span><span class="p">(</span><span class="s1">'profiler.profiler_set_state() is deprecated. '</span> |
| <span class="s1">'Please use profiler.set_state() instead'</span><span class="p">)</span> |
| <span class="n">set_state</span><span class="p">(</span><span class="n">state</span><span class="p">)</span></div> |
| |
| <div class="viewcode-block" id="dump"><a class="viewcode-back" href="../../api/python/profiler/profiler.html#mxnet.profiler.dump">[docs]</a><span class="k">def</span> <span class="nf">dump</span><span class="p">(</span><span class="n">finished</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">profile_process</span><span class="o">=</span><span class="s1">'worker'</span><span class="p">):</span> |
| <span class="sd">"""Dump profile and stop profiler. Use this to save profile</span> |
| <span class="sd"> in advance in case your program cannot exit normally.</span> |
| |
| <span class="sd"> Parameters</span> |
| <span class="sd"> ----------</span> |
| <span class="sd"> finished : boolean</span> |
| <span class="sd"> Indicates whether to stop statistic output (dumping) after this dump.</span> |
| <span class="sd"> Default is True</span> |
| <span class="sd"> profile_process : string</span> |
| <span class="sd"> whether to profile kvstore `server` or `worker`.</span> |
| <span class="sd"> server can only be profiled when kvstore is of type dist.</span> |
| <span class="sd"> if this is not passed, defaults to `worker`</span> |
| <span class="sd"> """</span> |
| <span class="n">fin</span> <span class="o">=</span> <span class="mi">1</span> <span class="k">if</span> <span class="n">finished</span> <span class="ow">is</span> <span class="kc">True</span> <span class="k">else</span> <span class="mi">0</span> |
| <span class="n">profile_process2int</span> <span class="o">=</span> <span class="p">{</span><span class="s1">'worker'</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span> <span class="s1">'server'</span><span class="p">:</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">MXDumpProcessProfile</span><span class="p">(</span><span class="n">fin</span><span class="p">,</span> |
| <span class="n">profile_process2int</span><span class="p">[</span><span class="n">profile_process</span><span class="p">],</span> |
| <span class="n">profiler_kvstore_handle</span><span class="p">))</span></div> |
| |
| |
| <div class="viewcode-block" id="dump_profile"><a class="viewcode-back" href="../../api/python/profiler/profiler.html#mxnet.profiler.dump_profile">[docs]</a><span class="k">def</span> <span class="nf">dump_profile</span><span class="p">():</span> |
| <span class="sd">"""Dump profile and stop profiler. Use this to save profile</span> |
| <span class="sd"> in advance in case your program cannot exit normally."""</span> |
| <span class="n">warnings</span><span class="o">.</span><span class="n">warn</span><span class="p">(</span><span class="s1">'profiler.dump_profile() is deprecated. '</span> |
| <span class="s1">'Please use profiler.dump() instead'</span><span class="p">)</span> |
| <span class="n">dump</span><span class="p">(</span><span class="kc">True</span><span class="p">)</span></div> |
| |
| |
| <div class="viewcode-block" id="dumps"><a class="viewcode-back" href="../../api/python/profiler/profiler.html#mxnet.profiler.dumps">[docs]</a><span class="k">def</span> <span class="nf">dumps</span><span class="p">(</span><span class="n">reset</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span> |
| <span class="sd">"""Return a printable string of aggregate profile stats.</span> |
| |
| <span class="sd"> Parameters</span> |
| <span class="sd"> ----------</span> |
| <span class="sd"> reset: boolean</span> |
| <span class="sd"> Indicates whether to clean aggeregate statistical data collected up to this point</span> |
| <span class="sd"> """</span> |
| <span class="n">debug_str</span> <span class="o">=</span> <span class="n">ctypes</span><span class="o">.</span><span class="n">c_char_p</span><span class="p">()</span> |
| <span class="n">do_reset</span> <span class="o">=</span> <span class="mi">1</span> <span class="k">if</span> <span class="n">reset</span> <span class="ow">is</span> <span class="kc">True</span> <span class="k">else</span> <span class="mi">0</span> |
| <span class="n">check_call</span><span class="p">(</span><span class="n">_LIB</span><span class="o">.</span><span class="n">MXAggregateProfileStatsPrint</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">debug_str</span><span class="p">),</span> <span class="nb">int</span><span class="p">(</span><span class="n">do_reset</span><span class="p">)))</span> |
| <span class="k">return</span> <span class="n">py_str</span><span class="p">(</span><span class="n">debug_str</span><span class="o">.</span><span class="n">value</span><span class="p">)</span></div> |
| |
| |
| <div class="viewcode-block" id="pause"><a class="viewcode-back" href="../../api/python/profiler/profiler.html#mxnet.profiler.pause">[docs]</a><span class="k">def</span> <span class="nf">pause</span><span class="p">(</span><span class="n">profile_process</span><span class="o">=</span><span class="s1">'worker'</span><span class="p">):</span> |
| <span class="sd">"""Pause profiling.</span> |
| |
| <span class="sd"> Parameters</span> |
| <span class="sd"> ----------</span> |
| <span class="sd"> profile_process : string</span> |
| <span class="sd"> whether to profile kvstore `server` or `worker`.</span> |
| <span class="sd"> server can only be profiled when kvstore is of type dist.</span> |
| <span class="sd"> if this is not passed, defaults to `worker`</span> |
| <span class="sd"> """</span> |
| <span class="n">profile_process2int</span> <span class="o">=</span> <span class="p">{</span><span class="s1">'worker'</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span> <span class="s1">'server'</span><span class="p">:</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">MXProcessProfilePause</span><span class="p">(</span><span class="nb">int</span><span class="p">(</span><span class="mi">1</span><span class="p">),</span> |
| <span class="n">profile_process2int</span><span class="p">[</span><span class="n">profile_process</span><span class="p">],</span> |
| <span class="n">profiler_kvstore_handle</span><span class="p">))</span></div> |
| |
| |
| <div class="viewcode-block" id="resume"><a class="viewcode-back" href="../../api/python/profiler/profiler.html#mxnet.profiler.resume">[docs]</a><span class="k">def</span> <span class="nf">resume</span><span class="p">(</span><span class="n">profile_process</span><span class="o">=</span><span class="s1">'worker'</span><span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Resume paused profiling.</span> |
| |
| <span class="sd"> Parameters</span> |
| <span class="sd"> ----------</span> |
| <span class="sd"> profile_process : string</span> |
| <span class="sd"> whether to profile kvstore `server` or `worker`.</span> |
| <span class="sd"> server can only be profiled when kvstore is of type dist.</span> |
| <span class="sd"> if this is not passed, defaults to `worker`</span> |
| <span class="sd"> """</span> |
| <span class="n">profile_process2int</span> <span class="o">=</span> <span class="p">{</span><span class="s1">'worker'</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span> <span class="s1">'server'</span><span class="p">:</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">MXProcessProfilePause</span><span class="p">(</span><span class="nb">int</span><span class="p">(</span><span class="mi">0</span><span class="p">),</span> |
| <span class="n">profile_process2int</span><span class="p">[</span><span class="n">profile_process</span><span class="p">],</span> |
| <span class="n">profiler_kvstore_handle</span><span class="p">))</span></div> |
| |
| |
| <div class="viewcode-block" id="Domain"><a class="viewcode-back" href="../../api/python/profiler/profiler.html#mxnet.profiler.Domain">[docs]</a><span class="k">class</span> <span class="nc">Domain</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span> |
| <span class="sd">"""Profiling domain, used to group sub-objects like tasks, counters, etc into categories</span> |
| <span class="sd"> Serves as part of 'categories' for chrome://tracing</span> |
| |
| <span class="sd"> Note: Domain handles are never destroyed.</span> |
| |
| <span class="sd"> Parameters</span> |
| <span class="sd"> ----------</span> |
| <span class="sd"> name : string</span> |
| <span class="sd"> Name of the domain</span> |
| <span class="sd"> """</span> |
| <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">):</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">name</span> <span class="o">=</span> <span class="n">name</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">handle</span> <span class="o">=</span> <span class="n">ProfileHandle</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">MXProfileCreateDomain</span><span class="p">(</span><span class="n">c_str</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">name</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="bp">self</span><span class="o">.</span><span class="n">handle</span><span class="p">)))</span> |
| |
| <span class="k">def</span> <span class="nf">__str__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">name</span> |
| |
| <div class="viewcode-block" id="Domain.new_task"><a class="viewcode-back" href="../../api/python/profiler/profiler.html#mxnet.profiler.Domain.new_task">[docs]</a> <span class="k">def</span> <span class="nf">new_task</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">):</span> |
| <span class="sd">"""Create new Task object owned by this domain</span> |
| |
| <span class="sd"> Parameters</span> |
| <span class="sd"> ----------</span> |
| <span class="sd"> name : string</span> |
| <span class="sd"> Name of the task</span> |
| <span class="sd"> """</span> |
| <span class="k">return</span> <span class="n">Task</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">)</span></div> |
| |
| <div class="viewcode-block" id="Domain.new_frame"><a class="viewcode-back" href="../../api/python/profiler/profiler.html#mxnet.profiler.Domain.new_frame">[docs]</a> <span class="k">def</span> <span class="nf">new_frame</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">):</span> |
| <span class="sd">"""Create new Frame object owned by this domain</span> |
| |
| <span class="sd"> Parameters</span> |
| <span class="sd"> ----------</span> |
| <span class="sd"> name : string</span> |
| <span class="sd"> Name of the frame</span> |
| <span class="sd"> """</span> |
| <span class="k">return</span> <span class="n">Frame</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">)</span></div> |
| |
| <div class="viewcode-block" id="Domain.new_counter"><a class="viewcode-back" href="../../api/python/profiler/profiler.html#mxnet.profiler.Domain.new_counter">[docs]</a> <span class="k">def</span> <span class="nf">new_counter</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">value</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span> |
| <span class="sd">"""Create new Counter object owned by this domain</span> |
| |
| <span class="sd"> Parameters</span> |
| <span class="sd"> ----------</span> |
| <span class="sd"> name : string</span> |
| <span class="sd"> Name of the counter</span> |
| <span class="sd"> """</span> |
| <span class="k">return</span> <span class="n">Counter</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">value</span><span class="p">)</span></div> |
| |
| <div class="viewcode-block" id="Domain.new_marker"><a class="viewcode-back" href="../../api/python/profiler/profiler.html#mxnet.profiler.Domain.new_marker">[docs]</a> <span class="k">def</span> <span class="nf">new_marker</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">):</span> |
| <span class="sd">"""Create new Marker object owned by this domain</span> |
| |
| <span class="sd"> Parameters</span> |
| <span class="sd"> ----------</span> |
| <span class="sd"> name : string</span> |
| <span class="sd"> Name of the marker</span> |
| <span class="sd"> """</span> |
| <span class="k">return</span> <span class="n">Marker</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">)</span></div></div> |
| |
| <div class="viewcode-block" id="Task"><a class="viewcode-back" href="../../api/python/profiler/profiler.html#mxnet.profiler.Task">[docs]</a><span class="k">class</span> <span class="nc">Task</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span> |
| <span class="sd">"""Profiling Task class.</span> |
| |
| <span class="sd"> A task is a logical unit of work performed by a particular thread.</span> |
| <span class="sd"> Tasks can nest; thus, tasks typically correspond to functions, scopes, or a case block</span> |
| <span class="sd"> in a switch statement.</span> |
| <span class="sd"> You can use the Task API to assign tasks to threads.</span> |
| |
| <span class="sd"> This is different from Frame in that all profiling statistics for passes</span> |
| <span class="sd"> through the task's begin and endpoints are accumulated together into a single statistical</span> |
| <span class="sd"> analysys, rather than a separate analysis for each pass (as with a Frame)</span> |
| |
| <span class="sd"> Parameters</span> |
| <span class="sd"> ----------</span> |
| <span class="sd"> domain : Domain object</span> |
| <span class="sd"> Domain to which this object belongs</span> |
| <span class="sd"> name : string</span> |
| <span class="sd"> Name of the task</span> |
| <span class="sd"> """</span> |
| <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">domain</span><span class="p">,</span> <span class="n">name</span><span class="p">):</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">name</span> <span class="o">=</span> <span class="n">name</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">handle</span> <span class="o">=</span> <span class="n">ProfileHandle</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">MXProfileCreateTask</span><span class="p">(</span><span class="n">domain</span><span class="o">.</span><span class="n">handle</span><span class="p">,</span> |
| <span class="n">c_str</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">name</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="bp">self</span><span class="o">.</span><span class="n">handle</span><span class="p">)))</span> |
| |
| <span class="k">def</span> <span class="nf">__del__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">handle</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</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">MXProfileDestroyHandle</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">handle</span><span class="p">))</span> |
| |
| <div class="viewcode-block" id="Task.start"><a class="viewcode-back" href="../../api/python/profiler/profiler.html#mxnet.profiler.Task.start">[docs]</a> <span class="k">def</span> <span class="nf">start</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="sd">"""Start timing scope for this object"""</span> |
| <span class="n">check_call</span><span class="p">(</span><span class="n">_LIB</span><span class="o">.</span><span class="n">MXProfileDurationStart</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">handle</span><span class="p">))</span></div> |
| |
| <div class="viewcode-block" id="Task.stop"><a class="viewcode-back" href="../../api/python/profiler/profiler.html#mxnet.profiler.Task.stop">[docs]</a> <span class="k">def</span> <span class="nf">stop</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="sd">"""Stop timing scope for this object"""</span> |
| <span class="n">check_call</span><span class="p">(</span><span class="n">_LIB</span><span class="o">.</span><span class="n">MXProfileDurationStop</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">handle</span><span class="p">))</span></div> |
| |
| <span class="k">def</span> <span class="nf">__str__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">name</span></div> |
| |
| |
| <div class="viewcode-block" id="Frame"><a class="viewcode-back" href="../../api/python/profiler/profiler.html#mxnet.profiler.Frame">[docs]</a><span class="k">class</span> <span class="nc">Frame</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span> |
| <span class="sd">"""Profiling Frame class.</span> |
| |
| <span class="sd"> Use the frame API to insert calls to the desired places in your code and analyze</span> |
| <span class="sd"> performance per frame, where frame is the time period between frame begin and end points.</span> |
| <span class="sd"> When frames are displayed in Intel VTune Amplifier, they are displayed in a</span> |
| <span class="sd"> separate track, so they provide a way to visually separate this data from normal task data.</span> |
| |
| <span class="sd"> This is different from Task in that each 'Frame' duration will be a discretely-numbered</span> |
| <span class="sd"> event in the VTune output, as well as its rate (frame-rate) shown. This is analogous to</span> |
| <span class="sd"> profiling each frame of some visual output, such as rendering a video game frame.</span> |
| |
| <span class="sd"> Parameters</span> |
| <span class="sd"> ----------</span> |
| <span class="sd"> domain : Domain object</span> |
| <span class="sd"> Domain to which this object belongs</span> |
| <span class="sd"> name : string</span> |
| <span class="sd"> Name of the frame</span> |
| <span class="sd"> """</span> |
| <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">domain</span><span class="p">,</span> <span class="n">name</span><span class="p">):</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">name</span> <span class="o">=</span> <span class="n">name</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">handle</span> <span class="o">=</span> <span class="n">ProfileHandle</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">MXProfileCreateFrame</span><span class="p">(</span><span class="n">domain</span><span class="o">.</span><span class="n">handle</span><span class="p">,</span> |
| <span class="n">c_str</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">name</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="bp">self</span><span class="o">.</span><span class="n">handle</span><span class="p">)))</span> |
| |
| <span class="k">def</span> <span class="nf">__del__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">handle</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</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">MXProfileDestroyHandle</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">handle</span><span class="p">))</span> |
| |
| <div class="viewcode-block" id="Frame.start"><a class="viewcode-back" href="../../api/python/profiler/profiler.html#mxnet.profiler.Frame.start">[docs]</a> <span class="k">def</span> <span class="nf">start</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="sd">"""Start timing scope for this object"""</span> |
| <span class="n">check_call</span><span class="p">(</span><span class="n">_LIB</span><span class="o">.</span><span class="n">MXProfileDurationStart</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">handle</span><span class="p">))</span></div> |
| |
| <div class="viewcode-block" id="Frame.stop"><a class="viewcode-back" href="../../api/python/profiler/profiler.html#mxnet.profiler.Frame.stop">[docs]</a> <span class="k">def</span> <span class="nf">stop</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="sd">"""Stop timing scope for this object"""</span> |
| <span class="n">check_call</span><span class="p">(</span><span class="n">_LIB</span><span class="o">.</span><span class="n">MXProfileDurationStop</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">handle</span><span class="p">))</span></div> |
| |
| <span class="k">def</span> <span class="nf">__str__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">name</span></div> |
| |
| |
| <div class="viewcode-block" id="Event"><a class="viewcode-back" href="../../api/python/profiler/profiler.html#mxnet.profiler.Event">[docs]</a><span class="k">class</span> <span class="nc">Event</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span> |
| <span class="sd">"""Profiling Event class.</span> |
| |
| <span class="sd"> The event API is used to observe when demarcated events occur in your application, or to</span> |
| <span class="sd"> identify how long it takes to execute demarcated regions of code. Set annotations in the</span> |
| <span class="sd"> application to demarcate areas where events of interest occur.</span> |
| <span class="sd"> After running analysis, you can see the events marked in the Timeline pane.</span> |
| <span class="sd"> Event API is a per-thread function that works in resumed state.</span> |
| <span class="sd"> This function does not work in paused state.</span> |
| |
| <span class="sd"> Parameters</span> |
| <span class="sd"> ----------</span> |
| <span class="sd"> name : string</span> |
| <span class="sd"> Name of the event</span> |
| <span class="sd"> """</span> |
| <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">):</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">name</span> <span class="o">=</span> <span class="n">name</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">handle</span> <span class="o">=</span> <span class="n">ProfileHandle</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">MXProfileCreateEvent</span><span class="p">(</span><span class="n">c_str</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">name</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="bp">self</span><span class="o">.</span><span class="n">handle</span><span class="p">)))</span> |
| |
| <span class="k">def</span> <span class="nf">__del__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">handle</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</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">MXProfileDestroyHandle</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">handle</span><span class="p">))</span> |
| |
| <div class="viewcode-block" id="Event.start"><a class="viewcode-back" href="../../api/python/profiler/profiler.html#mxnet.profiler.Event.start">[docs]</a> <span class="k">def</span> <span class="nf">start</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="sd">"""Start timing scope for this object"""</span> |
| <span class="n">check_call</span><span class="p">(</span><span class="n">_LIB</span><span class="o">.</span><span class="n">MXProfileDurationStart</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">handle</span><span class="p">))</span></div> |
| |
| <div class="viewcode-block" id="Event.stop"><a class="viewcode-back" href="../../api/python/profiler/profiler.html#mxnet.profiler.Event.stop">[docs]</a> <span class="k">def</span> <span class="nf">stop</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="sd">"""Stop timing scope for this object"""</span> |
| <span class="n">check_call</span><span class="p">(</span><span class="n">_LIB</span><span class="o">.</span><span class="n">MXProfileDurationStop</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">handle</span><span class="p">))</span></div> |
| |
| <span class="k">def</span> <span class="nf">__str__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">name</span></div> |
| |
| |
| <div class="viewcode-block" id="Counter"><a class="viewcode-back" href="../../api/python/profiler/profiler.html#mxnet.profiler.Counter">[docs]</a><span class="k">class</span> <span class="nc">Counter</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span> |
| <span class="sd">"""Profiling Counter class.</span> |
| |
| <span class="sd"> The counter event can track a value as it changes over time.</span> |
| |
| <span class="sd"> Parameters</span> |
| <span class="sd"> ----------</span> |
| <span class="sd"> domain : Domain object</span> |
| <span class="sd"> Domain to which this object belongs</span> |
| <span class="sd"> name : string</span> |
| <span class="sd"> Name of the counter</span> |
| <span class="sd"> value: integer, optional</span> |
| <span class="sd"> Initial value of the counter</span> |
| <span class="sd"> """</span> |
| <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">domain</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">value</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">name</span> <span class="o">=</span> <span class="n">name</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">handle</span> <span class="o">=</span> <span class="n">ProfileHandle</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">MXProfileCreateCounter</span><span class="p">(</span><span class="n">domain</span><span class="o">.</span><span class="n">handle</span><span class="p">,</span> |
| <span class="n">c_str</span><span class="p">(</span><span class="n">name</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="bp">self</span><span class="o">.</span><span class="n">handle</span><span class="p">)))</span> |
| <span class="k">if</span> <span class="n">value</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">set_value</span><span class="p">(</span><span class="n">value</span><span class="p">)</span> |
| |
| <span class="k">def</span> <span class="nf">__del__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">handle</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</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">MXProfileDestroyHandle</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">handle</span><span class="p">))</span> |
| |
| |
| <div class="viewcode-block" id="Counter.set_value"><a class="viewcode-back" href="../../api/python/profiler/profiler.html#mxnet.profiler.Counter.set_value">[docs]</a> <span class="k">def</span> <span class="nf">set_value</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span> |
| <span class="sd">"""Set counter value.</span> |
| |
| <span class="sd"> Parameters</span> |
| <span class="sd"> ----------</span> |
| <span class="sd"> value : int</span> |
| <span class="sd"> Value for the counter</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">MXProfileSetCounter</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="nb">int</span><span class="p">(</span><span class="n">value</span><span class="p">)))</span></div> |
| |
| <div class="viewcode-block" id="Counter.increment"><a class="viewcode-back" href="../../api/python/profiler/profiler.html#mxnet.profiler.Counter.increment">[docs]</a> <span class="k">def</span> <span class="nf">increment</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">delta</span><span class="o">=</span><span class="mi">1</span><span class="p">):</span> |
| <span class="sd">"""Increment counter value.</span> |
| |
| <span class="sd"> Parameters</span> |
| <span class="sd"> ----------</span> |
| <span class="sd"> value_change : int</span> |
| <span class="sd"> Amount by which to add to the counter</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">MXProfileAdjustCounter</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="nb">int</span><span class="p">(</span><span class="n">delta</span><span class="p">)))</span></div> |
| |
| <div class="viewcode-block" id="Counter.decrement"><a class="viewcode-back" href="../../api/python/profiler/profiler.html#mxnet.profiler.Counter.decrement">[docs]</a> <span class="k">def</span> <span class="nf">decrement</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">delta</span><span class="o">=</span><span class="mi">1</span><span class="p">):</span> |
| <span class="sd">"""Decrement counter value.</span> |
| |
| <span class="sd"> Parameters</span> |
| <span class="sd"> ----------</span> |
| <span class="sd"> value_change : int</span> |
| <span class="sd"> Amount by which to subtract from the counter</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">MXProfileAdjustCounter</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="o">-</span><span class="nb">int</span><span class="p">(</span><span class="n">delta</span><span class="p">)))</span></div> |
| |
| <span class="k">def</span> <span class="nf">__iadd__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">delta</span><span class="p">):</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">increment</span><span class="p">(</span><span class="n">delta</span><span class="p">)</span> |
| <span class="k">return</span> <span class="bp">self</span> |
| |
| <span class="k">def</span> <span class="nf">__isub__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">delta</span><span class="p">):</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">decrement</span><span class="p">(</span><span class="n">delta</span><span class="p">)</span> |
| <span class="k">return</span> <span class="bp">self</span> |
| |
| <span class="k">def</span> <span class="nf">__str__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">name</span></div> |
| |
| |
| <div class="viewcode-block" id="Marker"><a class="viewcode-back" href="../../api/python/profiler/profiler.html#mxnet.profiler.Marker">[docs]</a><span class="k">class</span> <span class="nc">Marker</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span> |
| <span class="sd">"""Set marker for an instant in time.</span> |
| |
| <span class="sd"> The marker event marks a particular instant in time across some scope boundaries.</span> |
| |
| <span class="sd"> Parameters</span> |
| <span class="sd"> ----------</span> |
| <span class="sd"> domain : Domain object</span> |
| <span class="sd"> Domain to which this object belongs</span> |
| <span class="sd"> name : string</span> |
| <span class="sd"> Name of the marker</span> |
| <span class="sd"> """</span> |
| <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">domain</span><span class="p">,</span> <span class="n">name</span><span class="p">):</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">name</span> <span class="o">=</span> <span class="n">name</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">domain</span> <span class="o">=</span> <span class="n">domain</span> |
| |
| <div class="viewcode-block" id="Marker.mark"><a class="viewcode-back" href="../../api/python/profiler/profiler.html#mxnet.profiler.Marker.mark">[docs]</a> <span class="k">def</span> <span class="nf">mark</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">scope</span><span class="o">=</span><span class="s1">'process'</span><span class="p">):</span> |
| <span class="sd">"""Set up the profiler state to record operator.</span> |
| |
| <span class="sd"> Parameters</span> |
| <span class="sd"> ----------</span> |
| <span class="sd"> scope : string, optional</span> |
| <span class="sd"> Indicates what scope the marker should refer to.</span> |
| <span class="sd"> Can be 'global', 'process', thread', task', and 'marker'</span> |
| <span class="sd"> Default is `process`.</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">MXProfileSetMarker</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">domain</span><span class="o">.</span><span class="n">handle</span><span class="p">,</span> <span class="n">c_str</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">name</span><span class="p">),</span> <span class="n">c_str</span><span class="p">(</span><span class="n">scope</span><span class="p">)))</span></div></div> |
| </pre></div> |
| </div> |
| </div> |
| <div aria-label="main navigation" class="sphinxsidebar rightsidebar" role="navigation"> |
| <div class="sphinxsidebarwrapper"> |
| </div> |
| </div> |
| </div><div class="footer"> |
| <div class="section-disclaimer"> |
| <div class="container"> |
| <div> |
| <img height="60" src="https://raw.githubusercontent.com/dmlc/web-data/master/mxnet/image/apache_incubator_logo.png"/> |
| <p> |
| Apache MXNet is an effort undergoing incubation at The Apache Software Foundation (ASF), <strong>sponsored by the <i>Apache Incubator</i></strong>. 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> |
| </div> <!-- pagename != index --> |
| </div> |
| <script crossorigin="anonymous" integrity="sha384-0mSbJDEHialfmuBBQP6A4Qrprq5OVfW37PRR3j5ELqxss1yVqOtnepnHVP9aJ7xS" src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.6/js/bootstrap.min.js"></script> |
| <script src="../../_static/js/sidebar.js" type="text/javascript"></script> |
| <script src="../../_static/js/search.js" type="text/javascript"></script> |
| <script src="../../_static/js/navbar.js" type="text/javascript"></script> |
| <script src="../../_static/js/clipboard.min.js" type="text/javascript"></script> |
| <script src="../../_static/js/copycode.js" type="text/javascript"></script> |
| <script src="../../_static/js/page.js" type="text/javascript"></script> |
| <script src="../../_static/js/docversion.js" type="text/javascript"></script> |
| <script type="text/javascript"> |
| $('body').ready(function () { |
| $('body').css('visibility', 'visible'); |
| }); |
| </script> |
| </body> |
| </html> |
