Warning - Attention Users

Please be aware that the pyclustering library is no longer supported as of 2021 due to personal reasons. There will be no further maintenance, issue addressing, or feature development for this repository.

For continued usage, I recommend seeking alternative solutions.

Thank you for your understanding.

Build Status

|Build Status Linux MacOS| |Build Status Win| |Coverage Status| |PyPi| |Download Counter| |JOSS|

PyClustering

pyclustering is a Python, C++ data mining library (clustering algorithm, oscillatory networks, neural networks). The library provides Python and C++ implementations (C++ pyclustering library) of each algorithm or model. C++ pyclustering library is a part of pyclustering and supported for Linux, Windows and MacOS operating systems.

Version: 0.11.dev

License: The 3-Clause BSD License

E-Mail: pyclustering@yandex.ru

Documentation: https://pyclustering.github.io/docs/0.10.1/html/

Homepage: https://pyclustering.github.io/

PyClustering Wiki: https://github.com/annoviko/pyclustering/wiki

Dependencies

Required packages: scipy, matplotlib, numpy, Pillow

Python version: >=3.6 (32-bit, 64-bit)

C++ version: >= 14 (32-bit, 64-bit)

Performance

Each algorithm is implemented using Python and C/C++ language, if your platform is not supported then Python implementation is used, otherwise C/C++. Implementation can be chosen by ccore flag (by default it is always 'True' and it means that C/C++ is used), for example:

.. code:: python

# As by default - C/C++ part of the library is used
xmeans_instance_1 = xmeans(data_points, start_centers, 20, ccore=True);

# The same - C/C++ part of the library is used by default
xmeans_instance_2 = xmeans(data_points, start_centers, 20);

# Switch off core - Python is used
xmeans_instance_3 = xmeans(data_points, start_centers, 20, ccore=False);

Installation

Installation using pip3 tool:

.. code:: bash

$ pip3 install pyclustering

Manual installation from official repository using Makefile:

.. code:: bash

# get sources of the pyclustering library, for example, from repository
$ mkdir pyclustering
$ cd pyclustering/
$ git clone https://github.com/annoviko/pyclustering.git .

# compile CCORE library (core of the pyclustering library).
$ cd ccore/
$ make ccore_64bit      # build for 64-bit OS

# $ make ccore_32bit    # build for 32-bit OS

# return to parent folder of the pyclustering library
$ cd ../

# install pyclustering library
$ python3 setup.py install

# optionally - test the library
$ python3 setup.py test

Manual installation using CMake:

.. code:: bash

# get sources of the pyclustering library, for example, from repository
$ mkdir pyclustering
$ cd pyclustering/
$ git clone https://github.com/annoviko/pyclustering.git .

# generate build files.
$ mkdir build
$ cmake ..

# build pyclustering-shared target depending on what was generated (Makefile or MSVC solution)
# if Makefile has been generated then
$ make pyclustering-shared

# return to parent folder of the pyclustering library
$ cd ../

# install pyclustering library
$ python3 setup.py install

# optionally - test the library
$ python3 setup.py test

Manual installation using Microsoft Visual Studio solution:

1. Clone repository from: https://github.com/annoviko/pyclustering.git
2. Open folder pyclustering/ccore
3. Open Visual Studio project ccore.sln
4. Select solution platform: x86 or x64
5. Build pyclustering-shared project.
6. Add pyclustering folder to python path or install it using setup.py

.. code:: bash

# install pyclustering library
$ python3 setup.py install

# optionally - test the library
$ python3 setup.py test

Proposals, Questions, Bugs

In case of any questions, proposals or bugs related to the pyclustering please contact to pyclustering@yandex.ru or create an issue here.

PyClustering Status

+----------------------+------------------------------+-------------------------------------+---------------------------------+ | Branch | master | 0.10.dev | 0.10.1.rel | +======================+==============================+=====================================+=================================+ | Build (Linux, MacOS) | |Build Status Linux MacOS| | |Build Status Linux MacOS 0.10.dev| | |Build Status Linux 0.10.1.rel| | +----------------------+------------------------------+-------------------------------------+---------------------------------+ | Build (Win) | |Build Status Win| | |Build Status Win 0.10.dev| | |Build Status Win 0.10.1.rel| | +----------------------+------------------------------+-------------------------------------+---------------------------------+ | Code Coverage | |Coverage Status| | |Coverage Status 0.10.dev| | |Coverage Status 0.10.1.rel| | +----------------------+------------------------------+-------------------------------------+---------------------------------+

