Skip to content

Commit

Permalink
Merge pull request #265 from lucijabrezocnik/master
Browse files Browse the repository at this point in the history
reference added, small fixes
  • Loading branch information
lucijabrezocnik committed Jul 20, 2020
2 parents a135cc0 + 1b1b1bd commit 1582d1a
Show file tree
Hide file tree
Showing 4 changed files with 22 additions and 18 deletions.
2 changes: 1 addition & 1 deletion README.md
Expand Up @@ -26,7 +26,7 @@
[![DOI](http://joss.theoj.org/papers/10.21105/joss.00613/status.svg)](https://doi.org/10.21105/joss.00613)


Nature-inspired algorithms are a very popular tool for solving optimization problems. Numerous variants of [nature-inspired algorithms have been developed](https://arxiv.org/abs/1307.4186) since the beginning of their era. To prove their versatility, those were tested in various domains on various applications, especially when they are hybridized, modified or adapted. However, implementation of nature-inspired algorithms is sometimes a difficult, complex and tedious task. In order to break this wall, NiaPy is intended for simple and quick use, without spending time for implementing algorithms from scratch.
Nature-inspired algorithms are a very popular tool for solving optimization problems. Numerous variants of nature-inspired algorithms have been developed ([paper 1](https://arxiv.org/abs/1307.4186), [paper 2](https://www.mdpi.com/2076-3417/8/9/1521)) since the beginning of their era. To prove their versatility, those were tested in various domains on various applications, especially when they are hybridized, modified or adapted. However, implementation of nature-inspired algorithms is sometimes a difficult, complex and tedious task. In order to break this wall, NiaPy is intended for simple and quick use, without spending time for implementing algorithms from scratch.

* **Free software:** MIT license
* **Documentation:** https://niapy.readthedocs.io/en/stable/
Expand Down
4 changes: 2 additions & 2 deletions docs/source/api/index.rst
@@ -1,5 +1,5 @@
API
===
API Documentation
=================

This is the NiaPy API documentation, auto generated from the source code.

Expand Down
16 changes: 8 additions & 8 deletions docs/source/features.rst
Expand Up @@ -64,8 +64,8 @@ NiaPy features more than 30 benchmark functions. Documentation for them can be f

- Ackley
- Alpine
- Alpine1
- Alpine2
- Alpine1
- Alpine2
- Bent Cigar
- Chung Reynolds
- Csendes
Expand All @@ -89,14 +89,14 @@ NiaPy features more than 30 benchmark functions. Documentation for them can be f
- Salomon
- Schumer Steiglitz
- Schwefel
- Schwefel 2.21
- Schwefel 2.22
- Schwefel 2.21
- Schwefel 2.22
- Sphere
- Sphere2 -> Sphere with different powers
- Sphere3 -> Rotated hyper-ellipsoid
- Sphere2 -> Sphere with different powers
- Sphere3 -> Rotated hyper-ellipsoid
- Step
- Step2
- Step3
- Step2
- Step3
- Stepint
- Styblinski-Tang
- Sum Squares
Expand Down
18 changes: 11 additions & 7 deletions docs/source/index.rst
Expand Up @@ -11,15 +11,20 @@
NiaPy's documentation
=================================

.. image:: http://joss.theoj.org/papers/10.21105/joss.00613/status.svg
:target: https://doi.org/10.21105/joss.00613
:alt: Citation

.. automodule:: NiaPy

Nature-inspired algorithms are a very popular tool for solving optimization problems.
Since the beginning of their era, numerous variants of `nature-inspired algorithms were
developed <https://arxiv.org/abs/1307.4186>`_. To prove their versatility, those were
tested in various domains on various applications, especially when they are hybridized,
modified or adapted. However, implementation of nature-inspired algorithms is sometimes
difficult, complex and tedious task. In order to break this wall, NiaPy is intended for
simple and quick use, without spending a time for implementing algorithms from scratch.
Since the beginning of their era, numerous variants of nature-inspired algorithms were
developed (`paper 1 <https://arxiv.org/abs/1307.4186>`_, `paper 2 <https://www.mdpi.com/2076-3417/8/9/1521>`_).
To prove their versatility, those were tested in various domains on various applications,
especially when they are hybridized, modified or adapted. However, implementation of
nature-inspired algorithms is sometimes difficult, complex and tedious task. In order to break
this wall, NiaPy is intended for simple and quick use, without spending a time for
implementing algorithms from scratch.

* **Free software:** MIT license
* **Github repository:** https://github.com/NiaOrg/NiaPy
Expand Down Expand Up @@ -68,7 +73,6 @@ The main documentation is organized into a couple sections:
.. _api-docs:

.. toctree::
:maxdepth: 3
:caption: API Documentation

api/index

0 comments on commit 1582d1a

Please sign in to comment.