macop.operators.policies.UCBPolicy.html 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311
  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.operators.policies.UCBPolicy &mdash; macop v0.3.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="index" title="Index" href="../genindex.html" />
  18. <link rel="search" title="Search" href="../search.html" />
  19. <link rel="next" title="macop.operators.Operator" href="macop.operators.Operator.html" />
  20. <link rel="prev" title="macop.operators.policies.RandomPolicy" href="macop.operators.policies.RandomPolicy.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.3.5
  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"><a class="reference internal" href="../macop.html#macop-callbacks">macop.callbacks</a></li>
  48. <li class="toctree-l2"><a class="reference internal" href="../macop.html#macop-evaluators">macop.evaluators</a></li>
  49. <li class="toctree-l2 current"><a class="reference internal" href="../macop.html#macop-operators">macop.operators</a><ul class="current">
  50. <li class="toctree-l3"><a class="reference internal" href="macop.operators.crossovers.Crossover.html">macop.operators.crossovers.Crossover</a></li>
  51. <li class="toctree-l3"><a class="reference internal" href="macop.operators.crossovers.RandomSplitCrossover.html">macop.operators.crossovers.RandomSplitCrossover</a></li>
  52. <li class="toctree-l3"><a class="reference internal" href="macop.operators.crossovers.SimpleCrossover.html">macop.operators.crossovers.SimpleCrossover</a></li>
  53. <li class="toctree-l3"><a class="reference internal" href="macop.operators.mutators.Mutation.html">macop.operators.mutators.Mutation</a></li>
  54. <li class="toctree-l3"><a class="reference internal" href="macop.operators.mutators.SimpleBinaryMutation.html">macop.operators.mutators.SimpleBinaryMutation</a></li>
  55. <li class="toctree-l3"><a class="reference internal" href="macop.operators.mutators.SimpleMutation.html">macop.operators.mutators.SimpleMutation</a></li>
  56. <li class="toctree-l3"><a class="reference internal" href="macop.operators.policies.Policy.html">macop.operators.policies.Policy</a></li>
  57. <li class="toctree-l3"><a class="reference internal" href="macop.operators.policies.RandomPolicy.html">macop.operators.policies.RandomPolicy</a></li>
  58. <li class="toctree-l3 current"><a class="current reference internal" href="#">macop.operators.policies.UCBPolicy</a></li>
  59. <li class="toctree-l3"><a class="reference internal" href="macop.operators.Operator.html">macop.operators.Operator</a></li>
  60. </ul>
  61. </li>
  62. <li class="toctree-l2"><a class="reference internal" href="../macop.html#macop-solution">macop.solution</a></li>
  63. </ul>
  64. </li>
  65. <li class="toctree-l1"><a class="reference internal" href="../examples.html">Some examples</a></li>
  66. <li class="toctree-l1"><a class="reference internal" href="../contributing.html">Contributing</a></li>
  67. </ul>
  68. </div>
  69. </div>
  70. </nav>
  71. <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
  72. <nav class="wy-nav-top" aria-label="top navigation">
  73. <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
  74. <a href="../index.html">macop</a>
  75. </nav>
  76. <div class="wy-nav-content">
  77. <div class="rst-content">
  78. <div role="navigation" aria-label="breadcrumbs navigation">
  79. <ul class="wy-breadcrumbs">
  80. <li><a href="../index.html">Docs</a> &raquo;</li>
  81. <li><a href="../macop.html">Documentation</a> &raquo;</li>
  82. <li>macop.operators.policies.UCBPolicy</li>
  83. <li class="wy-breadcrumbs-aside">
  84. <a href="https://github.com/prise-3d/macop/blob/master/docs/source/macop/macop.operators.policies.UCBPolicy.rst" class="fa fa-github"> Edit on GitHub</a>
  85. </li>
  86. </ul>
  87. <hr/>
  88. </div>
  89. <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
  90. <div itemprop="articleBody">
  91. <div class="section" id="module-macop.operators.policies.UCBPolicy">
  92. <span id="macop-operators-policies-ucbpolicy"></span><h1>macop.operators.policies.UCBPolicy<a class="headerlink" href="#module-macop.operators.policies.UCBPolicy" title="Permalink to this headline">¶</a></h1>
  93. <p>Policy class implementation which is used for selecting operator using Upper Confidence Bound</p>
  94. <p class="rubric">Classes</p>
  95. <table class="longtable docutils align-default">
  96. <colgroup>
  97. <col style="width: 10%" />
  98. <col style="width: 90%" />
  99. </colgroup>
  100. <tbody>
  101. <tr class="row-odd"><td><p><a class="reference internal" href="#macop.operators.policies.UCBPolicy.UCBPolicy" title="macop.operators.policies.UCBPolicy.UCBPolicy"><code class="xref py py-obj docutils literal notranslate"><span class="pre">UCBPolicy</span></code></a>(_operators[, _C, _exp_rate])</p></td>
  102. <td><p>UCB policy class which is used for applying UCB strategy when selecting and applying operator</p></td>
  103. </tr>
  104. </tbody>
  105. </table>
  106. <dl class="class">
  107. <dt id="macop.operators.policies.UCBPolicy.UCBPolicy">
  108. <em class="property">class </em><code class="sig-prename descclassname">macop.operators.policies.UCBPolicy.</code><code class="sig-name descname">UCBPolicy</code><span class="sig-paren">(</span><em class="sig-param">_operators</em>, <em class="sig-param">_C=100.0</em>, <em class="sig-param">_exp_rate=0.5</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/macop/operators/policies/UCBPolicy.html#UCBPolicy"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#macop.operators.policies.UCBPolicy.UCBPolicy" title="Permalink to this definition">¶</a></dt>
  109. <dd><p>UCB policy class which is used for applying UCB strategy when selecting and applying operator</p>
  110. <dl class="attribute">
  111. <dt id="macop.operators.policies.UCBPolicy.UCBPolicy.operators">
  112. <code class="sig-name descname">operators</code><a class="headerlink" href="#macop.operators.policies.UCBPolicy.UCBPolicy.operators" title="Permalink to this definition">¶</a></dt>
  113. <dd><p>{[Operator]} – list of selected operators for the algorithm</p>
  114. </dd></dl>
  115. <dl class="attribute">
  116. <dt id="macop.operators.policies.UCBPolicy.UCBPolicy.C">
  117. <code class="sig-name descname">C</code><a class="headerlink" href="#macop.operators.policies.UCBPolicy.UCBPolicy.C" title="Permalink to this definition">¶</a></dt>
  118. <dd><p>{float} – tradeoff between EvE parameter for UCB</p>
  119. </dd></dl>
  120. <dl class="attribute">
  121. <dt id="macop.operators.policies.UCBPolicy.UCBPolicy.exp_rate">
  122. <code class="sig-name descname">exp_rate</code><a class="headerlink" href="#macop.operators.policies.UCBPolicy.UCBPolicy.exp_rate" title="Permalink to this definition">¶</a></dt>
  123. <dd><p>{float} – exploration rate (probability to choose randomly next operator)</p>
  124. </dd></dl>
  125. <dl class="attribute">
  126. <dt id="macop.operators.policies.UCBPolicy.UCBPolicy.rewards">
  127. <code class="sig-name descname">rewards</code><a class="headerlink" href="#macop.operators.policies.UCBPolicy.UCBPolicy.rewards" title="Permalink to this definition">¶</a></dt>
  128. <dd><p>{[float]} – list of summed rewards obtained for each operator</p>
  129. </dd></dl>
  130. <dl class="attribute">
  131. <dt id="macop.operators.policies.UCBPolicy.UCBPolicy.occurrences">
  132. <code class="sig-name descname">occurrences</code><a class="headerlink" href="#macop.operators.policies.UCBPolicy.UCBPolicy.occurrences" title="Permalink to this definition">¶</a></dt>
  133. <dd><p>{[int]} – number of use (selected) of each operator</p>
  134. </dd></dl>
  135. <dl class="method">
  136. <dt id="macop.operators.policies.UCBPolicy.UCBPolicy.apply">
  137. <code class="sig-name descname">apply</code><span class="sig-paren">(</span><em class="sig-param">_solution</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/macop/operators/policies/UCBPolicy.html#UCBPolicy.apply"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#macop.operators.policies.UCBPolicy.UCBPolicy.apply" title="Permalink to this definition">¶</a></dt>
  138. <dd><p>Apply specific operator chosen to create new solution, computes its fitness and returns solution</p>
  139. <dl class="field-list simple">
  140. <dt class="field-odd">Parameters</dt>
  141. <dd class="field-odd"><p><strong>_solution</strong> – {Solution} – the solution to use for generating new solution</p>
  142. </dd>
  143. <dt class="field-even">Returns</dt>
  144. <dd class="field-even"><p>{Solution} – new generated solution</p>
  145. </dd>
  146. </dl>
  147. </dd></dl>
  148. <dl class="method">
  149. <dt id="macop.operators.policies.UCBPolicy.UCBPolicy.select">
  150. <code class="sig-name descname">select</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/macop/operators/policies/UCBPolicy.html#UCBPolicy.select"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#macop.operators.policies.UCBPolicy.UCBPolicy.select" title="Permalink to this definition">¶</a></dt>
  151. <dd><p>Select randomly the next operator to use</p>
  152. <dl class="field-list simple">
  153. <dt class="field-odd">Returns</dt>
  154. <dd class="field-odd"><p>the selected operator</p>
  155. </dd>
  156. <dt class="field-even">Return type</dt>
  157. <dd class="field-even"><p>{Operator}</p>
  158. </dd>
  159. </dl>
  160. </dd></dl>
  161. </dd></dl>
  162. </div>
  163. </div>
  164. </div>
  165. <footer>
  166. <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
  167. <a href="macop.operators.Operator.html" class="btn btn-neutral float-right" title="macop.operators.Operator" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
  168. <a href="macop.operators.policies.RandomPolicy.html" class="btn btn-neutral float-left" title="macop.operators.policies.RandomPolicy" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
  169. </div>
  170. <hr/>
  171. <div role="contentinfo">
  172. <p>
  173. &copy; Copyright 2020, Jérôme BUISINE
  174. </p>
  175. </div>
  176. 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>.
  177. </footer>
  178. </div>
  179. </div>
  180. </section>
  181. </div>
  182. <script type="text/javascript">
  183. jQuery(function () {
  184. SphinxRtdTheme.Navigation.enable(true);
  185. });
  186. </script>
  187. </body>
  188. </html>