← Back to branch summary

~ubuntu-branches/ubuntu/utopic/deap/utopic-proposed

« back to all changes in this revision

Viewing changes to doc/api/index.rst

  • Committer: Package Import Robot
  • Author(s): Daniel Stender, Miriam Ruiz, Daniel Stender, Jakub Wilk
  • Date: 2014-07-06 00:03:41 UTC
  • mfrom: (1.1.2)
  • Revision ID: package-import@ubuntu.com-20140706000341-s7gij1ki3d8xz6t9
Tags: 1.0.1-1
http://bugs.debian.org/675200
[ Miriam Ruiz ]
* New Upstream Release. Closes: #675200
* Upgraded Standards-Version from 3.9.2 to 3.9.5
* Switched to dh_python2
* Upgraded debian/compat to 9
* Added build-arch and build-indep targets to debian/rules
* Using awk to remove connection from the documentation to google analytics
* Using jquery.js and underscore.js from libjs-jquery and libjs-underscore
* Added patches/doc.patch

[ Daniel Stender ]
* deb/control:
  + Added myself to Uploaders.
  + Added version to b-p on python-all.
  + Updated Homepage.
  + Wrapped and sorted.
* deb/copyright:
  + Changed copyright file towards DEP-5.
  + Updated Source URI (project source moved to Github).
  + Added email addresses for copyright holders.
  + Dropped license for eap/toolbox.py (not included anymore).
  + Extended copyrights to 2014.
  + Added myself to copyrights for deb/*.
  + Specified license location.
* Added watch file [initial version by Jackson Doak].

[ Jakub Wilk ]
* Use canonical URIs for Vcs-* fields.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/api/index.rst
1
 
API
2
 
---
3
 
The API of DEAP is built around a clean and lean core composed of two simple
4
 
structures: a :mod:`~deap.creator` and :class:`~deap.base.Toolbox`. The former
5
 
allows creation of classes, at run-time, via inheritance and composition and
6
 
the latter contains the tools that are required by the evolutionary algorithm.
7
 
The core functionalities of DEAP are levered by several peripheral modules.
8
 
The :mod:`~deap.tools` module provides a bunch of operator that are commonly
9
 
used in evolutionary computation such as initialization, mutation, crossover
10
 
and selection functions. It also contains all sort of tools to gather
11
 
information about the evolution such as statistics on almost every thing,
12
 
genealogy of the produced individuals, hall-of-fame of the best individuals
13
 
seen, and checkpoints allowing to restart an evolution from its last state.
14
 
The :mod:`~deap.algorithms` module contains five of the most frequently used
15
 
algorithms in EC: generational, steady-state, :math:`(\mu\ ,\ \lambda)`,
16
 
:math:`(\mu+\lambda)`, and CMA-ES. These are readily usable for the most
17
 
common population layouts. Specific genetic programming tools are provided in
18
 
the :mod:`~deap.gp` module. A complete and efficient (and stand alone)
19
 
parallelization module, base on MPI, providing some very useful parallel
20
 
method is provided in the :mod:`~deap.dtm` module. Finally, common benchmark
21
 
functions are readily implemented in the :mod:`~deap.benchmarks`.
 
1
Library Reference
 
2
=================
 
3
 
 
4
Description of the functions, classes and modules contained within DEAP.
 
5
 
22
6
 
23
7
.. toctree::
24
8
        :maxdepth: 2
25
 
        :numbered:
26
9
   
27
 
        core
 
10
        creator
 
11
        base
28
12
        tools
29
13
        algo
30
14
        gp
31
 
        dtm
32
 
        benchmarks
 
 
b'\\ No newline at end of file'
 
15
        benchmarks