macop.callbacks.Callback.html 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287
  1. <!DOCTYPE html>
  2. <!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
  3. <!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
  4. <head>
  5. <meta charset="utf-8">
  6. <meta name="viewport" content="width=device-width, initial-scale=1.0">
  7. <title>macop.callbacks.Callback &mdash; macop v0.1.6 documentation</title>
  8. <script type="text/javascript" src="../_static/js/modernizr.min.js"></script>
  9. <script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
  10. <script type="text/javascript" src="../_static/jquery.js"></script>
  11. <script type="text/javascript" src="../_static/underscore.js"></script>
  12. <script type="text/javascript" src="../_static/doctools.js"></script>
  13. <script type="text/javascript" src="../_static/language_data.js"></script>
  14. <script type="text/javascript" src="../_static/js/theme.js"></script>
  15. <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
  16. <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
  17. <link rel="index" title="Index" href="../genindex.html" />
  18. <link rel="search" title="Search" href="../search.html" />
  19. <link rel="next" title="macop.evaluators.EvaluatorExample" href="macop.evaluators.EvaluatorExample.html" />
  20. <link rel="prev" title="macop.callbacks.MultiCheckpoint" href="macop.callbacks.MultiCheckpoint.html" />
  21. </head>
  22. <body class="wy-body-for-nav">
  23. <div class="wy-grid-for-nav">
  24. <nav data-toggle="wy-nav-shift" class="wy-nav-side">
  25. <div class="wy-side-scroll">
  26. <div class="wy-side-nav-search" >
  27. <a href="../index.html" class="icon icon-home"> macop
  28. </a>
  29. <div class="version">
  30. 0.1.6
  31. </div>
  32. <div role="search">
  33. <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
  34. <input type="text" name="q" placeholder="Search docs" />
  35. <input type="hidden" name="check_keywords" value="yes" />
  36. <input type="hidden" name="area" value="default" />
  37. </form>
  38. </div>
  39. </div>
  40. <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
  41. <p class="caption"><span class="caption-text">Contents:</span></p>
  42. <ul class="current">
  43. <li class="toctree-l1"><a class="reference internal" href="../description.html">Description</a></li>
  44. <li class="toctree-l1 current"><a class="reference internal" href="../macop.html">Documentation</a><ul class="current">
  45. <li class="toctree-l2"><a class="reference internal" href="../macop.html#macop">macop</a></li>
  46. <li class="toctree-l2"><a class="reference internal" href="../macop.html#macop-algorithms">macop.algorithms</a></li>
  47. <li class="toctree-l2 current"><a class="reference internal" href="../macop.html#macop-callbacks">macop.callbacks</a><ul class="current">
  48. <li class="toctree-l3"><a class="reference internal" href="macop.callbacks.BasicCheckpoint.html">macop.callbacks.BasicCheckpoint</a></li>
  49. <li class="toctree-l3"><a class="reference internal" href="macop.callbacks.MultiCheckpoint.html">macop.callbacks.MultiCheckpoint</a></li>
  50. <li class="toctree-l3 current"><a class="current reference internal" href="#">macop.callbacks.Callback</a></li>
  51. </ul>
  52. </li>
  53. <li class="toctree-l2"><a class="reference internal" href="../macop.html#macop-evaluators">macop.evaluators</a></li>
  54. <li class="toctree-l2"><a class="reference internal" href="../macop.html#macop-operators">macop.operators</a></li>
  55. <li class="toctree-l2"><a class="reference internal" href="../macop.html#macop-solution">macop.solution</a></li>
  56. </ul>
  57. </li>
  58. <li class="toctree-l1"><a class="reference internal" href="../examples.html">Some examples</a></li>
  59. <li class="toctree-l1"><a class="reference internal" href="../contributing.html">Contributing</a></li>
  60. </ul>
  61. </div>
  62. </div>
  63. </nav>
  64. <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
  65. <nav class="wy-nav-top" aria-label="top navigation">
  66. <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
  67. <a href="../index.html">macop</a>
  68. </nav>
  69. <div class="wy-nav-content">
  70. <div class="rst-content">
  71. <div role="navigation" aria-label="breadcrumbs navigation">
  72. <ul class="wy-breadcrumbs">
  73. <li><a href="../index.html">Docs</a> &raquo;</li>
  74. <li><a href="../macop.html">Documentation</a> &raquo;</li>
  75. <li>macop.callbacks.Callback</li>
  76. <li class="wy-breadcrumbs-aside">
  77. <a href="https://github.com/prise-3d/macop/blob/master/docs/source/macop/macop.callbacks.Callback.rst" class="fa fa-github"> Edit on GitHub</a>
  78. </li>
  79. </ul>
  80. <hr/>
  81. </div>
  82. <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
  83. <div itemprop="articleBody">
  84. <div class="section" id="module-macop.callbacks.Callback">
  85. <span id="macop-callbacks-callback"></span><h1>macop.callbacks.Callback<a class="headerlink" href="#module-macop.callbacks.Callback" title="Permalink to this headline">¶</a></h1>
  86. <p>Abstract Checkpoint class</p>
  87. <p class="rubric">Classes</p>
  88. <table class="longtable docutils align-default">
  89. <colgroup>
  90. <col style="width: 10%" />
  91. <col style="width: 90%" />
  92. </colgroup>
  93. <tbody>
  94. <tr class="row-odd"><td><p><a class="reference internal" href="#macop.callbacks.Callback.Callback" title="macop.callbacks.Callback.Callback"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Callback</span></code></a>(_every, _filepath)</p></td>
  95. <td><p>Callback abstract class in order to compute some instruction every evaluation</p></td>
  96. </tr>
  97. </tbody>
  98. </table>
  99. <dl class="class">
  100. <dt id="macop.callbacks.Callback.Callback">
  101. <em class="property">class </em><code class="sig-prename descclassname">macop.callbacks.Callback.</code><code class="sig-name descname">Callback</code><span class="sig-paren">(</span><em class="sig-param">_every</em>, <em class="sig-param">_filepath</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/macop/callbacks/Callback.html#Callback"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#macop.callbacks.Callback.Callback" title="Permalink to this definition">¶</a></dt>
  102. <dd><p>Callback abstract class in order to compute some instruction every evaluation</p>
  103. <dl class="attribute">
  104. <dt id="macop.callbacks.Callback.Callback.algo">
  105. <code class="sig-name descname">algo</code><a class="headerlink" href="#macop.callbacks.Callback.Callback.algo" title="Permalink to this definition">¶</a></dt>
  106. <dd><p>{Algorithm} – main algorithm instance reference</p>
  107. </dd></dl>
  108. <dl class="attribute">
  109. <dt id="macop.callbacks.Callback.Callback.every">
  110. <code class="sig-name descname">every</code><a class="headerlink" href="#macop.callbacks.Callback.Callback.every" title="Permalink to this definition">¶</a></dt>
  111. <dd><p>{int} – checkpoint frequency used (based on number of evaluations)</p>
  112. </dd></dl>
  113. <dl class="attribute">
  114. <dt id="macop.callbacks.Callback.Callback.filepath">
  115. <code class="sig-name descname">filepath</code><a class="headerlink" href="#macop.callbacks.Callback.Callback.filepath" title="Permalink to this definition">¶</a></dt>
  116. <dd><p>{str} – file path where checkpoints will be saved</p>
  117. </dd></dl>
  118. <dl class="method">
  119. <dt id="macop.callbacks.Callback.Callback.load">
  120. <em class="property">abstract </em><code class="sig-name descname">load</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/macop/callbacks/Callback.html#Callback.load"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#macop.callbacks.Callback.Callback.load" title="Permalink to this definition">¶</a></dt>
  121. <dd><p>Load last backup line of solution and set algorithm state at this backup</p>
  122. </dd></dl>
  123. <dl class="method">
  124. <dt id="macop.callbacks.Callback.Callback.run">
  125. <em class="property">abstract </em><code class="sig-name descname">run</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/macop/callbacks/Callback.html#Callback.run"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#macop.callbacks.Callback.Callback.run" title="Permalink to this definition">¶</a></dt>
  126. <dd><p>Check if necessary to do backup based on <cite>every</cite> variable</p>
  127. </dd></dl>
  128. <dl class="method">
  129. <dt id="macop.callbacks.Callback.Callback.setAlgo">
  130. <code class="sig-name descname">setAlgo</code><span class="sig-paren">(</span><em class="sig-param">_algo</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/macop/callbacks/Callback.html#Callback.setAlgo"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#macop.callbacks.Callback.Callback.setAlgo" title="Permalink to this definition">¶</a></dt>
  131. <dd><p>Specify the main algorithm instance reference</p>
  132. <dl class="field-list simple">
  133. <dt class="field-odd">Parameters</dt>
  134. <dd class="field-odd"><p><strong>_algo</strong> – {Algorithm} – main algorithm instance reference</p>
  135. </dd>
  136. </dl>
  137. </dd></dl>
  138. </dd></dl>
  139. </div>
  140. </div>
  141. </div>
  142. <footer>
  143. <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
  144. <a href="macop.evaluators.EvaluatorExample.html" class="btn btn-neutral float-right" title="macop.evaluators.EvaluatorExample" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
  145. <a href="macop.callbacks.MultiCheckpoint.html" class="btn btn-neutral float-left" title="macop.callbacks.MultiCheckpoint" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
  146. </div>
  147. <hr/>
  148. <div role="contentinfo">
  149. <p>
  150. &copy; Copyright 2020, Jérôme BUISINE
  151. </p>
  152. </div>
  153. Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
  154. </footer>
  155. </div>
  156. </div>
  157. </section>
  158. </div>
  159. <script type="text/javascript">
  160. jQuery(function () {
  161. SphinxRtdTheme.Navigation.enable(true);
  162. });
  163. </script>
  164. </body>
  165. </html>