A Clustering under radius constraints algorithm using minimum dominating sets

These details have not been verified by PyPI

Project links

documentation

Project description

Radius Clustering

Radius clustering is a Python package that implements clustering under radius constraint based on the Minimum Dominating Set (MDS) problem. This problem is NP-Hard but has been studied in the literature and proven to be linked to the clustering under radius constraint problem (see references for more details).

Features

Implements both exact and approximate MDS-based clustering algorithms
Compatible with scikit-learn's API for clustering algorithms
Supports radius-constrained clustering
Provides options for exact and approximate solutions
Easy to use and integrate with existing Python data science workflows
Includes comprehensive documentation and examples
Full test coverage to ensure reliability and correctness
Supports custom MDS solvers for flexibility in clustering approaches
Provides a user-friendly interface for clustering tasks

[!CAUTION] Deprecation Notice: The threshold parameter in the RadiusClustering class has been deprecated. Please use the radius parameter instead for specifying the radius for clustering. It is planned to be completely removed in version 2.0.0. The radius parameter is now the standard way to define the radius for clustering, aligning with our objective of making the parameters' name more intuitive and user-friendly.

[!NOTE] NEW VERSIONS: The package is currently under active development for new features and improvements, including some refactoring and enhancements to the existing codebase. Backwards compatibility is not guaranteed, so please check the CHANGELOG for details on changes and updates.

Roadmap

Version 1.4.0:
- Add support for custom MDS solvers
- Improve documentation and examples
- Add more examples and tutorials

Installation

You can install Radius Clustering using pip:

pip install radius-clustering

Usage

Here's a basic example of how to use Radius Clustering:

import numpy as np
from radius_clustering import RadiusClustering

# Example usage
X = np.random.rand(100, 2)  # Generate random data

# Create an instance of MdsClustering
rad_clustering = RadiusClustering(manner="approx", radius=0.5)

# Fit the model to the data
rad_clustering.fit(X)

# Get cluster labels
labels = rad_clustering.labels_

print(labels)

Documentation

You can find the full documentation for Radius Clustering here.

Building the documentation

To build the documentation, you can run the following command, assuming you have all dependencies needed installed:

cd docs
make html

Then you can open the index.html file in the build directory to view the full documentation.

More information

For more information please refer to the official documentation.

If you want insights on how the algorithm works, please refer to the presentation.

If you want to know more about the experiments conducted with the package, please refer to the experiments.

Contributing

Contributions to Radius Clustering are welcome!

Please read the CONTRIBUTING.md file for details on how to contribute to the project. Please note that the project is released with a Code of Conduct, and we expect all contributors to adhere to it.

License

This project is licensed under the GNU General Public License v3.0 - see the LICENSE file for details.

How to cite this work

If you use Radius Clustering in your research, please cite the following paper and the software itself:

