versions/0.11.0/api/python/callback.html

<!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="Callback API" 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="Callback API" property="og:description"/> <title>Callback API — 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/0.11.0/searchindex.js"); Search.init();}); </script>          <link href="../../genindex.html" rel="index" title="Index"> <link href="../../search.html" rel="search" title="Search"/> <link href="index.html" rel="up" title="MXNet - Python API"/> <link href="metric.html" rel="next" title="Evaluation Metric API"/> <link href="optimization.html" rel="prev" title="Optimization: initialize and update weights"/> <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/0.11.0/get_started/install.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/0.11.0/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/0.11.0/api/python/index.html">Python</a></li> <li><a class="main-nav-link" href="/versions/0.11.0/api/c++/index.html">C++</a></li> <li><a class="main-nav-link" href="/versions/0.11.0/api/julia/index.html">Julia</a></li> <li><a class="main-nav-link" href="/versions/0.11.0/api/perl/index.html">Perl</a></li> <li><a class="main-nav-link" href="/versions/0.11.0/api/r/index.html">R</a></li> <li><a class="main-nav-link" href="/versions/0.11.0/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/0.11.0/how_to/faq.html">FAQ</a></li> <li><a class="main-nav-link" href="/versions/0.11.0/tutorials/index.html">Tutorials</a> <li><a class="main-nav-link" href="https://github.com/apache/incubator-mxnet/tree/v0.11.0/example">Examples</a></li> <li><a class="main-nav-link" href="/versions/0.11.0/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/0.11.0/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/v0.11.0">Github</a></li> <li><a class="main-nav-link" href="/versions/0.11.0/community/contribute.html">Contribute</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">0.11.0<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/0.11.0/get_started/install.html">Install</a></li> <li><a class="main-nav-link" href="/versions/0.11.0/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/0.11.0/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/0.11.0/api/python/index.html">Python</a></li> <li><a class="main-nav-link" href="/versions/0.11.0/api/c++/index.html">C++</a></li> <li><a class="main-nav-link" href="/versions/0.11.0/api/julia/index.html">Julia</a></li> <li><a class="main-nav-link" href="/versions/0.11.0/api/perl/index.html">Perl</a></li> <li><a class="main-nav-link" href="/versions/0.11.0/api/r/index.html">R</a></li> <li><a class="main-nav-link" href="/versions/0.11.0/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/0.11.0/how_to/faq.html" tabindex="-1">FAQ</a></li> <li><a href="/versions/0.11.0/tutorials/index.html" tabindex="-1">Tutorials</a></li> <li><a href="https://github.com/apache/incubator-mxnet/tree/v0.11.0/example" tabindex="-1">Examples</a></li> <li><a href="/versions/0.11.0/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/0.11.0/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/v0.11.0" tabindex="-1">Github</a></li> <li><a href="/versions/0.11.0/community/contribute.html" tabindex="-1">Contribute</a></li> </ul> </li> <li id="dropdown-menu-position-anchor-version-mobile" class="dropdown-submenu" style="position: relative"><a href="#" tabindex="-1">0.11.0</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> </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 class="current"> <li class="toctree-l1 current"><a class="reference internal" href="index.html">Python Documents</a><ul class="current"> <li class="toctree-l2 current"><a class="reference internal" href="index.html#table-of-contents">Table of contents</a><ul class="current"> <li class="toctree-l3"><a class="reference internal" href="ndarray.html">NDArray API</a></li> <li class="toctree-l3"><a class="reference internal" href="symbol.html">Symbol API</a></li> <li class="toctree-l3"><a class="reference internal" href="module.html">Module API</a></li> <li class="toctree-l3"><a class="reference internal" href="autograd.html">Autograd Package</a></li> <li class="toctree-l3"><a class="reference internal" href="gluon.html">Gluon Package</a></li> <li class="toctree-l3"><a class="reference internal" href="rnn.html">RNN Cell API</a></li> <li class="toctree-l3"><a class="reference internal" href="kvstore.html">KVStore API</a></li> <li class="toctree-l3"><a class="reference internal" href="io.html">Data Loading API</a></li> <li class="toctree-l3"><a class="reference internal" href="image.html">Image API</a></li> <li class="toctree-l3"><a class="reference internal" href="optimization.html">Optimization: initialize and update weights</a></li> <li class="toctree-l3 current"><a class="current reference internal" href="#">Callback API</a><ul> <li class="toctree-l4"><a class="reference internal" href="#overview">Overview</a></li> <li class="toctree-l4"><a class="reference internal" href="#api-reference">API Reference</a></li> </ul> </li> <li class="toctree-l3"><a class="reference internal" href="metric.html">Evaluation Metric API</a></li> </ul> </li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="../r/index.html">R Documents</a></li> <li class="toctree-l1"><a class="reference internal" href="../julia/index.html">Julia Documents</a></li> <li class="toctree-l1"><a class="reference internal" href="../c++/index.html">C++ Documents</a></li> <li class="toctree-l1"><a class="reference internal" href="../scala/index.html">Scala Documents</a></li> <li class="toctree-l1"><a class="reference internal" href="../perl/index.html">Perl Documents</a></li> <li class="toctree-l1"><a class="reference internal" href="../../how_to/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> </ul> </div> </div> <div class="content"> <div class="page-tracker"></div> <div class="section" id="callback-api"> <span id="callback-api"></span><h1>Callback API<a class="headerlink" href="#callback-api" title="Permalink to this headline">¶</a></h1> <div class="section" id="overview"> <span id="overview"></span><h2>Overview<a class="headerlink" href="#overview" title="Permalink to this headline">¶</a></h2> <p>This document lists the routines of the callback package</p> <table border="1" class="longtable docutils"> <colgroup> <col width="10%"/> <col width="90%"/> </colgroup> <tbody valign="top"> <tr class="row-odd"><td><a class="reference internal" href="#module-mxnet.callback" title="mxnet.callback"><code class="xref py py-obj docutils literal"><span class="pre">mxnet.callback</span></code></a></td> <td>Callback functions that can be used to track various status during epoch.</td> </tr> </tbody> </table> </div> <div class="section" id="api-reference"> <span id="api-reference"></span><h2>API Reference<a class="headerlink" href="#api-reference" title="Permalink to this headline">¶</a></h2> <script src="../../_static/js/auto_module_index.js" type="text/javascript"></script><span class="target" id="module-mxnet.callback"></span><p>Callback functions that can be used to track various status during epoch.</p> <dl class="function"> <dt id="mxnet.callback.module_checkpoint"> <code class="descclassname">mxnet.callback.</code><code class="descname">module_checkpoint</code><span class="sig-paren">(</span><em>mod</em>, <em>prefix</em>, <em>period=1</em>, <em>save_optimizer_states=False</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/mxnet/callback.html#module_checkpoint"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#mxnet.callback.module_checkpoint" title="Permalink to this definition">¶</a></dt> <dd><p>Callback to checkpoint Module to prefix every epoch.</p> <table class="docutils field-list" frame="void" rules="none"> <col class="field-name"/> <col class="field-body"/> <tbody valign="top"> <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> <li><strong>mod</strong> (<em>subclass of BaseModule</em>) – The module to checkpoint.</li> <li><strong>prefix</strong> (<em>str</em>) – The file prefix for this checkpoint.</li> <li><strong>period</strong> (<em>int</em>) – How many epochs to wait before checkpointing. Defaults to 1.</li> <li><strong>save_optimizer_states</strong> (<em>bool</em>) – Indicates whether or not to save optimizer states for continued training.</li> </ul> </td> </tr> <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first"><strong>callback</strong> – The callback function that can be passed as iter_end_callback to fit.</p> </td> </tr> <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">function</p> </td> </tr> </tbody> </table> </dd></dl> <dl class="function"> <dt id="mxnet.callback.do_checkpoint"> <code class="descclassname">mxnet.callback.</code><code class="descname">do_checkpoint</code><span class="sig-paren">(</span><em>prefix</em>, <em>period=1</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/mxnet/callback.html#do_checkpoint"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#mxnet.callback.do_checkpoint" title="Permalink to this definition">¶</a></dt> <dd><p>A callback that saves a model checkpoint every few epochs. Each checkpoint is made up of a couple of binary files: a model description file and a parameters (weights and biases) file. The model description file is named <cite>prefix</cite>–symbol.json and the parameters file is named <cite>prefix</cite>-<cite>epoch_number</cite>.params</p> <table class="docutils field-list" frame="void" rules="none"> <col class="field-name"/> <col class="field-body"/> <tbody valign="top"> <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> <li><strong>prefix</strong> (<em>str</em>) – Prefix for the checkpoint filenames.</li> <li><strong>period</strong> (<em>int</em><em>, </em><em>optional</em>) – Interval (number of epochs) between checkpoints. Default <cite>period</cite> is 1.</li> </ul> </td> </tr> <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first"><strong>callback</strong> – A callback function that can be passed as <cite>epoch_end_callback</cite> to fit.</p> </td> </tr> <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">function</p> </td> </tr> </tbody> </table> <p class="rubric">Example</p> <div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">module</span><span class="o">.</span><span class="n">fit</span><span class="p">(</span><span class="n">iterator</span><span class="p">,</span> <span class="n">num_epoch</span><span class="o">=</span><span class="n">n_epoch</span><span class="p">,</span> <span class="gp">... </span><span class="n">epoch_end_callback</span> <span class="o">=</span> <span class="n">mx</span><span class="o">.</span><span class="n">callback</span><span class="o">.</span><span class="n">do_checkpoint</span><span class="p">(</span><span class="s2">"mymodel"</span><span class="p">,</span> <span class="mi">1</span><span class="p">))</span> <span class="go">Start training with [cpu(0)]</span> <span class="go">Epoch[0] Resetting Data Iterator</span> <span class="go">Epoch[0] Time cost=0.100</span> <span class="go">Saved checkpoint to "mymodel-0001.params"</span> <span class="go">Epoch[1] Resetting Data Iterator</span> <span class="go">Epoch[1] Time cost=0.060</span> <span class="go">Saved checkpoint to "mymodel-0002.params"</span> </pre></div> </div> </dd></dl> <dl class="function"> <dt id="mxnet.callback.log_train_metric"> <code class="descclassname">mxnet.callback.</code><code class="descname">log_train_metric</code><span class="sig-paren">(</span><em>period</em>, <em>auto_reset=False</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/mxnet/callback.html#log_train_metric"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#mxnet.callback.log_train_metric" title="Permalink to this definition">¶</a></dt> <dd><p>Callback to log the training evaluation result every period.</p> <table class="docutils field-list" frame="void" rules="none"> <col class="field-name"/> <col class="field-body"/> <tbody valign="top"> <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> <li><strong>period</strong> (<em>int</em>) – The number of batch to log the training evaluation metric.</li> <li><strong>auto_reset</strong> (<em>bool</em>) – Reset the metric after each log.</li> </ul> </td> </tr> <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first"><strong>callback</strong> – The callback function that can be passed as iter_epoch_callback to fit.</p> </td> </tr> <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">function</p> </td> </tr> </tbody> </table> </dd></dl> <dl class="class"> <dt id="mxnet.callback.Speedometer"> <em class="property">class </em><code class="descclassname">mxnet.callback.</code><code class="descname">Speedometer</code><span class="sig-paren">(</span><em>batch_size</em>, <em>frequent=50</em>, <em>auto_reset=True</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/mxnet/callback.html#Speedometer"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#mxnet.callback.Speedometer" title="Permalink to this definition">¶</a></dt> <dd><p>Logs training speed and evaluation metrics periodically.</p> <table class="docutils field-list" frame="void" rules="none"> <col class="field-name"/> <col class="field-body"/> <tbody valign="top"> <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> <li><strong>batch_size</strong> (<em>int</em>) – Batch size of data.</li> <li><strong>frequent</strong> (<em>int</em>) – Specifies how frequently training speed and evaluation metrics must be logged. Default behavior is to log once every 50 batches.</li> <li><strong>auto_reset</strong> (<em>bool</em>) – Reset the evaluation metrics after each log.</li> </ul> </td> </tr> </tbody> </table> <p class="rubric">Example</p> <div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="c1"># Print training speed and evaluation metrics every ten batches. Batch size is one.</span> <span class="gp">>>> </span><span class="n">module</span><span class="o">.</span><span class="n">fit</span><span class="p">(</span><span class="n">iterator</span><span class="p">,</span> <span class="n">num_epoch</span><span class="o">=</span><span class="n">n_epoch</span><span class="p">,</span> <span class="gp">... </span><span class="n">batch_end_callback</span><span class="o">=</span><span class="n">mx</span><span class="o">.</span><span class="n">callback</span><span class="o">.</span><span class="n">Speedometer</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span> <span class="mi">10</span><span class="p">))</span> <span class="go">Epoch[0] Batch [10] Speed: 1910.41 samples/sec Train-accuracy=0.200000</span> <span class="go">Epoch[0] Batch [20] Speed: 1764.83 samples/sec Train-accuracy=0.400000</span> <span class="go">Epoch[0] Batch [30] Speed: 1740.59 samples/sec Train-accuracy=0.500000</span> </pre></div> </div> </dd></dl> <dl class="class"> <dt id="mxnet.callback.ProgressBar"> <em class="property">class </em><code class="descclassname">mxnet.callback.</code><code class="descname">ProgressBar</code><span class="sig-paren">(</span><em>total</em>, <em>length=80</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/mxnet/callback.html#ProgressBar"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#mxnet.callback.ProgressBar" title="Permalink to this definition">¶</a></dt> <dd><p>Displays a progress bar, indicating the percentage of batches processed within each epoch.</p> <table class="docutils field-list" frame="void" rules="none"> <col class="field-name"/> <col class="field-body"/> <tbody valign="top"> <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> <li><strong>total</strong> (<em>int</em>) – total number of batches per epoch</li> <li><strong>length</strong> (<em>int</em>) – number of chars to define maximum length of progress bar</li> </ul> </td> </tr> </tbody> </table> <p class="rubric">Examples</p> <div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">progress_bar</span> <span class="o">=</span> <span class="n">mx</span><span class="o">.</span><span class="n">callback</span><span class="o">.</span><span class="n">ProgressBar</span><span class="p">(</span><span class="n">total</span><span class="o">=</span><span class="mi">2</span><span class="p">)</span> <span class="gp">>>> </span><span class="n">mod</span><span class="o">.</span><span class="n">fit</span><span class="p">(</span><span class="n">data</span><span class="p">,</span> <span class="n">num_epoch</span><span class="o">=</span><span class="mi">5</span><span class="p">,</span> <span class="n">batch_end_callback</span><span class="o">=</span><span class="n">progress_bar</span><span class="p">)</span> <span class="go">[========--------] 50.0%</span> <span class="go">[================] 100.0%</span> </pre></div> </div> </dd></dl> <dl class="class"> <dt id="mxnet.callback.LogValidationMetricsCallback"> <em class="property">class </em><code class="descclassname">mxnet.callback.</code><code class="descname">LogValidationMetricsCallback</code><a class="reference internal" href="../../_modules/mxnet/callback.html#LogValidationMetricsCallback"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#mxnet.callback.LogValidationMetricsCallback" title="Permalink to this definition">¶</a></dt> <dd><p>Just logs the eval metrics at the end of an epoch.</p> </dd></dl> <script>auto_index("api-reference");</script></div> </div> </div> </div> <div aria-label="main navigation" class="sphinxsidebar rightsidebar" role="navigation"> <div class="sphinxsidebarwrapper"> <h3><a href="../../index.html">Table Of Contents</a></h3> <ul> <li><a class="reference internal" href="#">Callback API</a><ul> <li><a class="reference internal" href="#overview">Overview</a></li> <li><a class="reference internal" href="#api-reference">API Reference</a></li> </ul> </li> </ul> </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>  </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>

versions/0.11.0/api/python/callback.html (413 lines of code) (raw):