Update docs

jMetal · Jan 8, 2020 · 6fae0a3 · 6fae0a3
1 parent 8100db9
commit 6fae0a3
Show file tree

Hide file tree

Showing 124 changed files with 3,627 additions and 830 deletions.
diff --git a/README.md b/README.md
@@ -19,21 +19,21 @@ A paper introducing jMetalPy is available at: https://doi.org/10.1016/j.swevo.20
 You can install the latest version of jMetalPy with `pip`, 
 
 ```console
-pip install jmetalpy
+pip install jmetalpy  # or "jmetalpy[distributed]"
 ```
 
 <details><summary><b>Notes on installing with <tt>pip</tt></b></summary>
 <p>
 
 jMetalPy includes features for parallel and distributed computing based on [pySpark](https://spark.apache.org/docs/latest/api/python/index.html) and [Dask](https://dask.org/).
 
-These (extra) dependencies are automatically installed when running `pip`:
+These (extra) dependencies are *not* automatically installed when running `pip`, which only comprises the core functionality of the framework (enough for most users):
 
 ```console
 pip install jmetalpy
 ```
 
-But you can also install the core functionality of the framework (which is often enough for most users):
+This is the equivalent of running: 
 
 ```console
 pip install "jmetalpy[core]"

diff --git a/docs/_modules/index.html b/docs/_modules/index.html
@@ -24,7 +24,6 @@
     <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
     <script async="async" type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
     <script type="text/x-mathjax-config">MathJax.Hub.Config({"tex2jax": {"inlineMath": [["$", "$"], ["\\(", "\\)"]], "processEscapes": true, "ignoreClass": "document", "processClass": "math|output_area"}})</script>
-    <link rel="author" title="About these documents" href="../about.html" />
     <link rel="index" title="Index" href="../genindex.html" />
     <link rel="search" title="Search" href="../search.html" />
 
@@ -73,8 +72,6 @@ <h2>Table Of Contents</h2>
 <li class="toctree-l1"><a class="reference internal" href="../singleobjective.algorithms.html">Single-objective algorithms</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../operators.html">Operators</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../problems.html">Problems</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../contributing.html">Contributing</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../about.html">About</a></li>
 </ul>
 
 
@@ -115,7 +112,6 @@ <h1>All modules for which code is available</h1>
 <li><a href="jmetal/algorithm/multiobjective/mocell.html">jmetal.algorithm.multiobjective.mocell</a></li>
 <li><a href="jmetal/algorithm/multiobjective/moead.html">jmetal.algorithm.multiobjective.moead</a></li>
 <li><a href="jmetal/algorithm/multiobjective/nsgaii.html">jmetal.algorithm.multiobjective.nsgaii</a></li>
-<li><a href="jmetal/algorithm/multiobjective/nsgaiii.html">jmetal.algorithm.multiobjective.nsgaiii</a></li>
 <li><a href="jmetal/algorithm/multiobjective/omopso.html">jmetal.algorithm.multiobjective.omopso</a></li>
 <li><a href="jmetal/algorithm/multiobjective/smpso.html">jmetal.algorithm.multiobjective.smpso</a></li>
 <li><a href="jmetal/algorithm/multiobjective/spea2.html">jmetal.algorithm.multiobjective.spea2</a></li>
@@ -125,8 +121,10 @@ <h1>All modules for which code is available</h1>
 <li><a href="jmetal/algorithm/singleobjective/simulated_annealing.html">jmetal.algorithm.singleobjective.simulated_annealing</a></li>
 <li><a href="jmetal/core/observer.html">jmetal.core.observer</a></li>
 <li><a href="jmetal/core/problem.html">jmetal.core.problem</a></li>
+<li><a href="jmetal/lab/experiment.html">jmetal.lab.experiment</a></li>
 <li><a href="jmetal/lab/statistical_test/apv_procedures.html">jmetal.lab.statistical_test.apv_procedures</a></li>
 <li><a href="jmetal/lab/statistical_test/bayesian.html">jmetal.lab.statistical_test.bayesian</a></li>
+<li><a href="jmetal/lab/statistical_test/critical_distance.html">jmetal.lab.statistical_test.critical_distance</a></li>
 <li><a href="jmetal/lab/statistical_test/functions.html">jmetal.lab.statistical_test.functions</a></li>
 <li><a href="jmetal/lab/visualization/chord_plot.html">jmetal.lab.visualization.chord_plot</a></li>
 <li><a href="jmetal/lab/visualization/interactive.html">jmetal.lab.visualization.interactive</a></li>

diff --git a/docs/_modules/jmetal/algorithm/multiobjective/gde3.html b/docs/_modules/jmetal/algorithm/multiobjective/gde3.html
@@ -24,7 +24,6 @@
     <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
     <script async="async" type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
     <script type="text/x-mathjax-config">MathJax.Hub.Config({"tex2jax": {"inlineMath": [["$", "$"], ["\\(", "\\)"]], "processEscapes": true, "ignoreClass": "document", "processClass": "math|output_area"}})</script>
-    <link rel="author" title="About these documents" href="../../../../about.html" />
     <link rel="index" title="Index" href="../../../../genindex.html" />
     <link rel="search" title="Search" href="../../../../search.html" />
 
@@ -74,8 +73,6 @@ <h2>Table Of Contents</h2>
 <li class="toctree-l1"><a class="reference internal" href="../../../../singleobjective.algorithms.html">Single-objective algorithms</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../../operators.html">Operators</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../../problems.html">Problems</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../../../../contributing.html">Contributing</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../../../../about.html">About</a></li>
 </ul>
 
 
@@ -112,26 +109,26 @@ <h2>Table Of Contents</h2>
           <div class="document clearer body">
 
   <h1>Source code for jmetal.algorithm.multiobjective.gde3</h1><div class="highlight"><pre>
-<span></span><span class="kn">from</span> <span class="nn">typing</span> <span class="k">import</span> <span class="n">TypeVar</span><span class="p">,</span> <span class="n">List</span>
-
-<span class="kn">from</span> <span class="nn">jmetal.config</span> <span class="k">import</span> <span class="n">store</span>
-<span class="kn">from</span> <span class="nn">jmetal.core.algorithm</span> <span class="k">import</span> <span class="n">EvolutionaryAlgorithm</span><span class="p">,</span> <span class="n">DynamicAlgorithm</span>
-<span class="kn">from</span> <span class="nn">jmetal.core.problem</span> <span class="k">import</span> <span class="n">Problem</span><span class="p">,</span> <span class="n">DynamicProblem</span>
-<span class="kn">from</span> <span class="nn">jmetal.core.solution</span> <span class="k">import</span> <span class="n">FloatSolution</span>
-<span class="kn">from</span> <span class="nn">jmetal.operator</span> <span class="k">import</span> <span class="n">DifferentialEvolutionCrossover</span><span class="p">,</span> <span class="n">RankingAndCrowdingDistanceSelection</span>
-<span class="kn">from</span> <span class="nn">jmetal.operator.selection</span> <span class="k">import</span> <span class="n">DifferentialEvolutionSelection</span>
-<span class="kn">from</span> <span class="nn">jmetal.util.comparator</span> <span class="k">import</span> <span class="n">Comparator</span><span class="p">,</span> <span class="n">DominanceComparator</span>
-<span class="kn">from</span> <span class="nn">jmetal.util.evaluator</span> <span class="k">import</span> <span class="n">Evaluator</span>
-<span class="kn">from</span> <span class="nn">jmetal.util.generator</span> <span class="k">import</span> <span class="n">Generator</span>
-<span class="kn">from</span> <span class="nn">jmetal.util.termination_criterion</span> <span class="k">import</span> <span class="n">TerminationCriterion</span>
+<span></span><span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">TypeVar</span><span class="p">,</span> <span class="n">List</span>
+
+<span class="kn">from</span> <span class="nn">jmetal.config</span> <span class="kn">import</span> <span class="n">store</span>
+<span class="kn">from</span> <span class="nn">jmetal.core.algorithm</span> <span class="kn">import</span> <span class="n">EvolutionaryAlgorithm</span><span class="p">,</span> <span class="n">DynamicAlgorithm</span>
+<span class="kn">from</span> <span class="nn">jmetal.core.problem</span> <span class="kn">import</span> <span class="n">Problem</span><span class="p">,</span> <span class="n">DynamicProblem</span>
+<span class="kn">from</span> <span class="nn">jmetal.core.solution</span> <span class="kn">import</span> <span class="n">FloatSolution</span>
+<span class="kn">from</span> <span class="nn">jmetal.operator</span> <span class="kn">import</span> <span class="n">DifferentialEvolutionCrossover</span><span class="p">,</span> <span class="n">RankingAndCrowdingDistanceSelection</span>
+<span class="kn">from</span> <span class="nn">jmetal.operator.selection</span> <span class="kn">import</span> <span class="n">DifferentialEvolutionSelection</span>
+<span class="kn">from</span> <span class="nn">jmetal.util.comparator</span> <span class="kn">import</span> <span class="n">Comparator</span><span class="p">,</span> <span class="n">DominanceComparator</span>
+<span class="kn">from</span> <span class="nn">jmetal.util.evaluator</span> <span class="kn">import</span> <span class="n">Evaluator</span>
+<span class="kn">from</span> <span class="nn">jmetal.util.generator</span> <span class="kn">import</span> <span class="n">Generator</span>
+<span class="kn">from</span> <span class="nn">jmetal.util.termination_criterion</span> <span class="kn">import</span> <span class="n">TerminationCriterion</span>
 
 <span class="n">S</span> <span class="o">=</span> <span class="n">TypeVar</span><span class="p">(</span><span class="s1">&#39;S&#39;</span><span class="p">)</span>
 <span class="n">R</span> <span class="o">=</span> <span class="n">List</span><span class="p">[</span><span class="n">S</span><span class="p">]</span>
 
 
 <div class="viewcode-block" id="GDE3"><a class="viewcode-back" href="../../../../api/algorithm/multiobjective/eas/gde3.html#jmetal.algorithm.multiobjective.gde3.GDE3">[docs]</a><span class="k">class</span> <span class="nc">GDE3</span><span class="p">(</span><span class="n">EvolutionaryAlgorithm</span><span class="p">[</span><span class="n">FloatSolution</span><span class="p">,</span> <span class="n">FloatSolution</span><span class="p">]):</span>
 
-    <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span>
+    <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">problem</span><span class="p">:</span> <span class="n">Problem</span><span class="p">,</span>
                  <span class="n">population_size</span><span class="p">:</span> <span class="nb">int</span><span class="p">,</span>
                  <span class="n">cr</span><span class="p">:</span> <span class="nb">float</span><span class="p">,</span>
@@ -215,7 +212,7 @@ <h1>Source code for jmetal.algorithm.multiobjective.gde3</h1><div class="highlig
 
 <div class="viewcode-block" id="DynamicGDE3"><a class="viewcode-back" href="../../../../api/algorithm/multiobjective/eas/gde3_dynamic.html#jmetal.algorithm.multiobjective.gde3.DynamicGDE3">[docs]</a><span class="k">class</span> <span class="nc">DynamicGDE3</span><span class="p">(</span><span class="n">GDE3</span><span class="p">,</span> <span class="n">DynamicAlgorithm</span><span class="p">):</span>
 
-    <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span>
+    <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">problem</span><span class="p">:</span> <span class="n">DynamicProblem</span><span class="p">,</span>
                  <span class="n">population_size</span><span class="p">:</span> <span class="nb">int</span><span class="p">,</span>
                  <span class="n">cr</span><span class="p">:</span> <span class="nb">float</span><span class="p">,</span>

diff --git a/docs/_modules/jmetal/algorithm/multiobjective/hype.html b/docs/_modules/jmetal/algorithm/multiobjective/hype.html
@@ -24,7 +24,6 @@
     <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
     <script async="async" type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
     <script type="text/x-mathjax-config">MathJax.Hub.Config({"tex2jax": {"inlineMath": [["$", "$"], ["\\(", "\\)"]], "processEscapes": true, "ignoreClass": "document", "processClass": "math|output_area"}})</script>
-    <link rel="author" title="About these documents" href="../../../../about.html" />
     <link rel="index" title="Index" href="../../../../genindex.html" />
     <link rel="search" title="Search" href="../../../../search.html" />
 
@@ -74,8 +73,6 @@ <h2>Table Of Contents</h2>
 <li class="toctree-l1"><a class="reference internal" href="../../../../singleobjective.algorithms.html">Single-objective algorithms</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../../operators.html">Operators</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../../problems.html">Problems</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../../../../contributing.html">Contributing</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../../../../about.html">About</a></li>
 </ul>
 
 
@@ -112,28 +109,28 @@ <h2>Table Of Contents</h2>
           <div class="document clearer body">
 
   <h1>Source code for jmetal.algorithm.multiobjective.hype</h1><div class="highlight"><pre>
-<span></span><span class="kn">from</span> <span class="nn">typing</span> <span class="k">import</span> <span class="n">TypeVar</span><span class="p">,</span> <span class="n">List</span>
-
-<span class="kn">from</span> <span class="nn">jmetal.algorithm.singleobjective.genetic_algorithm</span> <span class="k">import</span> <span class="n">GeneticAlgorithm</span>
-<span class="kn">from</span> <span class="nn">jmetal.config</span> <span class="k">import</span> <span class="n">store</span>
-<span class="kn">from</span> <span class="nn">jmetal.core.operator</span> <span class="k">import</span> <span class="n">Mutation</span><span class="p">,</span> <span class="n">Crossover</span>
-<span class="kn">from</span> <span class="nn">jmetal.core.problem</span> <span class="k">import</span> <span class="n">Problem</span>
-<span class="kn">from</span> <span class="nn">jmetal.core.solution</span> <span class="k">import</span> <span class="n">Solution</span>
-<span class="kn">from</span> <span class="nn">jmetal.operator</span> <span class="k">import</span> <span class="n">BinaryTournamentSelection</span>
-<span class="kn">from</span> <span class="nn">jmetal.operator.selection</span> <span class="k">import</span> <span class="n">RankingAndFitnessSelection</span>
-<span class="kn">from</span> <span class="nn">jmetal.util.comparator</span> <span class="k">import</span> <span class="n">Comparator</span>
-<span class="kn">from</span> <span class="nn">jmetal.util.comparator</span> <span class="k">import</span> <span class="n">SolutionAttributeComparator</span>
-<span class="kn">from</span> <span class="nn">jmetal.util.evaluator</span> <span class="k">import</span> <span class="n">Evaluator</span>
-<span class="kn">from</span> <span class="nn">jmetal.util.generator</span> <span class="k">import</span> <span class="n">Generator</span>
-<span class="kn">from</span> <span class="nn">jmetal.util.termination_criterion</span> <span class="k">import</span> <span class="n">TerminationCriterion</span>
+<span></span><span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">TypeVar</span><span class="p">,</span> <span class="n">List</span>
+
+<span class="kn">from</span> <span class="nn">jmetal.algorithm.singleobjective.genetic_algorithm</span> <span class="kn">import</span> <span class="n">GeneticAlgorithm</span>
+<span class="kn">from</span> <span class="nn">jmetal.config</span> <span class="kn">import</span> <span class="n">store</span>
+<span class="kn">from</span> <span class="nn">jmetal.core.operator</span> <span class="kn">import</span> <span class="n">Mutation</span><span class="p">,</span> <span class="n">Crossover</span>
+<span class="kn">from</span> <span class="nn">jmetal.core.problem</span> <span class="kn">import</span> <span class="n">Problem</span>
+<span class="kn">from</span> <span class="nn">jmetal.core.solution</span> <span class="kn">import</span> <span class="n">Solution</span>
+<span class="kn">from</span> <span class="nn">jmetal.operator</span> <span class="kn">import</span> <span class="n">BinaryTournamentSelection</span>
+<span class="kn">from</span> <span class="nn">jmetal.operator.selection</span> <span class="kn">import</span> <span class="n">RankingAndFitnessSelection</span>
+<span class="kn">from</span> <span class="nn">jmetal.util.comparator</span> <span class="kn">import</span> <span class="n">Comparator</span>
+<span class="kn">from</span> <span class="nn">jmetal.util.comparator</span> <span class="kn">import</span> <span class="n">SolutionAttributeComparator</span>
+<span class="kn">from</span> <span class="nn">jmetal.util.evaluator</span> <span class="kn">import</span> <span class="n">Evaluator</span>
+<span class="kn">from</span> <span class="nn">jmetal.util.generator</span> <span class="kn">import</span> <span class="n">Generator</span>
+<span class="kn">from</span> <span class="nn">jmetal.util.termination_criterion</span> <span class="kn">import</span> <span class="n">TerminationCriterion</span>
 
 <span class="n">S</span> <span class="o">=</span> <span class="n">TypeVar</span><span class="p">(</span><span class="s1">&#39;S&#39;</span><span class="p">)</span>
 <span class="n">R</span> <span class="o">=</span> <span class="n">TypeVar</span><span class="p">(</span><span class="s1">&#39;R&#39;</span><span class="p">)</span>
 
 
 <div class="viewcode-block" id="HYPE"><a class="viewcode-back" href="../../../../api/algorithm/multiobjective/eas/hype.html#jmetal.algorithm.multiobjective.hype.HYPE">[docs]</a><span class="k">class</span> <span class="nc">HYPE</span><span class="p">(</span><span class="n">GeneticAlgorithm</span><span class="p">[</span><span class="n">S</span><span class="p">,</span> <span class="n">R</span><span class="p">]):</span>
 
-    <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span>
+    <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">problem</span><span class="p">:</span> <span class="n">Problem</span><span class="p">,</span>
                  <span class="n">reference_point</span><span class="p">:</span> <span class="n">Solution</span><span class="p">,</span>
                  <span class="n">population_size</span><span class="p">:</span> <span class="nb">int</span><span class="p">,</span>