A modern, comprehensive and GPU-accelerated PyTorch implementation of Self-Organizing Maps for scalable ML workflows
π Paper | π Documentation | π Quick Start | π Examples | π€ Contributing
β If you find torchsom valuable, please consider starring this repository β
Self-Organizing Maps (SOMs) remain highly relevant in modern machine learning (ML) due to their interpretability, topology preservation, and computational efficiency. They excel and are widely used in domains such as energy systems, biology, internet of things (IoT), environmental science, and industrial applications.
Despite their utility, the SOM ecosystem is fragmented. Existing implementations are often outdated, unmaintained, and lack GPU acceleration or modern deep learning (DL) framework integration, limiting adoption and scalability.
torchsom addresses these gaps as a reference PyTorch library for SOMs. It provides:
- GPU-accelerated training
- Advanced clustering capabilities
- A scikit-learn-style API for ease of use
- Rich visualization tools
- Robust software engineering practices
torchsom enables researchers and practitioners to integrate SOMs seamlessly into workflows, from exploratory data analysis to advanced model architectures.
This library accompanies the paper: torchsom: The Reference PyTorch Library for Self-Organizing Maps. If you use torchsom in academic or industrial work, please cite both the paper and the software (see CITATION).
Note: See the comparison table below to understand how
torchsomdiffers from other SOM libraries, and explore our Visualization Gallery for example outputs.
Unlike legacy implementations, torchsom is engineered from the ground up for modern ML workflows:
| torchsom | MiniSom | SimpSOM | SOMPY | somoclu | som-pbc | |
|---|---|---|---|---|---|---|
| Architecture Section | ||||||
| Framework | PyTorch | NumPy | NumPy | NumPy | C++/CUDA | NumPy |
| GPU Acceleration | β CUDA | β | β CuPy/CUML | β | β CUDA | β |
| API Design | scikit-learn | Custom | Custom | MATLAB | Custom | custom |
| Development Quality Section | ||||||
| Maintenance | β Active | β Active | β | |||
| Documentation | β Rich | β | β | |||
| Test Coverage | β 90% | β | π ~53% | β | β | |
| PyPI Distribution | β | β | β | β | β | β |
| Functionality Section | ||||||
| Visualization | β Advanced | β | π Moderate | π Moderate | ||
| Clustering | β Advanced | β | β | β | β | β |
| JITL support | β Built-in | β | β | β | β | β |
| SOM Variants | π§ In development | β | π PBC | β | π PBC | π PBC |
| Extensibility | β High | π Moderate |
Note:
torchsomsupports Just-In-Time Learning (JITL). Given an online query, JITL collects relevant datapoints to form a local buffer (selected first by topology, then by distance). A lightweight local model can then be trained on this buffer, enabling efficient supervised learning (regression or classification).
- Quick Start
- Tutorials
- Installation
- Documentation
- Citation
- Contributing
- Acknowledgments
- License
- Related Work and References
Get started with torchsom in just a few lines of code:
import torch
from torchsom.core import SOM
from torchsom.visualization import SOMVisualizer
# Create a 10x10 map for 3D input
som = SOM(x=10, y=10, num_features=3, epochs=50)
# Train SOM for 50 epochs on 1000 samples
X = torch.randn(1000, 3)
som.initialize_weights(data=X, mode="pca")
QE, TE = som.fit(data=X)
# Visualize results
visualizer = SOMVisualizer(som=som, config=None)
visualizer.plot_training_errors(quantization_errors=QE, topographic_errors=TE, save_path=None)
visualizer.plot_hit_map(data=X, batch_size=256, save_path=None)
visualizer.plot_distance_map(
save_path=None,
distance_metric=som.distance_fn_name,
neighborhood_order=som.neighborhood_order,
scaling="sum"
)Explore our comprehensive collection of Jupyter notebooks:
- π
iris.ipynb: Multiclass classification - π·
wine.ipynb: Multiclass classification - π
boston_housing.ipynb: Regression - β‘
energy_efficiency.ipynb: Multi-output regression - π―
clustering.ipynb: SOM-based clustering analysis
pip install torchsomgit clone https://github.com/michelin/TorchSOM.git
cd TorchSOM
python3.9 -m venv .torchsom_env
source .torchsom_env/bin/activate
pip install -e ".[all]"Comprehensive documentation is available at opensource.michelin.io/TorchSOM
If you use torchsom in your academic, research or industrial work, please cite both the paper and software:
@misc{berthier2025torchsom,
title={torchsom: The Reference PyTorch Library for Self-Organizing Maps},
author = {Berthier, Louis and Shokry, Ahmed and Moreaud, Maxime and Ramelet, Guillaume and Moulines, Eric},
year={2025},
eprint={2510.11147},
archivePrefix={arXiv},
primaryClass={stat.ML},
note={Preprint submitted to Journal of Machine Learning Research},
url={https://arxiv.org/abs/2510.11147}
}
@software{berthier2025torchsom_software,
author={Berthier, Louis},
title={torchsom: The Reference PyTorch Library for Self-Organizing Maps},
year={2025},
version={1.1.1},
url={https://github.com/michelin/TorchSOM},
note = {Documentation available at \url{https://opensource.michelin.io/TorchSOM/}}
}For more details, please refer to the CITATION file.
We welcome contributions from the community! See our Contributing Guide and Code of Conduct for details.
- GitHub Issues: Report bugs or request features
- Centre de MathΓ©matiques AppliquΓ©es (CMAP) at Γcole Polytechnique
- Manufacture FranΓ§aise des Pneumatiques Michelin for collaboration
- Giuseppe Vettigli for MiniSom inspiration
- The PyTorch team for the amazing framework
- Logo created using DALL-E
torchsom is licensed under the Apache License 2.0. See the LICENSE file for details.
- Kohonen, T. (2001). Self-Organizing Maps. Springer.
- MiniSom: Minimalistic Python SOM
- SimpSOM:Simple Self-Organizing Maps
- SOMPY: Python SOM library
- somoclu: Massively Parallel Self-Organizing Maps
- som-pbc: A simple self-organizing map implementation in Python with periodic boundary conditions
- SOM Toolbox: MATLAB implementation