Merge pull request #51 from hstko/release

Release 0.1.0
onegpy-team · Nov 6, 2018 · ea89cdd · ea89cdd
2 parents 5b5e9d0 + 57492fb
commit ea89cdd
Show file tree

Hide file tree

Showing 236 changed files with 29,457 additions and 867 deletions.
diff --git a/LICENSE b/LICENSE
@@ -1,6 +1,17 @@
 MIT License
 
+All contributions by Taku Hasegawa:
 Copyright (c) 2018 Taku Hasegawa
+All rights reserved
+
+All contributions by Hironori Yamamoto:
+Copyright (c) 2018 Hironori Yamamoto
+All rights reserved
+
+All contributions by Yoshiyuki Tanaka:
+Copyright (c) 2018 Yoshiyuki Tanaka
+All rights reserved
+
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

diff --git a/README.md b/README.md
diff --git a/README.rst b/README.rst
@@ -0,0 +1,52 @@
+OnegPy
+=======
+
+OnegPy is a genetic programming (GP) framework, written in Python.
+It was developed with a focus on easy setting or customizing 
+of GP algorithm.
+
+Supports both classical tree-based GPs and `Genetic programming with multi-layered population structure (MLPS-GP) <https://dl.acm.org/citation.cfm?id=3067695.3076048>`_, as well as combinations of genetic operators
+which are adopted in these algorithms.
+
+OnegPy is compatible with: Python 3.6-.
+
+
+Installation
+-------------
+To install OnegPy, follow the below.
+
+install OnegPy using pip
+~~~~~~~~~~~~~~~~~~~~~~~~~
+[W.I.P]
+
+install OnegPy from the GitHub
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+::
+
+   $ git clone https://github.com/onegpy-team/onegpy
+
+Then,
+
+::
+
+   $ cd onegpy
+   $ python setup.py install
+
+**NOTE:**
+
+If you are using of an environment of your system, you need to use `sudo` to install;
+
+::
+
+    $ sudo python setup.py install
+
+
+Requirements
+-------------
+- `numpy <https://github.com/numpy/numpy/tree/master/doc/source/reference>`_ is required.
+
+Examples
+---------
+Some examples are located in `examples <https://github.com/onegpy-team/onegpy/examples>`_.
+
diff --git a/gplib/base/__init__.py → docs/.nojekyll b/gplib/base/__init__.py → docs/.nojekyll
diff --git a/docs/Makefile b/docs/Makefile
@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+SPHINXPROJ    = GPLib
+SOURCEDIR     = source
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
diff --git a/docs/build/doctrees/environment.pickle b/docs/build/doctrees/environment.pickle
diff --git a/docs/build/doctrees/index.doctree b/docs/build/doctrees/index.doctree
diff --git a/docs/build/doctrees/reference/base.doctree b/docs/build/doctrees/reference/base.doctree
diff --git a/docs/build/doctrees/reference/index.doctree b/docs/build/doctrees/reference/index.doctree
diff --git a/docs/build/doctrees/reference/operator.doctree b/docs/build/doctrees/reference/operator.doctree
diff --git a/docs/build/doctrees/reference/operators.crossover.doctree b/docs/build/doctrees/reference/operators.crossover.doctree
diff --git a/docs/build/doctrees/reference/operators.doctree b/docs/build/doctrees/reference/operators.doctree
diff --git a/docs/build/doctrees/reference/operators.initializer.doctree b/docs/build/doctrees/reference/operators.initializer.doctree
diff --git a/docs/build/doctrees/reference/operators.localsearch.doctree b/docs/build/doctrees/reference/operators.localsearch.doctree
diff --git a/docs/build/doctrees/reference/operators.mutation.doctree b/docs/build/doctrees/reference/operators.mutation.doctree
diff --git a/docs/build/doctrees/reference/operators.selection.doctree b/docs/build/doctrees/reference/operators.selection.doctree
diff --git a/docs/build/doctrees/reference/problem.doctree b/docs/build/doctrees/reference/problem.doctree
diff --git a/docs/build/doctrees/reference/problems.arithmetic.doctree b/docs/build/doctrees/reference/problems.arithmetic.doctree
diff --git a/docs/build/doctrees/reference/problems.boolean.doctree b/docs/build/doctrees/reference/problems.boolean.doctree
diff --git a/docs/build/doctrees/reference/problems.doctree b/docs/build/doctrees/reference/problems.doctree
diff --git a/docs/build/doctrees/reference/sequential.doctree b/docs/build/doctrees/reference/sequential.doctree
diff --git a/docs/build/doctrees/reference/solutions.doctree b/docs/build/doctrees/reference/solutions.doctree
diff --git a/docs/build/doctrees/reference/solutions.node.doctree b/docs/build/doctrees/reference/solutions.node.doctree
diff --git a/docs/build/doctrees/reference/solutions.solution.doctree b/docs/build/doctrees/reference/solutions.solution.doctree
diff --git a/docs/build/doctrees/reference/terminator.doctree b/docs/build/doctrees/reference/terminator.doctree
diff --git a/docs/build/doctrees/reference/utils.checkers.doctree b/docs/build/doctrees/reference/utils.checkers.doctree
diff --git a/docs/build/doctrees/reference/utils.config.doctree b/docs/build/doctrees/reference/utils.config.doctree
diff --git a/docs/build/doctrees/reference/utils.doctree b/docs/build/doctrees/reference/utils.doctree
diff --git a/docs/build/doctrees/reference/utils.util.doctree b/docs/build/doctrees/reference/utils.util.doctree
diff --git a/docs/build/html/.buildinfo b/docs/build/html/.buildinfo
@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: e1e6aea5bd71a29b32ce65e147525d35
+tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/gplib/problem/__init__.py → docs/build/html/.nojekyll b/gplib/problem/__init__.py → docs/build/html/.nojekyll
diff --git a/docs/build/html/_modules/index.html b/docs/build/html/_modules/index.html
@@ -0,0 +1,215 @@
+
+
+<!DOCTYPE html>
+<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
+<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
+<head>
+  <meta charset="utf-8">
+
+  <meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+  <title>Overview: module code &mdash; OnegPy 0.1.0 documentation</title>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+  <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
+  <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
+    <link rel="index" title="Index" href="../genindex.html" />
+    <link rel="search" title="Search" href="../search.html" /> 
+
+
+  <script src="../_static/js/modernizr.min.js"></script>
+
+</head>
+
+<body class="wy-body-for-nav">
+
+
+  <div class="wy-grid-for-nav">
+
+
+    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+      <div class="wy-side-scroll">
+        <div class="wy-side-nav-search">
+
+
+
+            <a href="../index.html" class="icon icon-home"> OnegPy
+
+
+
+          </a>
+
+
+
+
+              <div class="version">
+                0.1
+              </div>
+
+
+
+
+<div role="search">
+  <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
+    <input type="text" name="q" placeholder="Search docs" />
+    <input type="hidden" name="check_keywords" value="yes" />
+    <input type="hidden" name="area" value="default" />
+  </form>
+</div>
+
+
+        </div>
+
+        <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
+
+
+
+
+
+
+              <!-- Local TOC -->
+              <div class="local-toc"></div>
+
+
+        </div>
+      </div>
+    </nav>
+
+    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
+
+
+      <nav class="wy-nav-top" aria-label="top navigation">
+
+          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+          <a href="../index.html">OnegPy</a>
+
+      </nav>
+
+
+      <div class="wy-nav-content">
+
+        <div class="rst-content">
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+<div role="navigation" aria-label="breadcrumbs navigation">
+
+  <ul class="wy-breadcrumbs">
+
+      <li><a href="../index.html">Docs</a> &raquo;</li>
+
+      <li>Overview: module code</li>
+
+
+      <li class="wy-breadcrumbs-aside">
+
+      </li>
+
+  </ul>
+
+
+  <hr/>
+</div>
+          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
+           <div itemprop="articleBody">
+
+  <h1>All modules for which code is available</h1>
+<ul><li><a href="onegpy/base/mlps.html">onegpy.base.mlps</a></li>
+<li><a href="onegpy/base/sgp.html">onegpy.base.sgp</a></li>
+<li><a href="onegpy/operator.html">onegpy.operator</a></li>
+<li><a href="onegpy/operators/crossover.html">onegpy.operators.crossover</a></li>
+<li><a href="onegpy/operators/initializer.html">onegpy.operators.initializer</a></li>
+<li><a href="onegpy/operators/localsearch.html">onegpy.operators.localsearch</a></li>
+<li><a href="onegpy/operators/mutation.html">onegpy.operators.mutation</a></li>
+<li><a href="onegpy/operators/selection.html">onegpy.operators.selection</a></li>
+<li><a href="onegpy/problem.html">onegpy.problem</a></li>
+<li><a href="onegpy/problems/arithmetic.html">onegpy.problems.arithmetic</a></li>
+<li><a href="onegpy/problems/boolean.html">onegpy.problems.boolean</a></li>
+<li><a href="onegpy/sequential.html">onegpy.sequential</a></li>
+<li><a href="onegpy/solutions/node.html">onegpy.solutions.node</a></li>
+<li><a href="onegpy/solutions/solution.html">onegpy.solutions.solution</a></li>
+<li><a href="onegpy/terminator.html">onegpy.terminator</a></li>
+<li><a href="onegpy/utils/checkers.html">onegpy.utils.checkers</a></li>
+<li><a href="onegpy/utils/config.html">onegpy.utils.config</a></li>
+<li><a href="onegpy/utils/util.html">onegpy.utils.util</a></li>
+<li><a href="onegpy/viewers/loggers.html">onegpy.viewers.loggers</a></li>
+<li><a href="onegpy/viewers/observer.html">onegpy.viewers.observer</a></li>
+</ul>
+
+           </div>
+
+          </div>
+          <footer>
+
+
+  <hr/>
+
+  <div role="contentinfo">
+    <p>
+        &copy; Copyright 2018, Taku Hasegawa, Hironori Yamamoto, Yoshiyuki Tanaka
+
+    </p>
+  </div>
+  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>. 
+
+</footer>
+
+        </div>
+      </div>
+
+    </section>
+
+  </div>
+
+
+
+
+
+
+
+      <script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
+        <script type="text/javascript" src="../_static/jquery.js"></script>
+        <script type="text/javascript" src="../_static/underscore.js"></script>
+        <script type="text/javascript" src="../_static/doctools.js"></script>
+        <script async="async" type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
+
+
+
+
+  <script type="text/javascript" src="../_static/js/theme.js"></script>
+
+  <script type="text/javascript">
+      jQuery(function () {
+          SphinxRtdTheme.Navigation.enable(true);
+      });
+  </script> 
+
+</body>
+</html>
diff --git a/docs/build/html/_sources/index.rst.txt b/docs/build/html/_sources/index.rst.txt
@@ -0,0 +1,21 @@
+.. GPLib documentation master file, created by
+   sphinx-quickstart on Fri Sep  7 19:16:32 2018.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+
+.. include:: ../../README.rst
+
+.. toctree::
+   :maxdepth: 1
+   :caption: Contents
+
+   reference/index
+
+
+Indices and tables
+~~~~~~~~~~~~~~~~~~~
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
diff --git a/docs/build/html/_sources/reference/base.rst.txt b/docs/build/html/_sources/reference/base.rst.txt
@@ -0,0 +1,13 @@
+base package
+============
+
+.. automodule:: onegpy.base
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. toctree::
+
+   base.mlps
+   base.sgp
+
diff --git a/docs/build/html/_sources/reference/index.rst.txt b/docs/build/html/_sources/reference/index.rst.txt
@@ -0,0 +1,25 @@
+Reference
+=========
+
+.. automodule:: onegpy
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. toctree::
+
+   base
+   operators
+   problems
+   solutions
+   utils
+   viewers
+
+.. toctree::
+
+   operator
+   problem
+   sequential
+   terminal_condition
+   terminator
+
diff --git a/docs/build/html/_sources/reference/operator.rst.txt b/docs/build/html/_sources/reference/operator.rst.txt
@@ -0,0 +1,15 @@
+operator
+========
+
+.. module:: onegpy.operator
+.. autosummary::
+   :toctree: generated/
+   :nosignatures:
+
+   AbstractOperator
+   PopulationOperator
+   PopulationOperatorAdapter
+   ProblemBasedOperator
+   build_population_operator
+   operator_checker
+   pop_operator_checker