Skip to main content

Python package for unsupervised and supervised self-organizing maps (SOM)

Project description

Zenodo DOI Travis.CI Documentation Status

SUSI: SUpervised Self-organIzing maps in Python

Python package for unsupervised and supervised self-organizing maps (SOM)

Description

We present the SUSI package for Python. It includes a fully functional SOM for unsupervised and supervised tasks. The class structure is set up as follows:

  • SOMClustering: Unsupervised SOM for clustering

    • SOMEstimator: Base class for supervised SOMs

      • SOMRegressor: Regression SOM

      • SOMClassifier: Classification SOM

Paper:

Felix M. Riese and S. Keller, “SUSI: Supervised Self-Organizing Maps for Regression and Classification in Python”, 2019, Submitted to an ISPRS conference.

License:

3-Clause BSD license

Authors:

Felix M. Riese, Sina Keller

Citation:

see Citation and in the bibtex file

Documentation:

read the docs

Installation

With PyPi:

pip3 install susi

Manually:

git clone TODO
cd susi/
python setup.py install

Dependencies

Python 3 with:

  • joblib

  • numpy

  • scikit-learn

  • scipy

Usage

Regression in python3:

import susi

som = susi.SOMRegressor()
som.fit(X_train, y_train)
print(som.score(X_test, y_test))

Classification in python3:

import susi

som = susi.SOMClassifier()
som.fit(X_train, y_train)
print(som.score(X_test, y_test))

Code examples as Jupyter Notebooks:

Citation

The bibtex file including both references is available here.

Paper:

Felix M. Riese and S. Keller, “SUSI: Supervised Self-Organizing Maps for Regression and Classification in Python”, 2019, Submitted to an ISPRS conference.

@article{riesekeller2019susi,
    author = {Riese, Felix~M. and Keller, Sina},
    title = {SUSI: Supervised Self-Organizing Maps for Regression and Classification in Python},
    year = {2019},
    notes = {Submitted to an ISPRS conference},
}

Code:

Felix M. Riese, “SUSI: SUpervised Self-organIzing maps in Python”, [10.5281/zenodo.2609130](https://doi.org/10.5281/zenodo.2609130), 2019.

https://zenodo.org/badge/DOI/10.5281/zenodo.2609131.svg
@misc{riese2019susicode,
    author = {Riese, Felix~M.},
    title = {{SUSI: SUpervised Self-organIzing maps in Python}},
    year = {2019},
    DOI = {10.5281/zenodo.2609130},
    publisher = {Zenodo},
    howpublished = {\href{https://doi.org/10.5281/zenodo.2609130}{doi.org/10.5281/zenodo.2609130}}
}

Change Log

[1.0.1] - 2019-03-26 - [ADDED] Config file for Travis - [FIXED] Requirements for read-the-docs documentation

[1.0.0] - 2019-03-26 - Initial release

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

susi-1.0.1.zip (14.2 kB view hashes)

Uploaded Source

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