https://github.com/cn-tu/pysdoclust

clustering algorithm based on SDO

https://github.com/cn-tu/pysdoclust

Science Score: 26.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
  • DOI references
    Found 10 DOI reference(s) in README
  • Academic publication links
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (13.8%) to scientific vocabulary
Last synced: 10 months ago · JSON representation

Repository

clustering algorithm based on SDO

Basic Info
  • Host: GitHub
  • Owner: CN-TU
  • License: mit
  • Language: Python
  • Default Branch: main
  • Size: 32.6 MB
Statistics
  • Stars: 0
  • Watchers: 2
  • Forks: 0
  • Open Issues: 0
  • Releases: 0
Created over 3 years ago · Last pushed about 1 year ago
Metadata Files
Readme License

README.md

Sparse Data Observers (SDO) is an unsupervised learning approach developed to cover the need for fast, highly interpretable and intuitively parameterizable anomaly detection. Its extension, SDOclust, performs clustering while preserving the simplicity and applicability of the original approach.

SDO and SDOclust are powerful options when statistical estimates are representative and feature spaces conform distance-based analysis. Their main characteristics are: lightweight, intuitive, self-adjusted, noise- resistant, able to extract non-convex clusters (SDOclust), and built on robust parameters and interpretable models.

Feasibility and rapid integration into real-world applications are the core goals behind SDO and SDOclust, which can work on most data scenarios without parameter adjustment (simply using the default parameterization).

Installation and dependecies

sdo can be installed from PyPI using

    pip install sdoclust

or directly from our GitHub repository:

    pip install git+https://github.com/CN-TU/pysdoclust

sdo requires de following packages:

  • numpy
  • math
  • scipy
  • sklearn

By default, SDO uses distance.cdist (from the scipy package) for calculating point distances and distance matrices (default method or method="brute"). Instead, you can use approximate neighbor search with:

In such a case you will need to install the respective packages when calling SDO or SDOclust with method="faiss" or method="pynndescent", e.g.:

    import sdoclust as sdo
    mdl = sdo.SDO(method='faiss')

However, note that, rather than the dataset X, the dominant factor in searching is the set of observers O, which is typically within a few hundred to a few thousand data points. This means that the default "brute" method is going to obtain better accuracy with equivalent runtimes to "faiss" or "pynndescent". Therefore, these alternatives are suitable when setting pretty large values of k. For default or low, k use the default approach.

Examples of usage

SDO

    import numpy as np
    np.random.seed(1)

    # Generate data
    from sklearn import datasets
    x, y = datasets.make_circles(n_samples=5000, factor=0.3, noise=0.1)

    # SDO outlier scoring
    import sdoclust as sdo
    s = sdo.SDO().fit_predict(x)

    # plotting results
    import matplotlib.pyplot as plt
    fig = plt.figure()
    plt.scatter(x[:,0],x[:,1], s=10, cmap='coolwarm', c=s)
    plt.colorbar(ticks=[np.min(s), np.max(s)])
    plt.title('SDO outlierness scores')
    plt.show()

SDOclust

    import numpy as np
    np.random.seed(1)

    # Generate data
    from sklearn import datasets
    x, y = datasets.make_circles(n_samples=5000, factor=0.3, noise=0.1)

    # SDOclust clustering
    import sdoclust as sdo
    p = sdo.SDOclust().fit_predict(x)

    # plotting results
    import matplotlib.pyplot as plt
    fig = plt.figure()
    plt.scatter(x[:,0],x[:,1], s=10, cmap='coolwarm', c=p)
    plt.title('SDOclust clustering')
    plt.show()

Application notes

SDO and SDOclust obtain good performances without modifying the default parameterization in most applications, but may require adjustment in some cases: typically, when datasets have very few elements, when clusters are overlapping or in cases with many under-represented clusters.

Main SDO parameters are:

  • x, which establishes the number of closest observers to evaluate each data point.
  • qv, which sets a robust threshold for removing idle observers.
  • k, which fixes de number of observers in the model

    mdl = sdo.SDO(x=5, qv=0.3, k=500)
    

Additionally, SDOclust also incorporates:

  • zeta, which sets a trade-off between locality and globality for cutting-off graph edges thresholds.
  • chi, which defines the chi-closest observer of any given observer to decide cutting-off graph edges thresholds.
  • e sets the minimum number of observers that a cluster can have.

    mdl = sdo.SDOclust(zeta=0.6, chi=10, e=3)
    

[1] and [2] provide further explanations on SDO and SDOclust parameters. SDOclust with default parameters tend to find fundamental partitions, i.e. a low number of clusters. If your scenario contains many clusters, or you detect underclustering, try, for example, by increasing k and/or reducing chi.

Citation

If you use SDO or SDOclust in your research, please cite our publications:

SDO

[2] Iglesias, F., Zseby, T., Zimek, A., "Outlier Detection Based on Low Density Models," 2018 IEEE International Conference on Data Mining Workshops (ICDMW), Singapore, 2018, pp. 970-979, doi: 10.1109/ICDMW.2018.00140.,

    @INPROCEEDINGS{SDO2018,
        author    = {F{\'e}lix Iglesias and Tanja Zseby and Alexander Hartl and Arthur Zimek},
        booktitle={2018 IEEE International Conference on Data Mining Workshops (ICDMW)}, 
        title={Outlier Detection Based on Low Density Models}, 
        year={2018},
        volume={},
        number={},
        pages={970-979},
        doi={10.1109/ICDMW.2018.00140}} 
    }

SDOclust

[1] Iglesias, F., Zseby, T., Hartl, A., Zimek, A. (2023). SDOclust: Clustering with Sparse Data Observers. In: Pedreira, O., Estivill-Castro, V. (eds) Similarity Search and Applications. SISAP 2023. Lecture Notes in Computer Science, vol 14289. Springer, Cham. https://doi.org/10.1007/978-3-031-46994-7_16

    @InProceedings{SDOclust2023,
        title     = {SDOclust: Clustering with Sparse Data Observers},
        author    = {F{\'e}lix Iglesias and Tanja Zseby and Arthur Zimek},
        editor    = {{\'O}scar Pedreira and Vladimir Estivill-Castro",
        booktitle = {Similarity Search and Applications},
        year      = {2023},
        publisher = {Springer Nature Switzerland},
        address   = {Cham},
        pages     = {185--199},
        doi       = {https://doi.org/10.1007/978-3-031-46994-7\_16}
    }

Others

Owner

  • Name: CN Group, Institute of Telecommunications, TU Wien
  • Login: CN-TU
  • Kind: organization
  • Location: Vienna, Austria

Communication Networks Group, TU Wien

GitHub Events

Total
  • Push event: 9
Last Year
  • Push event: 9

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 42 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 0
  • Total versions: 6
  • Total maintainers: 1
pypi.org: sdoclust

outlier detection and clustering based on sparse data observers

  • Homepage: https://github.com/CN-TU/pysdoclust
  • Documentation: https://sdoclust.readthedocs.io/
  • License: MIT License Copyright (c) 2024 Félix Iglesias Vázquez Copyright (c) 2021 Dani El-Ayyass Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  • Latest release: 0.5.1
    published about 1 year ago
  • Versions: 6
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 42 Last month
Rankings
Dependent packages count: 9.6%
Average: 36.4%
Dependent repos count: 63.2%
Maintainers (1)
fiv
Last synced: 10 months ago