Cite the Library

If you are using pyclustering library in a scientific paper, please, cite the library:

Novikov, A., 2019. PyClustering: Data Mining Library. Journal of Open Source Software, 4(36), p.1230. Available at: http://dx.doi.org/10.21105/joss.01230.

BibTeX entry:

.. code::

@article{Novikov2019,
    doi         = {10.21105/joss.01230},
    url         = {https://doi.org/10.21105/joss.01230},
    year        = 2019,
    month       = {apr},
    publisher   = {The Open Journal},
    volume      = {4},
    number      = {36},
    pages       = {1230},
    author      = {Andrei Novikov},
    title       = {{PyClustering}: Data Mining Library},
    journal     = {Journal of Open Source Software}
}

Brief Overview of the Library Content

Clustering algorithms and methods (module pyclustering.cluster):

+------------------------+---------+-----+ | Algorithm | Python | C++ | +========================+=========+=====+ | Agglomerative | ✓ | ✓ | +------------------------+---------+-----+ | BANG | ✓ | | +------------------------+---------+-----+ | BIRCH | ✓ | | +------------------------+---------+-----+ | BSAS | ✓ | ✓ | +------------------------+---------+-----+ | CLARANS | ✓ | | +------------------------+---------+-----+ | CLIQUE | ✓ | ✓ | +------------------------+---------+-----+ | CURE | ✓ | ✓ | +------------------------+---------+-----+ | DBSCAN | ✓ | ✓ | +------------------------+---------+-----+ | Elbow | ✓ | ✓ | +------------------------+---------+-----+ | EMA | ✓ | | +------------------------+---------+-----+ | Fuzzy C-Means | ✓ | ✓ | +------------------------+---------+-----+ | GA (Genetic Algorithm) | ✓ | ✓ | +------------------------+---------+-----+ | G-Means | ✓ | ✓ | +------------------------+---------+-----+ | HSyncNet | ✓ | ✓ | +------------------------+---------+-----+ | K-Means | ✓ | ✓ | +------------------------+---------+-----+ | K-Means++ | ✓ | ✓ | +------------------------+---------+-----+ | K-Medians | ✓ | ✓ | +------------------------+---------+-----+ | K-Medoids | ✓ | ✓ | +------------------------+---------+-----+ | MBSAS | ✓ | ✓ | +------------------------+---------+-----+ | OPTICS | ✓ | ✓ | +------------------------+---------+-----+ | ROCK | ✓ | ✓ | +------------------------+---------+-----+ | Silhouette | ✓ | ✓ | +------------------------+---------+-----+ | SOM-SC | ✓ | ✓ | +------------------------+---------+-----+ | SyncNet | ✓ | ✓ | +------------------------+---------+-----+ | Sync-SOM | ✓ | | +------------------------+---------+-----+ | TTSAS | ✓ | ✓ | +------------------------+---------+-----+ | X-Means | ✓ | ✓ | +------------------------+---------+-----+

Oscillatory networks and neural networks (module pyclustering.nnet):

+--------------------------------------------------------------------------------+---------+-----+ | Model | Python | C++ | +================================================================================+=========+=====+ | CNN (Chaotic Neural Network) | ✓ | | +--------------------------------------------------------------------------------+---------+-----+ | fSync (Oscillatory network based on Landau-Stuart equation and Kuramoto model) | ✓ | | +--------------------------------------------------------------------------------+---------+-----+ | HHN (Oscillatory network based on Hodgkin-Huxley model) | ✓ | ✓ | +--------------------------------------------------------------------------------+---------+-----+ | Hysteresis Oscillatory Network | ✓ | | +--------------------------------------------------------------------------------+---------+-----+ | LEGION (Local Excitatory Global Inhibitory Oscillatory Network) | ✓