diff --git a/Makefile b/Makefile index c024d661..e650b479 100644 --- a/Makefile +++ b/Makefile @@ -5,7 +5,7 @@ SPHINXOPTS = SPHINXBUILD = sphinx-build SPHINXPROJ = jMetalPy -SOURCEDIR = source +SOURCEDIR = docs/source BUILDDIR = build # Put it first so that "make" without argument is like "make help". diff --git a/README.md b/README.md index 42b7ff57..ab231b51 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -![jMetalPy](source/jmetalpy.png) +![jMetalPy](docs/source/jmetalpy.png) [![Build Status](https://img.shields.io/travis/jMetal/jMetalPy/master.svg?style=flat-square)](https://travis-ci.org/jMetal/jMetalPy) [![Documentation](https://img.shields.io/badge/docs-online-success?style=flat-square)](https://jmetal.github.io/jMetalPy/index.html) @@ -42,7 +42,7 @@ pip install "jmetalpy[core]" Other supported commands are listed next: ```console -pip install "jmetalpy[doc]" # Install requirements for building docs +pip install "jmetalpy[docs]" # Install requirements for building docs pip install "jmetalpy[distributed]" # Install requirements for parallel/distributed computing pip install "jmetalpy[complete]" # Install all requirements ``` @@ -96,7 +96,7 @@ plot_front = Plot(title='Pareto front approximation', axis_labels=['x', 'y']) plot_front.plot(front, label='NSGAII-ZDT1', filename='NSGAII-ZDT1', format='png') ``` -Pareto front approximation +Pareto front approximation ## Features The current release of jMetalPy (v1.5.3) contains the following components: @@ -111,9 +111,9 @@ The current release of jMetalPy (v1.5.3) contains the following components: * Experiment class for performing studies either alone or alongside [jMetal](https://github.com/jMetal/jMetal). * Pairwise and multiple hypothesis testing for statistical analysis, including several frequentist and Bayesian testing methods, critical distance plots and posterior diagrams. -| ![Scatter plot 2D](source/_static/2D.gif) | ![Scatter plot 3D](source/_static/3D.gif) | +| ![Scatter plot 2D](docs/source/_static/2D.gif) | ![Scatter plot 3D](docs/source/_static/3D.gif) | |-------------- | ---------------- | -| ![Parallel coordinates](source/_static/p-c.gif) | ![Interactive chord plot](source/_static/chordplot.gif) | +| ![Parallel coordinates](docs/source/_static/p-c.gif) | ![Interactive chord plot](docs/source/_static/chordplot.gif) | ## License This project is licensed under the terms of the MIT - see the [LICENSE](LICENSE) file for details. \ No newline at end of file diff --git a/docs/_modules/jmetal/lab/visualization/plotting.html b/docs/_modules/jmetal/lab/visualization/plotting.html index a88f0275..3870466b 100644 --- a/docs/_modules/jmetal/lab/visualization/plotting.html +++ b/docs/_modules/jmetal/lab/visualization/plotting.html @@ -227,8 +227,9 @@

Source code for jmetal.lab.visualization.plotting

if filename: plt.savefig(filename + '.' + format, format=format, dpi=200) + else: + plt.show() - plt.show() plt.close(fig=fig)
[docs] def three_dim(self, fronts: List[list], labels: List[str] = None, filename: str = None, format: str = 'eps'): @@ -267,8 +268,9 @@

Source code for jmetal.lab.visualization.plotting

if filename: plt.savefig(filename + '.' + format, format=format, dpi=1000) + else: + plt.show() - plt.show() plt.close(fig=fig)
[docs] def pcoords(self, fronts: List[list], normalize: bool = False, filename: str = None, format: str = 'eps'): @@ -300,8 +302,9 @@

Source code for jmetal.lab.visualization.plotting

if filename: plt.savefig(filename + '.' + format, format=format, dpi=1000) + else: + plt.show() - plt.show() plt.close(fig=fig)
diff --git a/docs/_modules/jmetal/problem/multiobjective/lircmop.html b/docs/_modules/jmetal/problem/multiobjective/lircmop.html index 8b4b3013..d8b792e6 100644 --- a/docs/_modules/jmetal/problem/multiobjective/lircmop.html +++ b/docs/_modules/jmetal/problem/multiobjective/lircmop.html @@ -271,7 +271,7 @@

Source code for jmetal.problem.multiobjective.lircmop

""" def __init__(self, number_of_variables: int = 30): - super(LIRCMOP1, self).__init__() + super(LIRCMOP5, self).__init__() self.number_of_variables = number_of_variables self.number_of_objectives = 2 self.number_of_constraints = 2 diff --git a/docs/_sources/index.rst.txt b/docs/_sources/index.rst.txt index 2b2d3884..2281df58 100644 --- a/docs/_sources/index.rst.txt +++ b/docs/_sources/index.rst.txt @@ -31,8 +31,15 @@ Via pip: .. code-block:: console $ pip install jmetalpy - $ pip install "jmetalpy[core]" # Install core components of the framework - $ pip install "jmetalpy[complete]" # Install also dependencies for distributed computing + +.. note:: Alternatively, you can use one of these instead: + + .. code-block:: console + + $ pip install "jmetalpy[core]" # Install core components of the framework + $ pip install "jmetalpy[docs]" # Install requirements for building docs + $ pip install "jmetalpy[distributed]" # Install requirements for parallel/distributed computing + $ pip install "jmetalpy[complete]" # Install all dependencies (equivalent to `pip install jmetalpy`) Via source code: @@ -51,7 +58,7 @@ The current release of jMetalPy (v1.5.3) contains the following components: * Encodings: real, binary, permutations. * Operators: selection (binary tournament, ranking and crowding distance, random, nary random, best solution), crossover (single-point, SBX), mutation (bit-blip, polynomial, uniform, random). * Quality indicators: hypervolume, additive epsilon, GD, IGD. -* Pareto front plotting for problems with two or more objectives (as scatter plot/parallel coordinates/chordplot) in real-time, static or interactive. +* Pareto front approximation plotting in real-time, static or interactive. * Experiment class for performing studies either alone or alongside jMetal. * Pairwise and multiple hypothesis testing for statistical analysis, including several frequentist and Bayesian testing methods, critical distance plots and posterior diagrams. diff --git a/source/_static/NSGAII-ZDT1.png b/docs/_static/NSGAII-ZDT1.png similarity index 100% rename from source/_static/NSGAII-ZDT1.png rename to docs/_static/NSGAII-ZDT1.png diff --git a/docs/index.html b/docs/index.html index 64724b5f..257288f4 100644 --- a/docs/index.html +++ b/docs/index.html @@ -164,10 +164,18 @@

ContentΒΆ

Via pip:

$ pip install jmetalpy
-$ pip install "jmetalpy[core]"  # Install core components of the framework
-$ pip install "jmetalpy[complete]"  # Install also dependencies for distributed computing
+
+

Note

+

Alternatively, you can use one of these instead:

+
$ pip install "jmetalpy[core]"  # Install core components of the framework
+$ pip install "jmetalpy[docs]"  # Install requirements for building docs
+$ pip install "jmetalpy[distributed]"  # Install requirements for parallel/distributed computing
+$ pip install "jmetalpy[complete]"  # Install all dependencies (equivalent to `pip install jmetalpy`)
+
+
+

Via source code:

$ git clone https://github.com/jMetal/jMetalPy.git
 $ python setup.py install
@@ -184,7 +192,7 @@ 
Summary of features=1.2.2', 'distributed>=1.28.1', 'pyspark>=2.4.0']
 }
 extras_require['complete'] = {v for req in extras_require.values() for v in req}