Metadata-Version: 2.1
Name: pyriad
Version: 0.0.9
Summary: Clustering with nature inspired algorithms
Home-page: https://github.com/PyNature/pyriad
Author: Teodor Scorpan
Author-email: teodor.scorpan@gmail.com
License: UNKNOWN
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3.6
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown

# Clustering with nature inspired algorithms

[![Codacy Badge](https://api.codacy.com/project/badge/Grade/2ba4116c451c4893b225d0bebbc306c8)](https://app.codacy.com/app/PyNature/pyriad?utm_source=github.com&utm_medium=referral&utm_content=PyNature/pyriad&utm_campaign=Badge_Grade_Dashboard)
[![Build Status](https://api.travis-ci.org/pynature/pyriad.svg?branch=master)](https://travis-ci.org/pynature/pyriad)
[![Version](https://img.shields.io/pypi/v/pyriad.svg?style=flat)](https://pypi.org/project/pyriad/#history)
[![PyPI downloads](https://img.shields.io/pypi/dm/pyriad.svg?style=flat)](https://pypi.org/project/pyriad/#files)
![License](https://img.shields.io/pypi/l/pyriad.svg?style=flat)

`pyriad` offers clustering with a variety of nature inspired algorithms built with Python on top of the deep learning library [PyTorch](https://pytorch.org/).

You can extend `pyriad` according to your own needs. You can implement custom algorithms by extending simple abstract classes.
Pyriad is highly parallelizable and transferable to GPU.

## Algorithms
As of today, the following algorithms have been implemented:

-   [x] Particle Swarm Optimization (PSO) 
-   [x] Cuckoo Search (CS)
-   [x] Grey Wolf Optimization (GWO)
-   [ ] Flower Pollination Algorithm (FP)

## Installation

1.  Install PyTorch. You can find it here: [PyTorch](https://pytorch.org/)
2.  `pip install pyriad`

## Examples

You can find examples in `examples/` directory

You can also run examples: `python examples/pso_iris.py`

You might want to `export PYTHONPATH=/path/to/this/directory`

## Contribute

1.  Implement new algorithms
2.  Improve code design
3.  Improve comments and readme

