diff --git a/README.md b/README.md index 3e0ed06..f4b21e6 100644 --- a/README.md +++ b/README.md @@ -16,7 +16,7 @@ If you have more questions, then log in [google group](https://groups.google.com ## Download -It has been uploaded to [pypi](https://pypi.org/project/pyrimidine/), so download it with `pip install pyrimidine`, and also could download it from github. +It has been uploaded to [pypi](https://pypi.org/project/pyrimidine/), so download it with `pip install pyrimidine`, and also could download it from Github. ## Idea @@ -34,7 +34,7 @@ class BasePopulation(PopulationModel, metaclass=MetaContainer): default_size = 20 ``` -There is two main kinds of containers: list-like and tuple-like, as in programming language `Haskell`. See following examples. +There is two main kinds of containers: list-like and tuple-like. See following examples. ```python # individual with chromosomes of type _Chromosome @@ -437,3 +437,8 @@ pop = MyParticleSwarm.random() ``` Of course, it is not mandatory. It is allowed to inherit `ParticleSwarm` from for example `HOFPopulation` directly. + +## Contributions + +If you'd like to contribute to `pyrimidine`, please contact with me; +and if you have noticed some bugs, then use the GitHub issues page to report them. \ No newline at end of file diff --git a/docs/build/.doctrees/environment.pickle b/docs/build/.doctrees/environment.pickle index 11bfa0e..e961555 100644 Binary files a/docs/build/.doctrees/environment.pickle and b/docs/build/.doctrees/environment.pickle differ diff --git a/docs/build/.doctrees/index.doctree b/docs/build/.doctrees/index.doctree index aa90b77..fd4ffc1 100644 Binary files a/docs/build/.doctrees/index.doctree and b/docs/build/.doctrees/index.doctree differ diff --git a/docs/build/.doctrees/source/Home.doctree b/docs/build/.doctrees/source/Home.doctree index 26e11eb..9284184 100644 Binary files a/docs/build/.doctrees/source/Home.doctree and b/docs/build/.doctrees/source/Home.doctree differ diff --git a/docs/build/.doctrees/source/Release History.doctree b/docs/build/.doctrees/source/Release History.doctree index ba0f5fa..cc24826 100644 Binary files a/docs/build/.doctrees/source/Release History.doctree and b/docs/build/.doctrees/source/Release History.doctree differ diff --git a/docs/build/.doctrees/source/pyrimidine.benchmarks.doctree b/docs/build/.doctrees/source/pyrimidine.benchmarks.doctree index 7bbb77f..236d284 100644 Binary files a/docs/build/.doctrees/source/pyrimidine.benchmarks.doctree and b/docs/build/.doctrees/source/pyrimidine.benchmarks.doctree differ diff --git a/docs/build/.doctrees/source/pyrimidine.doctree b/docs/build/.doctrees/source/pyrimidine.doctree index f9001a4..e02ca69 100644 Binary files a/docs/build/.doctrees/source/pyrimidine.doctree and b/docs/build/.doctrees/source/pyrimidine.doctree differ diff --git a/docs/build/.doctrees/source/pyrimidine.learn.doctree b/docs/build/.doctrees/source/pyrimidine.learn.doctree index f93dfa1..dd38af3 100644 Binary files a/docs/build/.doctrees/source/pyrimidine.learn.doctree and b/docs/build/.doctrees/source/pyrimidine.learn.doctree differ diff --git a/docs/build/.doctrees/source/pyrimidine.local_search.doctree b/docs/build/.doctrees/source/pyrimidine.local_search.doctree index 3b26992..37d4e18 100644 Binary files a/docs/build/.doctrees/source/pyrimidine.local_search.doctree and b/docs/build/.doctrees/source/pyrimidine.local_search.doctree differ diff --git a/docs/build/_sources/index.rst.txt b/docs/build/_sources/index.rst.txt index 4e33743..e72f9fa 100644 --- a/docs/build/_sources/index.rst.txt +++ b/docs/build/_sources/index.rst.txt @@ -25,6 +25,10 @@ Welcome to pyrimidine's world of genetic algorithm Helpers <../source/Helpers.md> Misc <../source/Misc.md> + +.. toctree:: + :maxdepth: 2 + :caption: Contents: modules <../source/modules.rst> diff --git a/docs/build/_sources/source/Home.md.txt b/docs/build/_sources/source/Home.md.txt index aab9669..c964693 100644 --- a/docs/build/_sources/source/Home.md.txt +++ b/docs/build/_sources/source/Home.md.txt @@ -23,9 +23,15 @@ We view the population as a container of individuals, each individual as a conta Mathematically, we denote a container of elements of type `A` as follows: ``` -s = {a:A}:S +s = {a:A}:S <==> s: S[A] ``` -A population is a container of individuals; an individual is a container of chromosomes. Below is the partial source code for `BaseIndividual` and `BasePopulation`. + +Now we give the following definition: +- A population is a container of individuals (or chromosomes); +- An individual is a container of chromosomes; +- A multi-population is a container of population; + +Below is the partial source code for `BaseIndividual` and `BasePopulation`. ```python class BaseIndividual(FitnessMixin, metaclass=MetaContainer): diff --git a/docs/build/_sources/source/Release History.md.txt b/docs/build/_sources/source/Release History.md.txt index 4392a2f..14ea24e 100644 --- a/docs/build/_sources/source/Release History.md.txt +++ b/docs/build/_sources/source/Release History.md.txt @@ -4,6 +4,8 @@ - Give an example for "hybrid population", composed of populations and individuals - parallel computing, limited to computing the fitnesses parallely +- add class method `solve`, use `Population.solve` to get the solution in a convenient way, where `Population` is the class for any iterative algorithm. +- update the decorator for cache ## before v1.5 ? \ No newline at end of file diff --git a/docs/build/genindex.html b/docs/build/genindex.html index eff4b44..ce64e8e 100644 --- a/docs/build/genindex.html +++ b/docs/build/genindex.html @@ -370,6 +370,8 @@

C

  • cleared() (pyrimidine.individual.PhantomIndividual method)
  • clone() (pyrimidine.chromosome.NumpyArrayChromosome method) +
  • +
  • cmd (pyrimidine.deco.add_cache attribute)
  • compute_accelerate() (pyrimidine.gsa.GravitySearch method)
  • @@ -378,6 +380,8 @@

    C

  • config() (pyrimidine.learn.BaseEstimator class method)
  • @@ -399,8 +403,12 @@

    C