Skip to main content

Python micro framework for building nature-inspired algorithms.

Project description

Unix Build Status Windows Build status Coverage Status Scrutinizer Code Quality PyPI Version Documentation Status GitHub license

About

Nature-inspired algorithms are a very popular tool for solving optimization problems. Numerous variants of nature-inspired algorithms have been developed 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.

.github/imgs/NiaPyLogo.png

Mission

Our mission is to build a collection of nature-inspired algorithms and create a simple interface for managing the optimization process.
NiaPy will offer:
  • numerous benchmark functions implementations,

  • use of various nature-inspired algorithms without struggle and effort with a simple interface,

  • easy comparison between nature-inspired algorithms and

  • export of results in various formats (LaTeX, JSON, Excel).

Overview

Python micro framework for building nature-inspired algorithms.

The micro framework features following algorithms:

The following benchmark functions are included in NiaPy:

  • Ackley

  • Alpine

  • Alpine1

  • Alpine2

  • Chung Reynolds

  • Csendes

  • Griewank

  • Happy cat

  • Pintér

  • Qing

  • Quintic

  • Rastrigin

  • Ridge

  • Rosenbrock

  • Salomon

  • Schumer Steiglitz

  • Schwefel

  • Schwefel 2.21

  • Schwefel 2.22

  • Sphere

  • Step

  • Step2

  • Step3

  • Stepint

  • Styblinski-Tang

  • Sum Squares

  • Whitley

Setup

Requirements

  • Python 3.6+ (backward compatibility with 2.7.14)

  • Pip

Installation

Install NiaPy with pip (will be available soon):

$ pip install NiaPy

or directly from the source code:

$ git clone https://github.com/NiaOrg/NiaPy.git
$ cd NiaPy
$ python setup.py install

Usage

After installation, the package can imported:

$ python
>>> import NiaPy
>>> NiaPy.__version__

For more usage examples please look at examples folder.

Contributing

Open Source Helpers

We encourage you to contribute to NiaPy! Please check out the Contributing to NiaPy guide for guidelines about how to proceed.

Everyone interacting in NiaPy’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the NiaPy code of conduct.

Licence

This package is distributed under the MIT License. This license can be found online at http://www.opensource.org/licenses/MIT.

Disclaimer

This framework is provided as-is, and there are no guarantees that it fits your purposes or that it is bug-free. Use it at your own risk!

Revision History

0.1.2a4

  • fixes problem with build scripts

0.1.2a3

  • fixes PyPI project description

  • alpha3 version

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

NiaPy-0.1.2a4.tar.gz (41.5 kB view details)

Uploaded Source

Built Distribution

NiaPy-0.1.2a4-py3-none-any.whl (59.0 kB view details)

Uploaded Python 3

File details

Details for the file NiaPy-0.1.2a4.tar.gz.

File metadata

  • Download URL: NiaPy-0.1.2a4.tar.gz
  • Upload date:
  • Size: 41.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for NiaPy-0.1.2a4.tar.gz
Algorithm Hash digest
SHA256 a0abd65f96fdb6a53a8d50b09eb197f91f21583e6259ba68974eb049b58dd42e
MD5 9305b5d0ea3bda595e23cba69f3d6b6e
BLAKE2b-256 2e77e6c1e6270e6c57af8853bd75e7a024b5501244b75ed58f84bd5cf1e3e429

See more details on using hashes here.

File details

Details for the file NiaPy-0.1.2a4-py3-none-any.whl.

File metadata

File hashes

Hashes for NiaPy-0.1.2a4-py3-none-any.whl
Algorithm Hash digest
SHA256 36812157f004a618e1f2433e289417009e49513225a55bb1becbb4e3fe6877c0
MD5 abcce290804b112622556065305bf37c
BLAKE2b-256 afd945f1a4caf47f50fadfefdc6474c90e153823806a4591345ff96e2d732a1d

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page