sompy-package


Namesompy-package JSON
Version 1.0.3 PyPI version JSON
download
home_pageNone
SummarySelf Organizing Maps Package
upload_time2024-09-02 13:43:48
maintainerNone
docs_urlNone
authorNone
requires_python>=3.8
licenseNone
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            SOMPY
-----

This repository was forked from the original repository at https://github.com/sevamoo/SOMPY to modify it in order to make the package installable via pip.

Changes
1. Changed package name to "sompy-package" to avoid conflict with already existing "sompy" package on PyPI
2. Refactored package replacing deprecated setup.py with pyproject.toml
3. Updated dependencies to include scikit-image
4. General code cleanup and formatting

WIP:
1. Upload package to PyPI

All of the following is the original README file from the creator of the repo.

-----

## Original README

A Python Library for Self Organizing Map (SOM)

As much as possible, the structure of SOM is similar to `somtoolbox` in Matlab. It has the following functionalities:

1. Only Batch training, which is faster than online training. It has parallel processing option similar to `sklearn` format and it speeds up the training procedure, but it depends on the data size and mainly the size of the SOM grid.I couldn't manage the memory problem and therefore, I recommend single core processing at the moment. But nevertheless, the implementation of the algorithm is carefully done for all those important matrix calculations, such as `scipy` sparse matrix and `numexpr` for calculation of Euclidean distance.
2. PCA (or RandomPCA (default)) initialization, using `sklearn` or random initialization.
3. component plane visualization (different modes).
4. Hitmap.
5. U-Matrix visualization.
6. 1-d or 2-d SOM with only rectangular, planar grid. (works well in comparison with hexagonal shape, when I was checking in Matlab with somtoolbox).
7. Different methods for function approximation and predictions (mostly using Sklearn).


### Dependencies:
SOMPY has the following dependencies:
- numpy
- scipy
- scikit-learn
- numexpr
- matplotlib
- pandas
- ipdb

### Installation:
```Python
python setup.py install
```


Many thanks to @sebastiandev, the library is now standardized in a pythonic tradition. Below you can see some basic examples, showing how to use the library.
But I recommend you to go through the codes. There are several functionalities already implemented, but not documented. I would be very happy to add your new examples here.

