base.html 9.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247
  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.base &mdash; macop v1.0.5 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="stylesheet" href="../../../_static/css/custom.css" type="text/css" />
  18. <link rel="index" title="Index" href="../../../genindex.html" />
  19. <link rel="search" title="Search" href="../../../search.html" />
  20. </head>
  21. <body class="wy-body-for-nav">
  22. <div class="wy-grid-for-nav">
  23. <nav data-toggle="wy-nav-shift" class="wy-nav-side">
  24. <div class="wy-side-scroll">
  25. <div class="wy-side-nav-search" >
  26. <a href="../../../index.html" class="icon icon-home"> macop
  27. </a>
  28. <div class="version">
  29. 1.0.5
  30. </div>
  31. <div role="search">
  32. <form id="rtd-search-form" class="wy-form" action="../../../search.html" method="get">
  33. <input type="text" name="q" placeholder="Search docs" />
  34. <input type="hidden" name="check_keywords" value="yes" />
  35. <input type="hidden" name="area" value="default" />
  36. </form>
  37. </div>
  38. </div>
  39. <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
  40. <p class="caption"><span class="caption-text">Contents:</span></p>
  41. <ul>
  42. <li class="toctree-l1"><a class="reference internal" href="../../../description.html">Description</a></li>
  43. <li class="toctree-l1"><a class="reference internal" href="../../../api.html">API</a></li>
  44. <li class="toctree-l1"><a class="reference internal" href="../../../documentations/index.html">Documentation</a></li>
  45. <li class="toctree-l1"><a class="reference internal" href="../../../examples.html">Some examples</a></li>
  46. <li class="toctree-l1"><a class="reference internal" href="../../../contributing.html">Contributing</a></li>
  47. </ul>
  48. </div>
  49. </div>
  50. </nav>
  51. <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
  52. <nav class="wy-nav-top" aria-label="top navigation">
  53. <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
  54. <a href="../../../index.html">macop</a>
  55. </nav>
  56. <div class="wy-nav-content">
  57. <div class="rst-content">
  58. <div role="navigation" aria-label="breadcrumbs navigation">
  59. <ul class="wy-breadcrumbs">
  60. <li><a href="../../../index.html">Docs</a> &raquo;</li>
  61. <li><a href="../../index.html">Module code</a> &raquo;</li>
  62. <li>macop.callbacks.base</li>
  63. <li class="wy-breadcrumbs-aside">
  64. </li>
  65. </ul>
  66. <hr/>
  67. </div>
  68. <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
  69. <div itemprop="articleBody">
  70. <h1>Source code for macop.callbacks.base</h1><div class="highlight"><pre>
  71. <span></span><span class="sd">&quot;&quot;&quot;Abstract Checkpoint classes for callback process</span>
  72. <span class="sd">&quot;&quot;&quot;</span>
  73. <span class="c1"># main imports</span>
  74. <span class="kn">import</span> <span class="nn">os</span>
  75. <span class="kn">import</span> <span class="nn">logging</span>
  76. <span class="kn">from</span> <span class="nn">abc</span> <span class="kn">import</span> <span class="n">abstractmethod</span>
  77. <div class="viewcode-block" id="Callback"><a class="viewcode-back" href="../../../macop/macop.callbacks.base.html#macop.callbacks.base.Callback">[docs]</a><span class="k">class</span> <span class="nc">Callback</span><span class="p">():</span>
  78. <span class="sd">&quot;&quot;&quot;</span>
  79. <span class="sd"> Callback abstract class in order to compute some instruction every evaluation</span>
  80. <span class="sd"> Attributes:</span>
  81. <span class="sd"> algo: {Algorithm} -- main algorithm instance reference</span>
  82. <span class="sd"> every: {int} -- checkpoint frequency used (based on number of evaluations)</span>
  83. <span class="sd"> filepath: {str} -- file path where checkpoints will be saved</span>
  84. <span class="sd"> &quot;&quot;&quot;</span>
  85. <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">every</span><span class="p">,</span> <span class="n">filepath</span><span class="p">):</span>
  86. <span class="bp">self</span><span class="o">.</span><span class="n">_algo</span> <span class="o">=</span> <span class="kc">None</span>
  87. <span class="bp">self</span><span class="o">.</span><span class="n">_every</span> <span class="o">=</span> <span class="n">every</span>
  88. <span class="bp">self</span><span class="o">.</span><span class="n">_filepath</span> <span class="o">=</span> <span class="n">filepath</span>
  89. <span class="c1"># build path if not already exists</span>
  90. <span class="n">head</span><span class="p">,</span> <span class="n">_</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_filepath</span><span class="p">)</span>
  91. <span class="k">if</span> <span class="ow">not</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">exists</span><span class="p">(</span><span class="n">head</span><span class="p">):</span>
  92. <span class="n">os</span><span class="o">.</span><span class="n">makedirs</span><span class="p">(</span><span class="n">head</span><span class="p">)</span>
  93. <div class="viewcode-block" id="Callback.setAlgo"><a class="viewcode-back" href="../../../macop/macop.callbacks.base.html#macop.callbacks.base.Callback.setAlgo">[docs]</a> <span class="k">def</span> <span class="nf">setAlgo</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">algo</span><span class="p">):</span>
  94. <span class="sd">&quot;&quot;&quot;Specify the main algorithm instance reference</span>
  95. <span class="sd"> Args:</span>
  96. <span class="sd"> algo: {Algorithm} -- main algorithm instance reference</span>
  97. <span class="sd"> &quot;&quot;&quot;</span>
  98. <span class="bp">self</span><span class="o">.</span><span class="n">_algo</span> <span class="o">=</span> <span class="n">algo</span></div>
  99. <div class="viewcode-block" id="Callback.run"><a class="viewcode-back" href="../../../macop/macop.callbacks.base.html#macop.callbacks.base.Callback.run">[docs]</a> <span class="nd">@abstractmethod</span>
  100. <span class="k">def</span> <span class="nf">run</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
  101. <span class="sd">&quot;&quot;&quot;</span>
  102. <span class="sd"> Check if necessary to do backup based on `every` variable</span>
  103. <span class="sd"> &quot;&quot;&quot;</span>
  104. <span class="k">pass</span></div>
  105. <div class="viewcode-block" id="Callback.load"><a class="viewcode-back" href="../../../macop/macop.callbacks.base.html#macop.callbacks.base.Callback.load">[docs]</a> <span class="nd">@abstractmethod</span>
  106. <span class="k">def</span> <span class="nf">load</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
  107. <span class="sd">&quot;&quot;&quot;</span>
  108. <span class="sd"> Load last backup line of solution and set algorithm state at this backup</span>
  109. <span class="sd"> &quot;&quot;&quot;</span>
  110. <span class="k">pass</span></div></div>
  111. </pre></div>
  112. </div>
  113. </div>
  114. <footer>
  115. <hr/>
  116. <div role="contentinfo">
  117. <p>
  118. &copy; Copyright 2020, Jérôme BUISINE
  119. </p>
  120. </div>
  121. 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>.
  122. </footer>
  123. </div>
  124. </div>
  125. </section>
  126. </div>
  127. <script type="text/javascript">
  128. jQuery(function () {
  129. SphinxRtdTheme.Navigation.enable(true);
  130. });
  131. </script>
  132. </body>
  133. </html>