Prise3D
/
Thesis-OptimizationModules


			
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289
							

<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
  <meta charset="utf-8">
  
  <meta name="viewport" content="width=device-width, initial-scale=1.0">
  
  <title>macop.callbacks.Callback &mdash; macop v1.0.3 documentation</title>
  

  <script type="text/javascript" src="../_static/js/modernizr.min.js"></script>
  
    
      <script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></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="../_static/language_data.js"></script>
    
    <script type="text/javascript" src="../_static/js/theme.js"></script>

    
  <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
  <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
    <link rel="index" title="Index" href="../genindex.html" />
    <link rel="search" title="Search" href="../search.html" />
    <link rel="next" title="macop.evaluators.EvaluatorExample" href="macop.evaluators.EvaluatorExample.html" />
    <link rel="prev" title="macop.callbacks.UCBCheckpoint" href="macop.callbacks.UCBCheckpoint.html" /> 
</head>

<body class="wy-body-for-nav">

   
  <div class="wy-grid-for-nav">
    
    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
      <div class="wy-side-scroll">
        <div class="wy-side-nav-search" >
          

            <a href="../index.html" class="icon icon-home"> macop
          

          </a>

          
              <div class="version">
                1.0.3
              </div>
            
          
<div role="search">
  <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
    <input type="text" name="q" placeholder="Search docs" />
    <input type="hidden" name="check_keywords" value="yes" />
    <input type="hidden" name="area" value="default" />
  </form>
</div>

          
        </div>

        <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
          
            
              <p class="caption"><span class="caption-text">Contents:</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../description.html">Description</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="../macop.html">Documentation</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="../macop.html#macop">macop</a></li>
<li class="toctree-l2"><a class="reference internal" href="../macop.html#macop-algorithms">macop.algorithms</a></li>
<li class="toctree-l2 current"><a class="reference internal" href="../macop.html#macop-callbacks">macop.callbacks</a><ul class="current">
<li class="toctree-l3"><a class="reference internal" href="macop.callbacks.BasicCheckpoint.html">macop.callbacks.BasicCheckpoint</a></li>
<li class="toctree-l3"><a class="reference internal" href="macop.callbacks.MultiCheckpoint.html">macop.callbacks.MultiCheckpoint</a></li>
<li class="toctree-l3"><a class="reference internal" href="macop.callbacks.ParetoCheckpoint.html">macop.callbacks.ParetoCheckpoint</a></li>
<li class="toctree-l3"><a class="reference internal" href="macop.callbacks.UCBCheckpoint.html">macop.callbacks.UCBCheckpoint</a></li>
<li class="toctree-l3 current"><a class="current reference internal" href="#">macop.callbacks.Callback</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../macop.html#macop-evaluators">macop.evaluators</a></li>
<li class="toctree-l2"><a class="reference internal" href="../macop.html#macop-operators">macop.operators</a></li>
<li class="toctree-l2"><a class="reference internal" href="../macop.html#macop-solution">macop.solution</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../examples.html">Some examples</a></li>
<li class="toctree-l1"><a class="reference internal" href="../contributing.html">Contributing</a></li>
</ul>

            
        </div>
      </div>
    </nav>

    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">

      
      <nav class="wy-nav-top" aria-label="top navigation">
        
          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
          <a href="../index.html">macop</a>
        
      </nav>


      <div class="wy-nav-content">
        
        <div class="rst-content">
        
          
<div role="navigation" aria-label="breadcrumbs navigation">

  <ul class="wy-breadcrumbs">
    
      <li><a href="../index.html">Docs</a> &raquo;</li>
        
          <li><a href="../macop.html">Documentation</a> &raquo;</li>
        
      <li>macop.callbacks.Callback</li>
    
    
      <li class="wy-breadcrumbs-aside">
        
            
              <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>
            
          
      </li>
    
  </ul>

  
  <hr/>
</div>
          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
           <div itemprop="articleBody">
            
  <div class="section" id="module-macop.callbacks.Callback">
<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>
<p>Abstract Checkpoint class</p>
<p class="rubric">Classes</p>
<table class="longtable docutils align-default">
<colgroup>
<col style="width: 10%" />
<col style="width: 90%" />
</colgroup>
<tbody>
<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>
<td><p>Callback abstract class in order to compute some instruction every evaluation</p></td>
</tr>
</tbody>
</table>
<dl class="class">
<dt id="macop.callbacks.Callback.Callback">
<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>
<dd><p>Callback abstract class in order to compute some instruction every evaluation</p>
<dl class="attribute">
<dt id="macop.callbacks.Callback.Callback.algo">
<code class="sig-name descname">algo</code><a class="headerlink" href="#macop.callbacks.Callback.Callback.algo" title="Permalink to this definition">¶</a></dt>
<dd><p>{Algorithm} – main algorithm instance reference</p>
</dd></dl>

<dl class="attribute">
<dt id="macop.callbacks.Callback.Callback.every">
<code class="sig-name descname">every</code><a class="headerlink" href="#macop.callbacks.Callback.Callback.every" title="Permalink to this definition">¶</a></dt>
<dd><p>{int} – checkpoint frequency used (based on number of evaluations)</p>
</dd></dl>

<dl class="attribute">
<dt id="macop.callbacks.Callback.Callback.filepath">
<code class="sig-name descname">filepath</code><a class="headerlink" href="#macop.callbacks.Callback.Callback.filepath" title="Permalink to this definition">¶</a></dt>
<dd><p>{str} – file path where checkpoints will be saved</p>
</dd></dl>

<dl class="method">
<dt id="macop.callbacks.Callback.Callback.load">
<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>
<dd><p>Load last backup line of solution and set algorithm state at this backup</p>
</dd></dl>

<dl class="method">
<dt id="macop.callbacks.Callback.Callback.run">
<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>
<dd><p>Check if necessary to do backup based on <cite>every</cite> variable</p>
</dd></dl>

<dl class="method">
<dt id="macop.callbacks.Callback.Callback.setAlgo">
<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>
<dd><p>Specify the main algorithm instance reference</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>algo</strong> – {Algorithm} – main algorithm instance reference</p>
</dd>
</dl>
</dd></dl>

</dd></dl>

</div>


           </div>
           
          </div>
          <footer>
  
    <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
      
        <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>
      
      
        <a href="macop.callbacks.UCBCheckpoint.html" class="btn btn-neutral float-left" title="macop.callbacks.UCBCheckpoint" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
      
    </div>
  

  <hr/>

  <div role="contentinfo">
    <p>
        &copy; Copyright 2020, Jérôme BUISINE

    </p>
  </div>
  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>. 

</footer>

        </div>
      </div>

    </section>

  </div>
  

  <script type="text/javascript">
      jQuery(function () {
          SphinxRtdTheme.Navigation.enable(true);
      });
  </script>

  
</body>
</html>