Skip to content

Commit ae8288e

Browse files
committed
Update docs
1 parent d088235 commit ae8288e

File tree

1 file changed

+12
-16
lines changed

1 file changed

+12
-16
lines changed

docs/pages/introduction.rst

Lines changed: 12 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
Introduction
22
############
33

4-
.. image:: https://img.shields.io/badge/release-1.0.0-yellow.svg?style=svg
4+
.. image:: https://img.shields.io/badge/release-1.0.1-yellow.svg?style=svg
55
:target: https://github.com/thieu1995/opfunu
66

77
.. image:: https://img.shields.io/pypi/wheel/gensim.svg?style=svg
@@ -20,19 +20,20 @@ Introduction
2020
:target: https://www.gnu.org/licenses/gpl-3.0
2121

2222

23-
This is my first open-source library written in python for optimization benchmark functions.
23+
OPFUNU is the largest python library for cutting-edge optimization problems (benchmark, mathematical, engineering, real-world). Contains all CEC competition functions from 2005, 2008, 2010, 2013, 2014, 2015, 2017, 2019, 2020, 2021, 2022. Besides, more than 300 traditional functions with different dimensions are implemented.
2424

25-
The current version 1.0.0 has 2 sub-packages including:
25+
The current version 1.0.1 has 3 sub-packages including:
2626

2727
1. name_based package: All functions sorted as order of the alphabet
2828
2. cec_based package: All CEC competition functions in years (2005, 2008, 2010, 2013, 2014, 2015, 2017, 2019, 2020, 2021, 2022)
29+
3. engineering_based package: All functions from some papers.
2930

3031

3132
If you see my code and data useful and use it, please cites my works here::
3233

3334
@software{thieu_nguyen_2020_3711682,
3435
author = {Nguyen Van Thieu},
35-
title = {A framework of Optimization Functions using Numpy (OpFuNu) for optimization problems},
36+
title = {Opfunu: A Python Library For Optimization Functions in Numpy},
3637
year = 2020,
3738
publisher = {Zenodo},
3839
url = {https://doi.org/10.5281/zenodo.3620960}
@@ -46,7 +47,7 @@ Install the [current PyPI release](https://pypi.python.org/pypi/opfunu):
4647

4748
This is a simple example::
4849

49-
pip install opfunu==1.0.0
50+
pip install opfunu==1.0.1
5051

5152
Or install the development version from GitHub::
5253

@@ -97,15 +98,10 @@ References
9798

9899
References::
99100

100-
1. dimension_based references
101-
1. http://benchmarkfcns.xyz/fcns
102-
2. https://en.wikipedia.org/wiki/Test_functions_for_optimization
103-
3. https://www.cs.unm.edu/~neal.holts/dga/benchmarkFunction/
104-
4. http://www.sfu.ca/~ssurjano/optimization.html
101+
1. http://benchmarkfcns.xyz/fcns
102+
2. https://en.wikipedia.org/wiki/Test_functions_for_optimization
103+
3. https://www.cs.unm.edu/~neal.holts/dga/benchmarkFunction/
104+
4. http://www.sfu.ca/~ssurjano/optimization.html
105+
5. A Literature Survey of Benchmark Functions For Global Optimization Problems (2013)
106+
6. Problem Definitions and Evaluation Criteria for the CEC 2014Special Session and Competition on Single Objective Real-Parameter Numerical Optimization
105107

106-
2. type_based
107-
A Literature Survey of Benchmark Functions For Global Optimization Problems (2013)
108-
109-
3. cec
110-
1. Problem Definitions and Evaluation Criteria for the CEC 2014
111-
2. Special Session and Competition on Single Objective Real-Parameter Numerical Optimization

0 commit comments

Comments
 (0)