@inproceedings{haenn_clustering2024,
  TITLE = {{Clustering Under Radius Constraints Using Minimum Dominating Sets}},
  AUTHOR = {Haenn, Quentin and Chardin, Brice and Baron, Micka{\"e}l},
  URL = {https://hal.science/hal-04533921},
  BOOKTITLE = {{Lecture Notes in Artificial Intelligence}},
  ADDRESS = {Poitiers, France},
  PUBLISHER = {{Springer}},
  YEAR = {2024},
  MONTH = Jun,
  KEYWORDS = {Constrained Clustering ; Radius Based Clustering ; Minimum Dominating Set ; Constrained Clustering Radius Based Clustering Minimum Dominating Set},
  PDF = {https://hal.science/hal-04533921v1/file/clustering_under_radius_using_mds.pdf},
  HAL_ID = {hal-04533921},
  HAL_VERSION = {v1},
}

Acknowledgments

MDS Algorithms

The two MDS algorithms implemented are forked and modified (or rewritten) from the following authors:

Alejandra Casado for the minimum dominating set heuristic code [1]. We rewrote the code in C++ to adapt to the need of python interfacing.
Hua Jiang for the minimum dominating set exact algorithm code [2]. The code has been adapted to the need of python interfacing.

Funders

The Radius Clustering work has been funded by:

LIAS, ISAE-ENSMA
LabCom @lienor and the French National Research Agency

Contributors

Quentin Haenn (core developer), LIAS, ISAE-ENSMA
Brice Chardin, LIAS, ISAE-ENSMA
Mickaël Baron, LIAS, ISAE-ENSMA

References

Project details

These details have not been verified by PyPI

Project links

documentation

Release history Release notifications | RSS feed

This version

1.4.2

Jul 7, 2025

1.4.1

Jul 2, 2025

1.4.0

Jun 19, 2025

1.3.0

Jun 18, 2025

1.2.2

Mar 11, 2025

1.2.1

Feb 27, 2025

1.1.0

Feb 19, 2025

1.0.0

Dec 2, 2024

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

radius_clustering-1.4.2.tar.gz (221.5 kB view details)

Uploaded Jul 7, 2025 Source

Built Distributions

radius_clustering-1.4.2-cp313-cp313-win_amd64.whl (288.7 kB view details)

Uploaded Jul 7, 2025 CPython 3.13Windows x86-64

radius_clustering-1.4.2-cp313-cp313-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (846.4 kB view details)

Uploaded Jul 7, 2025 CPython 3.13manylinux: glibc 2.17+ x86-64

radius_clustering-1.4.2-cp313-cp313-macosx_11_0_arm64.whl (283.2 kB view details)

Uploaded Jul 7, 2025 CPython 3.13macOS 11.0+ ARM64

radius_clustering-1.4.2-cp313-cp313-macosx_10_13_x86_64.whl (285.8 kB view details)

Uploaded Jul 7, 2025 CPython 3.13macOS 10.13+ x86-64

radius_clustering-1.4.2-cp312-cp312-win_amd64.whl (290.4 kB view details)

Uploaded Jul 7, 2025 CPython 3.12Windows x86-64

radius_clustering-1.4.2-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (854.0 kB view details)

Uploaded Jul 7, 2025 CPython 3.12manylinux: glibc 2.17+ x86-64

radius_clustering-1.4.2-cp312-cp312-macosx_11_0_arm64.whl (284.7 kB view details)

Uploaded Jul 7, 2025 CPython 3.12macOS 11.0+ ARM64

radius_clustering-1.4.2-cp312-cp312-macosx_10_13_x86_64.whl (287.2 kB view details)

Uploaded Jul 7, 2025 CPython 3.12macOS 10.13+ x86-64

radius_clustering-1.4.2-cp311-cp311-win_amd64.whl (289.0 kB view details)

Uploaded Jul 7, 2025 CPython 3.11Windows x86-64

radius_clustering-1.4.2-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (840.3 kB view details)

Uploaded Jul 7, 2025 CPython 3.11manylinux: glibc 2.17+ x86-64

radius_clustering-1.4.2-cp311-cp311-macosx_11_0_arm64.whl (284.3 kB view details)

Uploaded Jul 7, 2025 CPython 3.11macOS 11.0+ ARM64

radius_clustering-1.4.2-cp311-cp311-macosx_10_9_x86_64.whl (287.2 kB view details)

Uploaded Jul 7, 2025 CPython 3.11macOS 10.9+ x86-64

radius_clustering-1.4.2-cp310-cp310-win_amd64.whl (288.8 kB view details)

Uploaded Jul 7, 2025 CPython 3.10Windows x86-64

radius_clustering-1.4.2-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (823.2 kB view details)

Uploaded Jul 7, 2025 CPython 3.10manylinux: glibc 2.17+ x86-64

radius_clustering-1.4.2-cp310-cp310-macosx_11_0_arm64.whl (284.2 kB view details)

Uploaded Jul 7, 2025 CPython 3.10macOS 11.0+ ARM64

radius_clustering-1.4.2-cp310-cp310-macosx_10_9_x86_64.whl (287.2 kB view details)

Uploaded Jul 7, 2025 CPython 3.10macOS 10.9+ x86-64

radius_clustering-1.4.2-cp39-cp39-win_amd64.whl (289.1 kB view details)

Uploaded Jul 7, 2025 CPython 3.9Windows x86-64

radius_clustering-1.4.2-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (822.3 kB view details)

Uploaded Jul 7, 2025 CPython 3.9manylinux: glibc 2.17+ x86-64

radius_clustering-1.4.2-cp39-cp39-macosx_11_0_arm64.whl (284.5 kB view details)

Uploaded Jul 7, 2025 CPython 3.9macOS 11.0+ ARM64

radius_clustering-1.4.2-cp39-cp39-macosx_10_9_x86_64.whl (287.5 kB view details)

Uploaded Jul 7, 2025 CPython 3.9macOS 10.9+ x86-64

File details

Details for the file radius_clustering-1.4.2.tar.gz.

File metadata

Download URL: radius_clustering-1.4.2.tar.gz
Upload date: Jul 7, 2025
Size: 221.5 kB
Tags: Source
Uploaded using Trusted Publishing? Yes
Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for radius_clustering-1.4.2.tar.gz
Algorithm	Hash digest
SHA256	`67eb4ece37508d5eab49befa7fb2bd9ef215f61fe7acf447e63c1eda1bd7a4ae`
MD5	`9f2561948c3d19fb0c81465a75381e9c`
BLAKE2b-256	`0694cffa5d9e1027d10e1978848892c693f1e5793b66735da7544997b7e40dad`

Algorithm	Hash digest
SHA256	`9ab43b1bd9051446e4dda7aa31fd5ed3c02185f47d9d76122701869152f6056c`
MD5	`880d738ddf39dba2cfbff0eaaae3de65`
BLAKE2b-256	`e9f4a488236e4b4115bb752cdefeadef07a62c98c1cd2f790fcc510c1bef9eaf`

Algorithm	Hash digest
SHA256	`29f2e2fc141bde9cf0250eb48397f31e5b265d9f0f35905bfa28c171f888381f`
MD5	`4aed8fc7ad6f3d3c84e78f14a5d12565`
BLAKE2b-256	`337c1cc09cf09ad559b8792d7cd0022c32a467f62118dda0b553ce6369cefc42`

Algorithm	Hash digest
SHA256	`b55306f2f0520d7dddbc49e364e98b2ddd4b9f1c594d7771c687e82f0a4066e4`
MD5	`1d5af6dbf9094607729ec8929757170d`
BLAKE2b-256	`45d52c4e67ec77796057dfe2cb466c5e3fa04cdfba5a478a46f3b581196495d4`

Algorithm	Hash digest
SHA256	`a3faccb79e32ee1b82259621d4a1c79b3a04bfad504665969d7912ebab89483e`
MD5	`78c4357ba92f89733043d65824996ed2`
BLAKE2b-256	`95ff5eaa49d47398eec0ee680fe279ff833015a1ecc525c0c50af2564b91ea71`

Algorithm	Hash digest
SHA256	`d6c71aa6731df983720c98e1b6e22faaaa817dd33ceb57cc30d1a01086bf9855`
MD5	`2e181fe6669a902637e2689cdcb3010e`
BLAKE2b-256	`79ba4aa19da4435bf825f69f63982a9149795c4f3896589c88fa22cd7581237a`

Algorithm	Hash digest
SHA256	`17f472fa8725664a67a0a3a86d1ac69e77273647e55a49289ae548670ebc6e78`
MD5	`62bd94387c9a1bb0325a1ef17d981cd2`
BLAKE2b-256	`47f93a2b5d54964da4eba10f191131396b96fb8b7dfcbad32e5ad586bda4b691`

Algorithm	Hash digest
SHA256	`39d148a02efc05fb47414bec20f6a45c385a474ab35b965f0f82567ff96b1d47`
MD5	`646d46aa067408b423e10c4bb1a7038b`
BLAKE2b-256	`cefd57040ca328f6f08ee701773b7f43cc138a10ecedade68d001e17bc8506bc`

Algorithm	Hash digest
SHA256	`6efc1c0bd4ceed7de2e568da4bc598c29c4d701f4755f24e1c78fd0004c90c20`
MD5	`7e0321590897395aa8c64f9fcdec2015`
BLAKE2b-256	`56a6fbd8fedc1c827ade123c3f7d01a57ec1d864e572aae4351a16820564580a`

Algorithm	Hash digest
SHA256	`a9e67dad8d1a99bbaa07986c048fed0ca0109c3f7f4da82c7448d586c9e210e3`
MD5	`22c41780765d00aeb2fe3b4b61ab800b`
BLAKE2b-256	`b4d188986904ba3fbdd5c33ce4e7c406692c64ab462cf656be4f997171b4a8d2`

Algorithm	Hash digest
SHA256	`980603b9baba388aa2821f8bad1badb6da050bb84759625a114a6789ea380cd7`
MD5	`f63f4f072514459be52547bc716c1346`
BLAKE2b-256	`dd0ae40b7fd3f4ce4cef8f446e45dbf8d7ef4c76e6aebff5a6495fa1bb4f8188`

Algorithm	Hash digest
SHA256	`6fee296dd7f5d288d3980282b6e9d56cf64d4ce00332fb320c2eaf09ce8327fd`
MD5	`5759017232f0fd4e1757203535b27652`
BLAKE2b-256	`59df6def0156e174674bf2b8a73ffa0f94b936d27ca57d16074732eb59c4ac4b`

Algorithm	Hash digest
SHA256	`3e4eb6e3982925fed9c228c15c7b0844e7329da76648ac9e48268053e565f7dc`
MD5	`85cd058c1e3c657c5ab8480bdb901f67`
BLAKE2b-256	`feca747115c4b3a93c113e00cfb874b6e65c162410eb0406741f44d12c52ac4e`

Algorithm	Hash digest
SHA256	`fb0f20ae2ff794b7fc810d896f1e1bbcf388c9de4f16f1c4fce9354a816d24db`
MD5	`617b439e30c08be4322ad848fabb7904`
BLAKE2b-256	`3d8e8e48b422ab31eda5b1639e0324172e8e2102fd13aa88246abd7223c49eb3`

Algorithm	Hash digest
SHA256	`575fd687860f863fccad57ce9fa5031c30d6693ef36993eb12f4d41b16ba3d64`
MD5	`de51fe6ba013895a2b192f294dec4920`
BLAKE2b-256	`14a60cdebce5545f0a9ec71278e00acb6d465e3cf44c0c3e78ff903ceae1f573`

Algorithm	Hash digest
SHA256	`25b6541883245fbb3d8eb301fafc7d732e688360c7f2aed68d2454ae0bed250d`
MD5	`d04e51fefa0934b5f34a7c5bc6b21388`
BLAKE2b-256	`cdb2714ad85544cfc9de724c23c9dae26baee78c1d97bc1b2eda88c606498203`

Algorithm	Hash digest
SHA256	`73528da12b0dfc10729f215926eb01ffbd41e1ffa941d83e08505cd3b04021b9`
MD5	`b288a7845de3c6680c10db1017558735`
BLAKE2b-256	`2a4de3ee4443944131c45b9798cae0113ac57b022e9905a687b90fbc2f2b1032`

Algorithm	Hash digest
SHA256	`f4fe6aef61465c19a040b4b22e8835be724ab391d5c4d8f627c5c6c9701bf4eb`
MD5	`c65d566f1d1a79e48f5665deb4084cf1`
BLAKE2b-256	`9b26f0853d8c23a4c776f58571874b978a0b68f351db7d28eddcf54e40db91fa`

Algorithm	Hash digest
SHA256	`99d431d447454b1d4d0c8f4b2f0b8f0431407db8f835214fc038a128c272b58f`
MD5	`9091d4a22fa27c9efc436079a052dba8`
BLAKE2b-256	`59d727ecff504331ca30389fc69b7d71f973841bbe3e8c7bbdd49faf54afac8d`

Algorithm	Hash digest
SHA256	`c34abe81db177c2c1b777a84763e8ee8b38b7ba45d67ddd468dedd7a8f9575af`
MD5	`e8a65d0840b04efa3dff6357d38b5ee7`
BLAKE2b-256	`60b850cb51d2ac2789efa312dc46c2e13816a618e9d0869a5bfa24312e4e2a9c`

Algorithm	Hash digest
SHA256	`84fd906447dd529b5dab98f40dc8618dff6e334dd1bcd79edaa3b2fac3e802b7`
MD5	`10e4c735836a8e8e83b6a1a5be34c64e`
BLAKE2b-256	`8ce34374dffb3adeb73a2e885ec80b3e1f5640ff30443138a598432218f18a36`

radius-clustering 1.4.2

Navigation

Verified details

Project links

GitHub Statistics

Maintainers

Unverified details

Project links

Meta

Classifiers

Project description

Radius Clustering

Features

Roadmap

Installation

Usage

Documentation

Building the documentation

More information

Contributing

License

How to cite this work

Acknowledgments

MDS Algorithms

Funders

Contributors

References

Project details

Verified details

Project links

GitHub Statistics

Maintainers

Unverified details

Project links

Meta

Classifiers

Release history Release notifications | RSS feed

Download files

Source Distribution

Built Distributions

File details

File metadata

File hashes

Provenance

File details

File metadata

File hashes

Provenance

File details

File metadata

File hashes

Provenance

File details

File metadata

File hashes

Provenance

File details

File metadata

File hashes

Provenance

File details

File metadata

File hashes

Provenance

File details

File metadata

File hashes

Provenance

File details

File metadata

File hashes

Provenance

File details

File metadata

File hashes

Provenance

File details

File metadata

File hashes

Provenance