NNSOM

User Guide

  • Installation
    • Requirements
    • Installing from PyPI
    • Installing from source
    • Optional dependencies
    • Verifying the installation
    • Getting help
  • Quick Start
    • Step 1 — Prepare your data
    • Step 2 — Choose the grid size
    • Step 3 — Initialize and train
    • Step 4 — Cluster the data
    • Step 5 — Visualize the map
    • Save and reload the trained model
    • Quality metrics

Tutorials

  • Tutorial
    • Iris Training
    • Training SOM
      • Save the trained model
    • Extract SOM Cluster Details
    • Error Analysis
    • Visualize the SOM
      • SOM Topology
    • Iris Plotting
      • Visualization
      • Data Preparation
      • Gray Hist
      • Color Hist
      • Basic Plots
      • Pie Chart
      • Stem Plot
      • Histogram
      • Box Plot
      • Violin Plot
      • Scatter Plot
      • Component Planes
    • Iris Post Training Analysis
      • Visualization
    • Data Preprocessing
    • Grey Hist
    • Color hist
    • Complex hit hist
    • Simple grid
    • Pie Chart
    • Stem Plot
    • Iris Interactive Plots
      • Introduction
      • Training
      • Data Preparation
        • Output:
      • Conclusion
    • Cupy Implementation
  • Cupy
    • Requirements
    • Usage
    • Benefits
    • Limitations
    • Automatic CuPy Detection
    • Conclusion

