Skip to main content

usmerge logo

Unsupervised Merge

PyPI version Python versions License Downloads GitHub last commit

A simple Python package for one-dimensional data clustering, implementing various clustering algorithms including traditional and novel approaches.

Installation

Install the package using pip:

pip install usmerge

Features

This package provides multiple one-dimensional clustering methods:

  • Equal Width Binning (equal_wid_merge)
  • Equal Frequency Binning (equal_fre_merge)
  • K-means Clustering (kmeans_merge)
  • SOM-K Clustering (som_k_merge)
  • Fuzzy C-Means (fcm_merge)
  • Kernel Density Based (kernel_density_merge)
  • Information Theoretic (information_merge)
  • Gaussian Mixture (gaussian_mixture_merge)
  • Hierarchical Density (hierarchical_density_merge)
  • Jenks Natural Breaks (jenks_breaks_merge)
  • Quantile-based (quantile_merge)
  • DBSCAN (dbscan_1d_merge)

Usage

Data Format

The package accepts various input formats:

  • pandas Series/DataFrame
  • numpy array
  • Python list/tuple
  • Any iterable of numbers

Basic Usage Examples

  1. Equal Width Binning:
from usmerge import equal_wid_merge
labels, edges = equal_wid_merge(data, n=3)
  1. Equal Frequency Binning:
from usmerge import equal_fre_merge
labels, edges = equal_fre_merge(data, n=3)
  1. K-means Clustering:
from usmerge import kmeans_merge
labels, edges = kmeans_merge(data, n=3, max_iter=100)

Advanced Usage

  1. SOM-K Clustering:
from usmerge import som_k_merge
labels, edges = som_k_merge(data, n=3, sigma=0.5, learning_rate=0.5, epochs=1000)
  1. Fuzzy C-Means:
from usmerge import fcm_merge
labels, edges = fcm_merge(data, n=3, m=2.0, max_iter=100, epsilon=1e-6)
  1. Kernel Density Based:
from usmerge import kernel_density_merge
labels, edges = kernel_density_merge(data, n=3, bandwidth=None)
  1. Jenks Natural Breaks:
from usmerge import jenks_breaks_merge
labels, edges = jenks_breaks_merge(data, n=3)
  1. Quantile-based Clustering:
from usmerge import quantile_merge
labels, edges = quantile_merge(data, n=3)
  1. DBSCAN Clustering:
from usmerge import dbscan_1d_merge
labels, edges = dbscan_1d_merge(data, n=3, min_samples=3)

Return Values

All clustering methods return two values:

  • labels: List of cluster labels for each data point
  • edges: List of cluster boundaries

Example Analysis

import numpy as np
import matplotlib.pyplot as plt
from usmerge import som_k_merge, fcm_merge, kmeans_merge, hierarchical_density_merge, dbscan_1d_merge

# Generate synthetic data with three clear clusters
np.random.seed(42)
data = np.concatenate([
    np.random.normal(0, 0.3, 50),    # First cluster
    np.random.normal(5, 0.4, 50),    # Second cluster
    np.random.normal(10, 0.3, 50)    # Third cluster
])

# Compare different clustering methods
methods = {
    'SOM-K': som_k_merge(data, n=3, sigma=0.5, learning_rate=0.5, epochs=1000),
    'FCM': fcm_merge(data, n=3, m=2.0, max_iter=100),
    'K-means': kmeans_merge(data, n=3),
    'DBSCAN': dbscan_1d_merge(data, n=3, min_samples=3),
    'Hierarchical Density': hierarchical_density_merge(data, n=3)
}

# Visualize results
plt.figure(figsize=(15, 5))
for i, (name, (labels, edges)) in enumerate(methods.items(), 1):
    plt.subplot(1, 5, i)
    plt.scatter(data, np.zeros_like(data), c=labels, cmap='viridis')
    plt.title(f'{name} Clustering')
    # Plot cluster boundaries
    for edge in edges:
        plt.axvline(x=edge, color='r', linestyle='--', alpha=0.5)
    plt.ylim(-0.5, 0.5)

plt.tight_layout()
plt.show()

Parameters Guide

Each clustering method has its own set of parameters:

  • SOM-K: sigma (neighborhood size), learning_rate (learning rate), epochs (iterations)
  • FCM: m (fuzziness), max_iter, epsilon (convergence threshold)
  • Kernel Density: bandwidth (kernel width)
  • Information Theoretic: alpha (compression-accuracy trade-off)
  • Gaussian Mixture: max_iter, epsilon (convergence threshold)
  • Hierarchical Density: min_cluster_size (minimum points per cluster)
  • Jenks Natural Breaks: Only requires number of clusters
  • Quantile-based: Only requires number of clusters
  • DBSCAN: n (target number of clusters), eps (optional neighborhood size), min_samples (minimum points in cluster), max_iter (maximum iterations for eps adjustment)

Contributing

Feel free to contribute to this project by submitting issues or pull requests.

License

MIT License

Metadata

Release files for usmerge 0.2.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for usmerge 0.2.1
File Size Uploaded
usmerge-0.2.1.tar.gz 13.1 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for usmerge 0.2.1
File Interpreter ABI Platform
usmerge-0.2.1-py3-none-any.whl Python 3 none any Details

Total release size: 23.8 kB

Release files / usmerge-0.2.1.tar.gz

Download URL usmerge-0.2.1.tar.gz
Size 13.1 kB
Tags Source
SHA-256 checksum
How to use checksums
893fc3d08a7f75ed682027829c5741b27e049cda2857f465d078377b8a3c3c1d
BLAKE2b-256 checksum
How to use checksums
40ce7351a633651c31ba33339dc31cb0bb26cd66536ea3c72a9de8183d541b7a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.1.1 CPython/3.9.6

Release files / usmerge-0.2.1-py3-none-any.whl

Download URL usmerge-0.2.1-py3-none-any.whl
Size 10.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
cb1856c69b610be0767758f85a2d6ff25ff0a2c125b7815d5d7b85f01ca96539
BLAKE2b-256 checksum
How to use checksums
f588d8c58ebdf577e97c2372253b7b6ce41a486d158b22ca27e3a7230c9eab0a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.1.1 CPython/3.9.6

Release history Release notifications | RSS feed

This release

0.2.1 This release

2 release files

0.2.0

2 release files

0.1.5

2 release files

0.1.4

2 release files

0.1.3

2 release files

0.1.2

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page