Skip to content

Commit 6b14165

Browse files
committed
Update docs
1 parent d63f241 commit 6b14165

File tree

4 files changed

+15
-18
lines changed

4 files changed

+15
-18
lines changed

docs/source/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ Welcome to MEALPY's documentation!
22
==================================
33

44

5-
.. image:: https://img.shields.io/badge/release-2.5.3-yellow.svg
5+
.. image:: https://img.shields.io/badge/release-2.5.4-yellow.svg
66
:target: https://github.com/thieu1995/mealpy/releases
77

88
.. image:: https://img.shields.io/pypi/wheel/gensim.svg

docs/source/pages/general/introduction.rst

Lines changed: 10 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Introduction
66
* MEALPY (MEta-heuristic ALgorithms in PYthon) is the largest Python module for the most cutting-edge nature-inspired meta-heuristic algorithms and is
77
distributed under the GNU General Public License (GPL) V3 license.
88

9-
* Current version: 2.5.1, Total algorithms: 172 (102 original, 45 official variants, 25 developed variants)
9+
* Current version: 2.5.4, Total algorithms: 209 (129 original, 46 official variants, 34 developed variants)
1010

1111
* Different versions of mealpy in term of passing hyper-parameters. So please careful check your version before using this library (Check `All releases`_)
1212
* mealpy < 1.0.5
@@ -36,23 +36,19 @@ distributed under the GNU General Public License (GPL) V3 license.
3636
.. _Issues ticket: https://github.com/thieu1995/mealpy/issues
3737

3838

39+
* And please give us credits if you use this library, check some of my `previous paper`_. ::
3940

40-
* And please give us some credits if you use this library, check some of my `previous paper`_.
41+
@article{van2023mealpy,
42+
title={MEALPY: An open-source library for latest meta-heuristic algorithms in Python},
43+
author={Van Thieu, Nguyen and Mirjalili, Seyedali},
44+
journal={Journal of Systems Architecture},
45+
year={2023},
46+
publisher={Elsevier},
47+
doi={10.1016/j.sysarc.2023.102871}
48+
}
4149

4250
.. _previous paper: https://gist.github.com/thieu1995/2dcebc754bf0038d0c12b26ec9d591aa
4351

44-
::
45-
46-
@software{nguyen_van_thieu_2022_6684223,
47-
author = {Nguyen Van Thieu and Seyedali Mirjalili},
48-
title = {{MEALPY: a Framework of The State-of-The-Art Meta-Heuristic Algorithms in Python}},
49-
month = jun,
50-
year = 2022,
51-
publisher = {Zenodo},
52-
version = {v2.5.0},
53-
doi = {10.5281/zenodo.6684223},
54-
url = {https://doi.org/10.5281/zenodo.6684223}
55-
}
5652

5753
------------
5854
Optimization

docs/source/pages/general/simple_guide.rst

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Simple Guide
44

55
In this phase, the main task is to find out the global optimal - in this project, we call it named *model* for simple. We designed the classical as well as
66
the state-of-the-art population-based meta-heuristics models: `Evolutionary-based`_, `Swarm-based`_, `Physics-based`_, `Human-based`_, `Biology-based`_,
7-
`Mathematical-based`_, `Musical-based`_
7+
`Mathematical-based`_, `Musical-based`_, and `System-based`_
88

99
.. _Evolutionary-based: ../models/mealpy.evolutionary_based.html
1010
.. _Swarm-based: ../models/mealpy.swarm_based.html
@@ -13,6 +13,7 @@ the state-of-the-art population-based meta-heuristics models: `Evolutionary-base
1313
.. _Biology-based: ../models/mealpy.bio_based.html
1414
.. _Mathematical-based: ../models/mealpy.math_based.html
1515
.. _Musical-based: ../models/mealpy.music_based.html
16+
.. _System-based: ../models/mealpy.system_based.html
1617

1718
All of this methods are used in the same way. So, in this guide, we'll demo with a specific method such as **Genetic Algorithm** in *Evolutionary-based*.
1819

@@ -25,7 +26,7 @@ Installation
2526

2627
Install the `current PyPI release`_. ::
2728

28-
$ pip install mealpy==2.5.3
29+
$ pip install mealpy==2.5.4
2930

3031
.. _current PyPI release: https://pypi.python.org/pypi/mealpy
3132

docs/source/pages/support.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ Official Links
4242
* Examples with different meapy version: https://github.com/thieu1995/mealpy/blob/master/EXAMPLES.md
4343
* Official chat/support group: https://t.me/+fRVCJGuGJg1mNDg1
4444

45-
* This project also related to our another projects which are "meta-heuristics" and "neural-network", check it here
45+
* This project also related to our another projects which are "meta-heuristics" and "machine learning", check it here:
4646
* https://github.com/thieu1995/opfunu
4747
* https://github.com/thieu1995/metaheuristics
4848
* https://github.com/thieu1995/enoppy

0 commit comments

Comments
 (0)