API Reference

  • API Reference
    • SOM — CPU Implementation
      • SOM
        • SOM.dimensions
        • SOM.numNeurons
        • SOM.pos
        • SOM.neuron_dist
        • SOM.w
        • SOM.sim_flag
        • SOM.quantization_error()
        • SOM.topological_error()
        • SOM.distortion_error()
      • Initialization and training
        • NNSOM.som.SOM.init_w
        • NNSOM.som.SOM.train
        • NNSOM.som.SOM.sim_som
      • Clustering
        • NNSOM.som.SOM.cluster_data
      • Quality metrics
        • NNSOM.som.SOM.quantization_error
        • NNSOM.som.SOM.topological_error
        • NNSOM.som.SOM.distortion_error
      • Persistence
        • NNSOM.som.SOM.save_pickle
        • NNSOM.som.SOM.load_pickle
    • SOMPlots — Visualization
      • SOMPlots
        • SOMPlots.dimensions
      • Constructor
        • NNSOM.plots.SOMPlots.__init__
      • Topology plots
        • NNSOM.plots.SOMPlots.plt_top
        • NNSOM.plots.SOMPlots.plt_top_num
      • Hit and distance maps
        • NNSOM.plots.SOMPlots.hit_hist
        • NNSOM.plots.SOMPlots.neuron_dist_plot
        • NNSOM.plots.SOMPlots.gray_hist
      • Cluster and class plots
        • NNSOM.plots.SOMPlots.cmplx_hit_hist
        • NNSOM.plots.SOMPlots.custom_cmplx_hit_hist
        • NNSOM.plots.SOMPlots.simple_grid
        • NNSOM.plots.SOMPlots.plt_nc
      • Color-coded and component maps
        • NNSOM.plots.SOMPlots.color_hist
        • NNSOM.plots.SOMPlots.plt_stem
        • NNSOM.plots.SOMPlots.plt_pie
        • NNSOM.plots.SOMPlots.plt_wgts
        • NNSOM.plots.SOMPlots.plt_histogram
        • NNSOM.plots.SOMPlots.plt_boxplot
        • NNSOM.plots.SOMPlots.plt_violin_plot
        • NNSOM.plots.SOMPlots.plt_scatter
        • NNSOM.plots.SOMPlots.component_positions
        • NNSOM.plots.SOMPlots.component_planes
        • NNSOM.plots.SOMPlots.weight_as_image
      • Interactive plot
        • NNSOM.plots.SOMPlots.plot
    • Utility Functions
      • Data normalization
        • NNSOM.utils.preminmax
      • Topology geometry
        • NNSOM.utils.calculate_positions
        • NNSOM.utils.distances
        • NNSOM.utils.normalize_position
        • NNSOM.utils.spread_positions
        • NNSOM.utils.get_hexagon_shape
        • NNSOM.utils.get_edge_shape
      • Coordinate transforms
        • NNSOM.utils.cart2pol
        • NNSOM.utils.pol2cart
        • NNSOM.utils.rotate_xy
      • Cluster data extraction
        • NNSOM.utils.get_cluster_data
        • NNSOM.utils.get_cluster_array
        • NNSOM.utils.get_cluster_avg
        • NNSOM.utils.count_classes_in_cluster
        • NNSOM.utils.cal_class_cluster_intersect
      • Class and label analysis
        • NNSOM.utils.closest_class_cluster
        • NNSOM.utils.majority_class_cluster
        • NNSOM.utils.get_perc_cluster
        • NNSOM.utils.get_color_labels
        • NNSOM.utils.get_edge_widths
      • Error and misclassification analysis
        • NNSOM.utils.get_ind_misclassified
        • NNSOM.utils.get_perc_misclassified
        • NNSOM.utils.get_conf_indices
        • NNSOM.utils.get_dominant_class_error_types
      • Miscellaneous
        • NNSOM.utils.flatten
        • NNSOM.utils.get_global_min_max
        • NNSOM.utils.create_buttons
        • NNSOM.utils.calculate_button_positions
    • SOMGpu — GPU Implementation
      • SOMGpu
        • SOMGpu.dimensions
        • SOMGpu.numNeurons
        • SOMGpu.pos
        • SOMGpu.neuron_dist
        • SOMGpu.w
        • SOMGpu.sim_flag
        • SOMGpu.output
        • SOMGpu.norm_func
        • SOMGpu.sub_som
        • SOMGpu.__init__()
        • SOMGpu.init_w()
        • SOMGpu.sim_som()
        • SOMGpu.train()
        • SOMGpu.quantization_error()
        • SOMGpu.topological_error()
        • SOMGpu.distortion_error()
        • SOMGpu.save_pickle()
        • SOMGpu.load_pickle()
        • SOMGpu._normalize_position()
        • SOMGpu._spread_positions()
        • SOMGpu._euclidean_distance()
        • SOMGpu._to_categorical()
      • Initialization and training
        • NNSOM.som_gpu.SOMGpu.init_w
        • NNSOM.som_gpu.SOMGpu.train
        • NNSOM.som_gpu.SOMGpu.sim_som
      • Clustering
        • NNSOM.som_gpu.SOMGpu.cluster_data
      • Quality metrics
        • NNSOM.som_gpu.SOMGpu.quantization_error
        • NNSOM.som_gpu.SOMGpu.topological_error
        • NNSOM.som_gpu.SOMGpu.distortion_error
      • Persistence
        • NNSOM.som_gpu.SOMGpu.save_pickle
        • NNSOM.som_gpu.SOMGpu.load_pickle

About

  • Changelog
    • 1.8.3 (2025)
    • 1.8.2 (2024)
    • 1.8.1 (2024)
    • 1.8.0 (2024)
  • Authors
    • Contributors
NNSOM
  • API Reference
  • View page source

API Reference

  • SOM — CPU Implementation
    • SOM
    • Initialization and training
    • Clustering
    • Quality metrics
    • Persistence
  • SOMPlots — Visualization
    • SOMPlots
    • Constructor
    • Topology plots
    • Hit and distance maps
    • Cluster and class plots
    • Color-coded and component maps
    • Interactive plot
  • Utility Functions
    • Data normalization
    • Topology geometry
    • Coordinate transforms
    • Cluster data extraction
    • Class and label analysis
    • Error and misclassification analysis
    • Miscellaneous
  • SOMGpu — GPU Implementation
    • SOMGpu
    • Initialization and training
    • Clustering
    • Quality metrics
    • Persistence
Previous Next

© Copyright 2024, Martin Hagan, Amir Jafari, Lakshmi Sravya Chalapati, Ei Tanaka.

Built with Sphinx using a theme provided by Read the Docs.