[Basic Example](https://gist.github.com/sevamoo/035c56e7428318dd3065013625f12a11)

### Citation

There is no published paper about this library. However if possible, please cite the library as follows:

```
@misc{moosavi2014sompy,
  title={SOMPY: A Python Library for Self Organizing Map (SOM)},
  author={Moosavi, V and Packmann, S and Vall{\'e}s, I},
  note={GitHub.[Online]. Available: https://github.com/sevamoo/SOMPY},
  year={2014}
}
```


For more information, you can contact me via sevamoo@gmail.com but please report an issue first.




Thanks a lot.
Best Vahid Moosavi

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "sompy-package",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": null,
    "keywords": null,
    "author": null,
    "author_email": "Stefano Tornelli <stefano.tornelli@outlook.com>",
    "download_url": "https://files.pythonhosted.org/packages/29/32/aa919c32c9834c84559c2d6df8b0e5f0f2e4335a968666876c1d0cce380a/sompy_package-1.0.3.tar.gz",
    "platform": null,
    "description": "SOMPY\r\n-----\r\n\r\nThis repository was forked from the original repository at https://github.com/sevamoo/SOMPY to modify it in order to make the package installable via pip.\r\n\r\nChanges\r\n1. Changed package name to \"sompy-package\" to avoid conflict with already existing \"sompy\" package on PyPI\r\n2. Refactored package replacing deprecated setup.py with pyproject.toml\r\n3. Updated dependencies to include scikit-image\r\n4. General code cleanup and formatting\r\n\r\nWIP:\r\n1. Upload package to PyPI\r\n\r\nAll of the following is the original README file from the creator of the repo.\r\n\r\n-----\r\n\r\n## Original README\r\n\r\nA Python Library for Self Organizing Map (SOM)\r\n\r\nAs much as possible, the structure of SOM is similar to `somtoolbox` in Matlab. It has the following functionalities:\r\n\r\n1. Only Batch training, which is faster than online training. It has parallel processing option similar to `sklearn` format and it speeds up the training procedure, but it depends on the data size and mainly the size of the SOM grid.I couldn't manage the memory problem and therefore, I recommend single core processing at the moment. But nevertheless, the implementation of the algorithm is carefully done for all those important matrix calculations, such as `scipy` sparse matrix and `numexpr` for calculation of Euclidean distance.\r\n2. PCA (or RandomPCA (default)) initialization, using `sklearn` or random initialization.\r\n3. component plane visualization (different modes).\r\n4. Hitmap.\r\n5. U-Matrix visualization.\r\n6. 1-d or 2-d SOM with only rectangular, planar grid. (works well in comparison with hexagonal shape, when I was checking in Matlab with somtoolbox).\r\n7. Different methods for function approximation and predictions (mostly using Sklearn).\r\n\r\n\r\n### Dependencies:\r\nSOMPY has the following dependencies:\r\n- numpy\r\n- scipy\r\n- scikit-learn\r\n- numexpr\r\n- matplotlib\r\n- pandas\r\n- ipdb\r\n\r\n### Installation:\r\n```Python\r\npython setup.py install\r\n```\r\n\r\n\r\nMany thanks to @sebastiandev, the library is now standardized in a pythonic tradition. Below you can see some basic examples, showing how to use the library.\r\nBut I recommend you to go through the codes. There are several functionalities already implemented, but not documented. I would be very happy to add your new examples here.\r\n\r\n[Basic Example](https://gist.github.com/sevamoo/035c56e7428318dd3065013625f12a11)\r\n\r\n### Citation\r\n\r\nThere is no published paper about this library. However if possible, please cite the library as follows:\r\n\r\n```\r\n@misc{moosavi2014sompy,\r\n  title={SOMPY: A Python Library for Self Organizing Map (SOM)},\r\n  author={Moosavi, V and Packmann, S and Vall{\\'e}s, I},\r\n  note={GitHub.[Online]. Available: https://github.com/sevamoo/SOMPY},\r\n  year={2014}\r\n}\r\n```\r\n\r\n\r\nFor more information, you can contact me via sevamoo@gmail.com but please report an issue first.\r\n\r\n\r\n\r\n\r\nThanks a lot.\r\nBest Vahid Moosavi\r\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "Self Organizing Maps Package",
    "version": "1.0.3",
    "project_urls": {
        "Homepage": "https://github.com/stefano-tornelli/SOMPY",
        "Issues": "https://github.com/stefano-tornelli/SOMPY/issues"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "13b3565af9c07a55580aeed2623e2d25bf4d08883afcff7d73e4f370848c5444",
                "md5": "d66eb32f03cbc1518cf8628427d1c4fe",
                "sha256": "d1cee41daec14a76ec0e4fb61521aec203dce049fd96996bae5cbb1a47f4894d"
            },
            "downloads": -1,
            "filename": "sompy_package-1.0.3-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "d66eb32f03cbc1518cf8628427d1c4fe",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 30832,
            "upload_time": "2024-09-02T13:43:46",
            "upload_time_iso_8601": "2024-09-02T13:43:46.998655Z",
            "url": "https://files.pythonhosted.org/packages/13/b3/565af9c07a55580aeed2623e2d25bf4d08883afcff7d73e4f370848c5444/sompy_package-1.0.3-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "2932aa919c32c9834c84559c2d6df8b0e5f0f2e4335a968666876c1d0cce380a",
                "md5": "7028bbe98786795318b3f762f6b77613",
                "sha256": "0151580a5e9288ea186262174101249ba32ac65875a15679356c2dc30d55182b"
            },
            "downloads": -1,
            "filename": "sompy_package-1.0.3.tar.gz",
            "has_sig": false,
            "md5_digest": "7028bbe98786795318b3f762f6b77613",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 25867,
            "upload_time": "2024-09-02T13:43:48",
            "upload_time_iso_8601": "2024-09-02T13:43:48.599936Z",
            "url": "https://files.pythonhosted.org/packages/29/32/aa919c32c9834c84559c2d6df8b0e5f0f2e4335a968666876c1d0cce380a/sompy_package-1.0.3.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-09-02 13:43:48",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "stefano-tornelli",
    "github_project": "SOMPY",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "sompy-package"
}
        
Elapsed time: 0.39845s