macop.algorithms.multi.html 38 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533
  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.algorithms.multi &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. <link rel="next" title="macop.callbacks.base" href="macop.callbacks.base.html" />
  21. <link rel="prev" title="macop.algorithms.mono" href="macop.algorithms.mono.html" />
  22. </head>
  23. <body class="wy-body-for-nav">
  24. <div class="wy-grid-for-nav">
  25. <nav data-toggle="wy-nav-shift" class="wy-nav-side">
  26. <div class="wy-side-scroll">
  27. <div class="wy-side-nav-search" >
  28. <a href="../index.html" class="icon icon-home"> macop
  29. </a>
  30. <div class="version">
  31. 1.0.5
  32. </div>
  33. <div role="search">
  34. <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
  35. <input type="text" name="q" placeholder="Search docs" />
  36. <input type="hidden" name="check_keywords" value="yes" />
  37. <input type="hidden" name="area" value="default" />
  38. </form>
  39. </div>
  40. </div>
  41. <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
  42. <p class="caption"><span class="caption-text">Contents:</span></p>
  43. <ul class="current">
  44. <li class="toctree-l1"><a class="reference internal" href="../description.html">Description</a></li>
  45. <li class="toctree-l1 current"><a class="reference internal" href="../api.html">API</a><ul class="current">
  46. <li class="toctree-l2"><a class="reference internal" href="../api.html#macop">macop</a></li>
  47. <li class="toctree-l2 current"><a class="reference internal" href="../api.html#macop-algorithms">macop.algorithms</a><ul class="current">
  48. <li class="toctree-l3"><a class="reference internal" href="macop.algorithms.base.html">macop.algorithms.base</a></li>
  49. <li class="toctree-l3"><a class="reference internal" href="macop.algorithms.mono.html">macop.algorithms.mono</a></li>
  50. <li class="toctree-l3 current"><a class="current reference internal" href="#">macop.algorithms.multi</a></li>
  51. </ul>
  52. </li>
  53. <li class="toctree-l2"><a class="reference internal" href="../api.html#macop-callbacks">macop.callbacks</a></li>
  54. <li class="toctree-l2"><a class="reference internal" href="../api.html#macop-evaluators">macop.evaluators</a></li>
  55. <li class="toctree-l2"><a class="reference internal" href="../api.html#macop-operators">macop.operators</a></li>
  56. <li class="toctree-l2"><a class="reference internal" href="../api.html#macop-policies">macop.policies</a></li>
  57. <li class="toctree-l2"><a class="reference internal" href="../api.html#macop-solution">macop.solution</a></li>
  58. <li class="toctree-l2"><a class="reference internal" href="../api.html#macop-utils">macop.utils</a></li>
  59. </ul>
  60. </li>
  61. <li class="toctree-l1"><a class="reference internal" href="../documentations/index.html">Documentation</a></li>
  62. <li class="toctree-l1"><a class="reference internal" href="../examples.html">Some examples</a></li>
  63. <li class="toctree-l1"><a class="reference internal" href="../contributing.html">Contributing</a></li>
  64. </ul>
  65. </div>
  66. </div>
  67. </nav>
  68. <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
  69. <nav class="wy-nav-top" aria-label="top navigation">
  70. <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
  71. <a href="../index.html">macop</a>
  72. </nav>
  73. <div class="wy-nav-content">
  74. <div class="rst-content">
  75. <div role="navigation" aria-label="breadcrumbs navigation">
  76. <ul class="wy-breadcrumbs">
  77. <li><a href="../index.html">Docs</a> &raquo;</li>
  78. <li><a href="../api.html">API</a> &raquo;</li>
  79. <li>macop.algorithms.multi</li>
  80. <li class="wy-breadcrumbs-aside">
  81. <a href="https://github.com/prise-3d/macop/blob/master/docs/source/macop/macop.algorithms.multi.rst" class="fa fa-github"> Edit on GitHub</a>
  82. </li>
  83. </ul>
  84. <hr/>
  85. </div>
  86. <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
  87. <div itemprop="articleBody">
  88. <div class="section" id="module-macop.algorithms.multi">
  89. <span id="macop-algorithms-multi"></span><h1>macop.algorithms.multi<a class="headerlink" href="#module-macop.algorithms.multi" title="Permalink to this headline">¶</a></h1>
  90. <p>Multi-objetive classes algorithm</p>
  91. <p class="rubric">Classes</p>
  92. <table class="longtable docutils align-default">
  93. <colgroup>
  94. <col style="width: 10%" />
  95. <col style="width: 90%" />
  96. </colgroup>
  97. <tbody>
  98. <tr class="row-odd"><td><p><a class="reference internal" href="#macop.algorithms.multi.MOEAD" title="macop.algorithms.multi.MOEAD"><code class="xref py py-obj docutils literal notranslate"><span class="pre">MOEAD</span></code></a>(mu, T, initializer, evaluator, …[, …])</p></td>
  99. <td><p>Multi-Ojective Evolutionary Algorithm with Scalar Decomposition</p></td>
  100. </tr>
  101. <tr class="row-even"><td><p><a class="reference internal" href="#macop.algorithms.multi.MOSubProblem" title="macop.algorithms.multi.MOSubProblem"><code class="xref py py-obj docutils literal notranslate"><span class="pre">MOSubProblem</span></code></a>(index, weights, initalizer, …)</p></td>
  102. <td><p>Specific MO sub problem used into MOEAD</p></td>
  103. </tr>
  104. </tbody>
  105. </table>
  106. <dl class="class">
  107. <dt id="macop.algorithms.multi.MOEAD">
  108. <em class="property">class </em><code class="sig-prename descclassname">macop.algorithms.multi.</code><code class="sig-name descname">MOEAD</code><span class="sig-paren">(</span><em class="sig-param">mu</em>, <em class="sig-param">T</em>, <em class="sig-param">initializer</em>, <em class="sig-param">evaluator</em>, <em class="sig-param">operators</em>, <em class="sig-param">policy</em>, <em class="sig-param">validator</em>, <em class="sig-param">maximise=True</em>, <em class="sig-param">parent=None</em>, <em class="sig-param">verbose=True</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/macop/algorithms/multi.html#MOEAD"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#macop.algorithms.multi.MOEAD" title="Permalink to this definition">¶</a></dt>
  109. <dd><p>Multi-Ojective Evolutionary Algorithm with Scalar Decomposition</p>
  110. <dl class="attribute">
  111. <dt id="macop.algorithms.multi.MOEAD.mu">
  112. <code class="sig-name descname">mu</code><a class="headerlink" href="#macop.algorithms.multi.MOEAD.mu" title="Permalink to this definition">¶</a></dt>
  113. <dd><p>{int} – number of sub problems</p>
  114. </dd></dl>
  115. <dl class="attribute">
  116. <dt id="macop.algorithms.multi.MOEAD.T">
  117. <code class="sig-name descname">T</code><a class="headerlink" href="#macop.algorithms.multi.MOEAD.T" title="Permalink to this definition">¶</a></dt>
  118. <dd><p>{[float]} – number of neightbors for each sub problem</p>
  119. </dd></dl>
  120. <dl class="attribute">
  121. <dt id="macop.algorithms.multi.MOEAD.nObjectives">
  122. <code class="sig-name descname">nObjectives</code><a class="headerlink" href="#macop.algorithms.multi.MOEAD.nObjectives" title="Permalink to this definition">¶</a></dt>
  123. <dd><p>{int} – number of objectives (based of number evaluator)</p>
  124. </dd></dl>
  125. <dl class="attribute">
  126. <dt id="macop.algorithms.multi.MOEAD.initializer">
  127. <code class="sig-name descname">initializer</code><a class="headerlink" href="#macop.algorithms.multi.MOEAD.initializer" title="Permalink to this definition">¶</a></dt>
  128. <dd><p>{function} – basic function strategy to initialize solution</p>
  129. </dd></dl>
  130. <dl class="attribute">
  131. <dt id="macop.algorithms.multi.MOEAD.evaluator">
  132. <code class="sig-name descname">evaluator</code><a class="headerlink" href="#macop.algorithms.multi.MOEAD.evaluator" title="Permalink to this definition">¶</a></dt>
  133. <dd><p>{[function]} – list of basic function in order to obtained fitness (multiple objectives)</p>
  134. </dd></dl>
  135. <dl class="attribute">
  136. <dt id="macop.algorithms.multi.MOEAD.operators">
  137. <code class="sig-name descname">operators</code><a class="headerlink" href="#macop.algorithms.multi.MOEAD.operators" title="Permalink to this definition">¶</a></dt>
  138. <dd><p>{[Operator]} – list of operator to use when launching algorithm</p>
  139. </dd></dl>
  140. <dl class="attribute">
  141. <dt id="macop.algorithms.multi.MOEAD.policy">
  142. <code class="sig-name descname">policy</code><a class="headerlink" href="#macop.algorithms.multi.MOEAD.policy" title="Permalink to this definition">¶</a></dt>
  143. <dd><p>{Policy} – Policy class implementation strategy to select operators</p>
  144. </dd></dl>
  145. <dl class="attribute">
  146. <dt id="macop.algorithms.multi.MOEAD.validator">
  147. <code class="sig-name descname">validator</code><a class="headerlink" href="#macop.algorithms.multi.MOEAD.validator" title="Permalink to this definition">¶</a></dt>
  148. <dd><p>{function} – basic function to check if solution is valid or not under some constraints</p>
  149. </dd></dl>
  150. <dl class="attribute">
  151. <dt id="macop.algorithms.multi.MOEAD.maximise">
  152. <code class="sig-name descname">maximise</code><a class="headerlink" href="#macop.algorithms.multi.MOEAD.maximise" title="Permalink to this definition">¶</a></dt>
  153. <dd><p>{bool} – specify kind of optimisation problem</p>
  154. </dd></dl>
  155. <dl class="attribute">
  156. <dt id="macop.algorithms.multi.MOEAD.verbose">
  157. <code class="sig-name descname">verbose</code><a class="headerlink" href="#macop.algorithms.multi.MOEAD.verbose" title="Permalink to this definition">¶</a></dt>
  158. <dd><p>{bool} – verbose or not information about the algorithm</p>
  159. </dd></dl>
  160. <dl class="attribute">
  161. <dt id="macop.algorithms.multi.MOEAD.population">
  162. <code class="sig-name descname">population</code><a class="headerlink" href="#macop.algorithms.multi.MOEAD.population" title="Permalink to this definition">¶</a></dt>
  163. <dd><p>[{Solution}] – population of solution, one for each sub problem</p>
  164. </dd></dl>
  165. <dl class="attribute">
  166. <dt id="macop.algorithms.multi.MOEAD.pfPop">
  167. <code class="sig-name descname">pfPop</code><a class="headerlink" href="#macop.algorithms.multi.MOEAD.pfPop" title="Permalink to this definition">¶</a></dt>
  168. <dd><p>[{Solution}] – pareto front population</p>
  169. </dd></dl>
  170. <dl class="attribute">
  171. <dt id="macop.algorithms.multi.MOEAD.weights">
  172. <code class="sig-name descname">weights</code><a class="headerlink" href="#macop.algorithms.multi.MOEAD.weights" title="Permalink to this definition">¶</a></dt>
  173. <dd><p>[[{float}]] – random weights used for custom mu sub problems</p>
  174. </dd></dl>
  175. <dl class="attribute">
  176. <dt id="macop.algorithms.multi.MOEAD.callbacks">
  177. <code class="sig-name descname">callbacks</code><a class="headerlink" href="#macop.algorithms.multi.MOEAD.callbacks" title="Permalink to this definition">¶</a></dt>
  178. <dd><p>{[Callback]} – list of Callback class implementation to do some instructions every number of evaluations and <cite>load</cite> when initializing algorithm</p>
  179. </dd></dl>
  180. <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="kn">import</span> <span class="nn">random</span>
  181. <span class="gp">&gt;&gt;&gt; </span><span class="c1"># operators import</span>
  182. <span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">macop.operators.discrete.crossovers</span> <span class="kn">import</span> <span class="n">SimpleCrossover</span>
  183. <span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">macop.operators.discrete.mutators</span> <span class="kn">import</span> <span class="n">SimpleMutation</span>
  184. <span class="gp">&gt;&gt;&gt; </span><span class="c1"># policy import</span>
  185. <span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">macop.policies.classicals</span> <span class="kn">import</span> <span class="n">RandomPolicy</span>
  186. <span class="gp">&gt;&gt;&gt; </span><span class="c1"># solution and algorithm</span>
  187. <span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">macop.solutions.discrete</span> <span class="kn">import</span> <span class="n">BinarySolution</span>
  188. <span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">macop.algorithms.multi</span> <span class="kn">import</span> <span class="n">MOEAD</span>
  189. <span class="gp">&gt;&gt;&gt; </span><span class="c1"># evaluator import</span>
  190. <span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">macop.evaluators.discrete.mono</span> <span class="kn">import</span> <span class="n">KnapsackEvaluator</span>
  191. <span class="gp">&gt;&gt;&gt; </span><span class="c1"># evaluator initialization (worths objects passed into data)</span>
  192. <span class="gp">&gt;&gt;&gt; </span><span class="n">problem_size</span> <span class="o">=</span> <span class="mi">20</span>
  193. <span class="gp">&gt;&gt;&gt; </span><span class="n">worths1</span> <span class="o">=</span> <span class="p">[</span> <span class="n">random</span><span class="o">.</span><span class="n">randint</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="mi">20</span><span class="p">)</span> <span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="n">problem_size</span><span class="p">)</span> <span class="p">]</span>
  194. <span class="gp">&gt;&gt;&gt; </span><span class="n">evaluator1</span> <span class="o">=</span> <span class="n">KnapsackEvaluator</span><span class="p">(</span><span class="n">data</span><span class="o">=</span><span class="p">{</span><span class="s1">&#39;worths&#39;</span><span class="p">:</span> <span class="n">worths1</span><span class="p">})</span>
  195. <span class="gp">&gt;&gt;&gt; </span><span class="n">worths2</span> <span class="o">=</span> <span class="p">[</span> <span class="n">random</span><span class="o">.</span><span class="n">randint</span><span class="p">(</span><span class="mi">10</span><span class="p">,</span> <span class="mi">15</span><span class="p">)</span> <span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="n">problem_size</span><span class="p">)</span> <span class="p">]</span>
  196. <span class="gp">&gt;&gt;&gt; </span><span class="n">evaluator2</span> <span class="o">=</span> <span class="n">KnapsackEvaluator</span><span class="p">(</span><span class="n">data</span><span class="o">=</span><span class="p">{</span><span class="s1">&#39;worths&#39;</span><span class="p">:</span> <span class="n">worths2</span><span class="p">})</span>
  197. <span class="gp">&gt;&gt;&gt; </span><span class="c1"># validator specification (based on weights of each objects)</span>
  198. <span class="gp">&gt;&gt;&gt; </span><span class="n">weights</span> <span class="o">=</span> <span class="p">[</span> <span class="n">random</span><span class="o">.</span><span class="n">randint</span><span class="p">(</span><span class="mi">5</span><span class="p">,</span> <span class="mi">30</span><span class="p">)</span> <span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="n">problem_size</span><span class="p">)</span> <span class="p">]</span>
  199. <span class="gp">&gt;&gt;&gt; </span><span class="n">validator</span> <span class="o">=</span> <span class="k">lambda</span> <span class="n">solution</span><span class="p">:</span> <span class="kc">True</span> <span class="k">if</span> <span class="nb">sum</span><span class="p">([</span><span class="n">weights</span><span class="p">[</span><span class="n">i</span><span class="p">]</span> <span class="k">for</span> <span class="n">i</span><span class="p">,</span> <span class="n">value</span> <span class="ow">in</span> <span class="nb">enumerate</span><span class="p">(</span><span class="n">solution</span><span class="o">.</span><span class="n">_data</span><span class="p">)</span> <span class="k">if</span> <span class="n">value</span> <span class="o">==</span> <span class="mi">1</span><span class="p">])</span> <span class="o">&lt;</span> <span class="mi">200</span> <span class="k">else</span> <span class="kc">False</span>
  200. <span class="gp">&gt;&gt;&gt; </span><span class="c1"># initializer function with lambda function</span>
  201. <span class="gp">&gt;&gt;&gt; </span><span class="n">initializer</span> <span class="o">=</span> <span class="k">lambda</span> <span class="n">x</span><span class="o">=</span><span class="mi">20</span><span class="p">:</span> <span class="n">BinarySolution</span><span class="o">.</span><span class="n">random</span><span class="p">(</span><span class="n">x</span><span class="p">,</span> <span class="n">validator</span><span class="p">)</span>
  202. <span class="gp">&gt;&gt;&gt; </span><span class="c1"># operators list with crossover and mutation</span>
  203. <span class="gp">&gt;&gt;&gt; </span><span class="n">operators</span> <span class="o">=</span> <span class="p">[</span><span class="n">SimpleCrossover</span><span class="p">(),</span> <span class="n">SimpleMutation</span><span class="p">()]</span>
  204. <span class="gp">&gt;&gt;&gt; </span><span class="n">policy</span> <span class="o">=</span> <span class="n">RandomPolicy</span><span class="p">(</span><span class="n">operators</span><span class="p">)</span>
  205. <span class="gp">&gt;&gt;&gt; </span><span class="c1"># MOEAD use multi-objective, hence list of evaluators with mu=100 and T=10</span>
  206. <span class="gp">&gt;&gt;&gt; </span><span class="n">algo</span> <span class="o">=</span> <span class="n">MOEAD</span><span class="p">(</span><span class="mi">20</span><span class="p">,</span> <span class="mi">5</span><span class="p">,</span> <span class="n">initializer</span><span class="p">,</span> <span class="p">[</span><span class="n">evaluator1</span><span class="p">,</span> <span class="n">evaluator2</span><span class="p">],</span> <span class="n">operators</span><span class="p">,</span> <span class="n">policy</span><span class="p">,</span> <span class="n">validator</span><span class="p">,</span> <span class="n">maximise</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">verbose</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span>
  207. <span class="gp">&gt;&gt;&gt; </span><span class="c1"># run the algorithm and get the pareto front obtained</span>
  208. <span class="gp">&gt;&gt;&gt; </span><span class="n">pf_solutions</span> <span class="o">=</span> <span class="n">algo</span><span class="o">.</span><span class="n">run</span><span class="p">(</span><span class="mi">100</span><span class="p">)</span>
  209. <span class="gp">&gt;&gt;&gt; </span><span class="c1"># check size of expected pareto</span>
  210. <span class="gp">&gt;&gt;&gt; </span><span class="nb">len</span><span class="p">(</span><span class="n">pf_solutions</span><span class="p">)</span>
  211. <span class="go">33</span>
  212. </pre></div>
  213. </div>
  214. <dl class="method">
  215. <dt id="macop.algorithms.multi.MOEAD.end">
  216. <code class="sig-name descname">end</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/macop/algorithms/multi.html#MOEAD.end"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#macop.algorithms.multi.MOEAD.end" title="Permalink to this definition">¶</a></dt>
  217. <dd><p>Display end message into <cite>run</cite> method</p>
  218. </dd></dl>
  219. <dl class="method">
  220. <dt id="macop.algorithms.multi.MOEAD.initRun">
  221. <code class="sig-name descname">initRun</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/macop/algorithms/multi.html#MOEAD.initRun"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#macop.algorithms.multi.MOEAD.initRun" title="Permalink to this definition">¶</a></dt>
  222. <dd><p>Method which initialiazes or re-initializes the whole algorithm context specifically for MOEAD</p>
  223. </dd></dl>
  224. <dl class="method">
  225. <dt id="macop.algorithms.multi.MOEAD.progress">
  226. <code class="sig-name descname">progress</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/macop/algorithms/multi.html#MOEAD.progress"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#macop.algorithms.multi.MOEAD.progress" title="Permalink to this definition">¶</a></dt>
  227. <dd><p>Log progress and apply callbacks if necessary</p>
  228. </dd></dl>
  229. <dl class="method">
  230. <dt id="macop.algorithms.multi.MOEAD.run">
  231. <code class="sig-name descname">run</code><span class="sig-paren">(</span><em class="sig-param">evaluations</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/macop/algorithms/multi.html#MOEAD.run"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#macop.algorithms.multi.MOEAD.run" title="Permalink to this definition">¶</a></dt>
  232. <dd><p>Run the local search algorithm</p>
  233. <dl class="field-list simple">
  234. <dt class="field-odd">Parameters</dt>
  235. <dd class="field-odd"><p><strong>evaluations</strong> – {int} – number of Local search evaluations</p>
  236. </dd>
  237. <dt class="field-even">Returns</dt>
  238. <dd class="field-even"><p>{Solution} – best solution found</p>
  239. </dd>
  240. </dl>
  241. </dd></dl>
  242. </dd></dl>
  243. <dl class="class">
  244. <dt id="macop.algorithms.multi.MOSubProblem">
  245. <em class="property">class </em><code class="sig-prename descclassname">macop.algorithms.multi.</code><code class="sig-name descname">MOSubProblem</code><span class="sig-paren">(</span><em class="sig-param">index</em>, <em class="sig-param">weights</em>, <em class="sig-param">initalizer</em>, <em class="sig-param">evaluator</em>, <em class="sig-param">operators</em>, <em class="sig-param">policy</em>, <em class="sig-param">validator</em>, <em class="sig-param">maximise=True</em>, <em class="sig-param">parent=None</em>, <em class="sig-param">verbose=True</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/macop/algorithms/multi.html#MOSubProblem"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#macop.algorithms.multi.MOSubProblem" title="Permalink to this definition">¶</a></dt>
  246. <dd><p>Specific MO sub problem used into MOEAD</p>
  247. <dl class="attribute">
  248. <dt id="macop.algorithms.multi.MOSubProblem.index">
  249. <code class="sig-name descname">index</code><a class="headerlink" href="#macop.algorithms.multi.MOSubProblem.index" title="Permalink to this definition">¶</a></dt>
  250. <dd><p>{int} – sub problem index</p>
  251. </dd></dl>
  252. <dl class="attribute">
  253. <dt id="macop.algorithms.multi.MOSubProblem.weights">
  254. <code class="sig-name descname">weights</code><a class="headerlink" href="#macop.algorithms.multi.MOSubProblem.weights" title="Permalink to this definition">¶</a></dt>
  255. <dd><p>{[float]} – sub problems objectives weights</p>
  256. </dd></dl>
  257. <dl class="attribute">
  258. <dt id="macop.algorithms.multi.MOSubProblem.initalizer">
  259. <code class="sig-name descname">initalizer</code><a class="headerlink" href="#macop.algorithms.multi.MOSubProblem.initalizer" title="Permalink to this definition">¶</a></dt>
  260. <dd><p>{function} – basic function strategy to initialize solution</p>
  261. </dd></dl>
  262. <dl class="attribute">
  263. <dt id="macop.algorithms.multi.MOSubProblem.evaluator">
  264. <code class="sig-name descname">evaluator</code><a class="headerlink" href="#macop.algorithms.multi.MOSubProblem.evaluator" title="Permalink to this definition">¶</a></dt>
  265. <dd><p>{function} – basic function in order to obtained fitness (mono or multiple objectives)</p>
  266. </dd></dl>
  267. <dl class="attribute">
  268. <dt id="macop.algorithms.multi.MOSubProblem.operators">
  269. <code class="sig-name descname">operators</code><a class="headerlink" href="#macop.algorithms.multi.MOSubProblem.operators" title="Permalink to this definition">¶</a></dt>
  270. <dd><p>{[Operator]} – list of operator to use when launching algorithm</p>
  271. </dd></dl>
  272. <dl class="attribute">
  273. <dt id="macop.algorithms.multi.MOSubProblem.policy">
  274. <code class="sig-name descname">policy</code><a class="headerlink" href="#macop.algorithms.multi.MOSubProblem.policy" title="Permalink to this definition">¶</a></dt>
  275. <dd><p>{Policy} – Policy class implementation strategy to select operators</p>
  276. </dd></dl>
  277. <dl class="attribute">
  278. <dt id="macop.algorithms.multi.MOSubProblem.validator">
  279. <code class="sig-name descname">validator</code><a class="headerlink" href="#macop.algorithms.multi.MOSubProblem.validator" title="Permalink to this definition">¶</a></dt>
  280. <dd><p>{function} – basic function to check if solution is valid or not under some constraints</p>
  281. </dd></dl>
  282. <dl class="attribute">
  283. <dt id="macop.algorithms.multi.MOSubProblem.maximise">
  284. <code class="sig-name descname">maximise</code><a class="headerlink" href="#macop.algorithms.multi.MOSubProblem.maximise" title="Permalink to this definition">¶</a></dt>
  285. <dd><p>{bool} – specify kind of optimisation problem</p>
  286. </dd></dl>
  287. <dl class="attribute">
  288. <dt id="macop.algorithms.multi.MOSubProblem.verbose">
  289. <code class="sig-name descname">verbose</code><a class="headerlink" href="#macop.algorithms.multi.MOSubProblem.verbose" title="Permalink to this definition">¶</a></dt>
  290. <dd><p>{bool} – verbose or not information about the algorithm</p>
  291. </dd></dl>
  292. <dl class="attribute">
  293. <dt id="macop.algorithms.multi.MOSubProblem.currentSolution">
  294. <code class="sig-name descname">currentSolution</code><a class="headerlink" href="#macop.algorithms.multi.MOSubProblem.currentSolution" title="Permalink to this definition">¶</a></dt>
  295. <dd><p>{Solution} – current solution managed for current evaluation</p>
  296. </dd></dl>
  297. <dl class="attribute">
  298. <dt id="macop.algorithms.multi.MOSubProblem.bestSolution">
  299. <code class="sig-name descname">bestSolution</code><a class="headerlink" href="#macop.algorithms.multi.MOSubProblem.bestSolution" title="Permalink to this definition">¶</a></dt>
  300. <dd><p>{Solution} – best solution found so far during running algorithm</p>
  301. </dd></dl>
  302. <dl class="attribute">
  303. <dt id="macop.algorithms.multi.MOSubProblem.callbacks">
  304. <code class="sig-name descname">callbacks</code><a class="headerlink" href="#macop.algorithms.multi.MOSubProblem.callbacks" title="Permalink to this definition">¶</a></dt>
  305. <dd><p>{[Callback]} – list of Callback class implementation to do some instructions every number of evaluations and <cite>load</cite> when initializing algorithm</p>
  306. </dd></dl>
  307. <p>Example:</p>
  308. <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="kn">import</span> <span class="nn">random</span>
  309. <span class="gp">&gt;&gt;&gt; </span><span class="c1"># operators import</span>
  310. <span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">macop.operators.discrete.crossovers</span> <span class="kn">import</span> <span class="n">SimpleCrossover</span>
  311. <span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">macop.operators.discrete.mutators</span> <span class="kn">import</span> <span class="n">SimpleMutation</span>
  312. <span class="gp">&gt;&gt;&gt; </span><span class="c1"># policy import</span>
  313. <span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">macop.policies.classicals</span> <span class="kn">import</span> <span class="n">RandomPolicy</span>
  314. <span class="gp">&gt;&gt;&gt; </span><span class="c1"># solution and algorithm</span>
  315. <span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">macop.solutions.discrete</span> <span class="kn">import</span> <span class="n">BinarySolution</span>
  316. <span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">macop.algorithms.multi</span> <span class="kn">import</span> <span class="n">MOEAD</span><span class="p">,</span> <span class="n">MOSubProblem</span>
  317. <span class="gp">&gt;&gt;&gt; </span><span class="c1"># evaluator import</span>
  318. <span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">macop.evaluators.discrete.mono</span> <span class="kn">import</span> <span class="n">KnapsackEvaluator</span>
  319. <span class="gp">&gt;&gt;&gt; </span><span class="c1"># evaluator initialization (worths objects passed into data)</span>
  320. <span class="gp">&gt;&gt;&gt; </span><span class="n">problem_size</span> <span class="o">=</span> <span class="mi">20</span>
  321. <span class="gp">&gt;&gt;&gt; </span><span class="n">worths1</span> <span class="o">=</span> <span class="p">[</span> <span class="n">random</span><span class="o">.</span><span class="n">randint</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="mi">20</span><span class="p">)</span> <span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="n">problem_size</span><span class="p">)</span> <span class="p">]</span>
  322. <span class="gp">&gt;&gt;&gt; </span><span class="n">evaluator1</span> <span class="o">=</span> <span class="n">KnapsackEvaluator</span><span class="p">(</span><span class="n">data</span><span class="o">=</span><span class="p">{</span><span class="s1">&#39;worths&#39;</span><span class="p">:</span> <span class="n">worths1</span><span class="p">})</span>
  323. <span class="gp">&gt;&gt;&gt; </span><span class="n">worths2</span> <span class="o">=</span> <span class="p">[</span> <span class="n">random</span><span class="o">.</span><span class="n">randint</span><span class="p">(</span><span class="mi">10</span><span class="p">,</span> <span class="mi">15</span><span class="p">)</span> <span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="n">problem_size</span><span class="p">)</span> <span class="p">]</span>
  324. <span class="gp">&gt;&gt;&gt; </span><span class="n">evaluator2</span> <span class="o">=</span> <span class="n">KnapsackEvaluator</span><span class="p">(</span><span class="n">data</span><span class="o">=</span><span class="p">{</span><span class="s1">&#39;worths&#39;</span><span class="p">:</span> <span class="n">worths2</span><span class="p">})</span>
  325. <span class="gp">&gt;&gt;&gt; </span><span class="c1"># validator specification (based on weights of each objects)</span>
  326. <span class="gp">&gt;&gt;&gt; </span><span class="n">weights</span> <span class="o">=</span> <span class="p">[</span> <span class="n">random</span><span class="o">.</span><span class="n">randint</span><span class="p">(</span><span class="mi">5</span><span class="p">,</span> <span class="mi">30</span><span class="p">)</span> <span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="n">problem_size</span><span class="p">)</span> <span class="p">]</span>
  327. <span class="gp">&gt;&gt;&gt; </span><span class="n">validator</span> <span class="o">=</span> <span class="k">lambda</span> <span class="n">solution</span><span class="p">:</span> <span class="kc">True</span> <span class="k">if</span> <span class="nb">sum</span><span class="p">([</span><span class="n">weights</span><span class="p">[</span><span class="n">i</span><span class="p">]</span> <span class="k">for</span> <span class="n">i</span><span class="p">,</span> <span class="n">value</span> <span class="ow">in</span> <span class="nb">enumerate</span><span class="p">(</span><span class="n">solution</span><span class="o">.</span><span class="n">_data</span><span class="p">)</span> <span class="k">if</span> <span class="n">value</span> <span class="o">==</span> <span class="mi">1</span><span class="p">])</span> <span class="o">&lt;</span> <span class="mi">200</span> <span class="k">else</span> <span class="kc">False</span>
  328. <span class="gp">&gt;&gt;&gt; </span><span class="c1"># initializer function with lambda function</span>
  329. <span class="gp">&gt;&gt;&gt; </span><span class="n">initializer</span> <span class="o">=</span> <span class="k">lambda</span> <span class="n">x</span><span class="o">=</span><span class="mi">20</span><span class="p">:</span> <span class="n">BinarySolution</span><span class="o">.</span><span class="n">random</span><span class="p">(</span><span class="n">x</span><span class="p">,</span> <span class="n">validator</span><span class="p">)</span>
  330. <span class="gp">&gt;&gt;&gt; </span><span class="c1"># operators list with crossover and mutation</span>
  331. <span class="gp">&gt;&gt;&gt; </span><span class="n">operators</span> <span class="o">=</span> <span class="p">[</span><span class="n">SimpleCrossover</span><span class="p">(),</span> <span class="n">SimpleMutation</span><span class="p">()]</span>
  332. <span class="gp">&gt;&gt;&gt; </span><span class="n">policy</span> <span class="o">=</span> <span class="n">RandomPolicy</span><span class="p">(</span><span class="n">operators</span><span class="p">)</span>
  333. <span class="gp">&gt;&gt;&gt; </span><span class="n">algo</span> <span class="o">=</span> <span class="n">MOEAD</span><span class="p">(</span><span class="mi">20</span><span class="p">,</span> <span class="mi">5</span><span class="p">,</span> <span class="n">initializer</span><span class="p">,</span> <span class="p">[</span><span class="n">evaluator1</span><span class="p">,</span> <span class="n">evaluator2</span><span class="p">],</span> <span class="n">operators</span><span class="p">,</span> <span class="n">policy</span><span class="p">,</span> <span class="n">validator</span><span class="p">,</span> <span class="n">maximise</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">verbose</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span>
  334. <span class="gp">&gt;&gt;&gt; </span><span class="c1"># weights of the sub problem</span>
  335. <span class="gp">&gt;&gt;&gt; </span><span class="n">sub_problem_weights</span> <span class="o">=</span> <span class="p">[</span><span class="mf">0.4</span><span class="p">,</span> <span class="mf">0.6</span><span class="p">]</span>
  336. <span class="gp">&gt;&gt;&gt; </span><span class="n">sub_evaluator</span> <span class="o">=</span> <span class="n">WeightedSum</span><span class="p">(</span><span class="n">data</span><span class="o">=</span><span class="p">{</span><span class="s1">&#39;evaluators&#39;</span><span class="p">:</span> <span class="p">[</span><span class="n">evaluator1</span><span class="p">,</span> <span class="n">evaluator2</span><span class="p">],</span> <span class="s1">&#39;weights&#39;</span><span class="p">:</span> <span class="n">sub_problem_weights</span><span class="p">})</span>
  337. <span class="gp">&gt;&gt;&gt; </span><span class="c1"># first parameter is the index of the MOSubProblem</span>
  338. <span class="gp">&gt;&gt;&gt; </span><span class="n">subProblem</span> <span class="o">=</span> <span class="n">MOSubProblem</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="n">sub_problem_weights</span><span class="p">,</span> <span class="n">initializer</span><span class="p">,</span> <span class="n">sub_evaluator</span><span class="p">,</span> <span class="n">operators</span><span class="p">,</span> <span class="n">policy</span><span class="p">,</span> <span class="n">validator</span><span class="p">,</span> <span class="n">maximise</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">parent</span><span class="o">=</span><span class="n">algo</span><span class="p">,</span> <span class="n">verbose</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span>
  339. <span class="gp">&gt;&gt;&gt; </span><span class="c1"># run the algorithm</span>
  340. <span class="gp">&gt;&gt;&gt; </span><span class="n">solution</span> <span class="o">=</span> <span class="n">subProblem</span><span class="o">.</span><span class="n">run</span><span class="p">(</span><span class="mi">100</span><span class="p">)</span>
  341. <span class="gp">&gt;&gt;&gt; </span><span class="n">solution</span><span class="o">.</span><span class="n">_score</span>
  342. <span class="go">133.0</span>
  343. </pre></div>
  344. </div>
  345. <dl class="method">
  346. <dt id="macop.algorithms.multi.MOSubProblem.run">
  347. <code class="sig-name descname">run</code><span class="sig-paren">(</span><em class="sig-param">evaluations</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/macop/algorithms/multi.html#MOSubProblem.run"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#macop.algorithms.multi.MOSubProblem.run" title="Permalink to this definition">¶</a></dt>
  348. <dd><p>Run the local search algorithm</p>
  349. <dl class="field-list simple">
  350. <dt class="field-odd">Parameters</dt>
  351. <dd class="field-odd"><p><strong>evaluations</strong> – {int} – number of evaluations</p>
  352. </dd>
  353. <dt class="field-even">Returns</dt>
  354. <dd class="field-even"><p>{Solution} – best solution found</p>
  355. </dd>
  356. </dl>
  357. </dd></dl>
  358. </dd></dl>
  359. </div>
  360. </div>
  361. </div>
  362. <footer>
  363. <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
  364. <a href="macop.callbacks.base.html" class="btn btn-neutral float-right" title="macop.callbacks.base" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
  365. <a href="macop.algorithms.mono.html" class="btn btn-neutral float-left" title="macop.algorithms.mono" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
  366. </div>
  367. <hr/>
  368. <div role="contentinfo">
  369. <p>
  370. &copy; Copyright 2020, Jérôme BUISINE
  371. </p>
  372. </div>
  373. 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>.
  374. </footer>
  375. </div>
  376. </div>
  377. </section>
  378. </div>
  379. <script type="text/javascript">
  380. jQuery(function () {
  381. SphinxRtdTheme.Navigation.enable(true);
  382. });
  383. </script>
  384. </body>
  385. </html>