autogmm


Nameautogmm JSON
Version 0.1.0 PyPI version JSON
download
home_pageNone
SummaryAutomatic Gaussian Mixture Modeling in Python
upload_time2025-09-14 01:44:13
maintainerNone
docs_urlNone
authorTingshan Liu
requires_python>=3.9
licenseBSD 3-Clause License Copyright (c) YEAR, NeuroData All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
keywords clustering gmm mixture model selection
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # AutoGMM

Automatic Gaussian Mixture Modeling in Python.

### Install
``` bash
pip install autogmm
```

### Quick start
``` python
from autogmm import AutoGMM
from sklearn.datasets import make_blobs

X, _ = make_blobs(
                 n_samples=1000,
                 centers=4,
                 cluster_std=1.2,
                 random_state=0
)

labels = AutoGMM(
                 min_components=1,
                 max_components=10, # unknown K
                 criterion="bic",
                 random_state=0
).fit_predict(X)
```


### Features
- Initializations: KMeans, Ward–Euclidean, Ward–Mahalanobis

- EM with eigenvalue flooring and covariance constraints (spherical, diag, tied, full)

- Model selection via BIC/AIC (unknown *K*)

- Optional spectral front-end (ASE/LSE) for nonconvex structure

- Parallel evaluation, clean API, reproducible scripts



### Documentation
- API & Guides: https://github.com/neurodata/autogmm/
- Examples: [examples/](examples) (benchmarks; stress tests; runtime scaling)
- Reproducibility: [scripts/reproduce.sh](scripts/reproduce.sh) (regenerates all figures with fixed seeds)

### Legacy & Independence
AutoGMM was originally developed in the [graspologic](https://github.com/graspologic-org/graspologic/) library.
As of v1.0, it is a standalone package with no dependency on graspologic.

### Contributing
Issues and PRs are welcome. See [CONTRIBUTING.md](CONTRIBUTING.md).

### Citation
``` bibtex
@software{autogmm,
  title   = {AutoGMM: Automatic Gaussian Mixture Modeling in Python},
  author  = {Liu, Tingshan and Athey, Thomas L. and Pedigo, Benjamin D. and Vogelstein, Joshua T.},
  year    = {2025},
  url     = {https://github.com/neurodata/autogmm}
}
```

### License
BSD 3-Clause License. See [LICENSE](LICENSE).

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "autogmm",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.9",
    "maintainer_email": null,
    "keywords": "clustering, gmm, mixture, model selection",
    "author": "Tingshan Liu",
    "author_email": null,
    "download_url": "https://files.pythonhosted.org/packages/19/e9/a518e84de84435bbae7e1de9ad85b5d5e8d30bad50e45b9d303938445bf0/autogmm-0.1.0.tar.gz",
    "platform": null,
    "description": "# AutoGMM\n\nAutomatic Gaussian Mixture Modeling in Python.\n\n### Install\n``` bash\npip install autogmm\n```\n\n### Quick start\n``` python\nfrom autogmm import AutoGMM\nfrom sklearn.datasets import make_blobs\n\nX, _ = make_blobs(\n                 n_samples=1000,\n                 centers=4,\n                 cluster_std=1.2,\n                 random_state=0\n)\n\nlabels = AutoGMM(\n                 min_components=1,\n                 max_components=10, # unknown K\n                 criterion=\"bic\",\n                 random_state=0\n).fit_predict(X)\n```\n\n\n### Features\n- Initializations: KMeans, Ward\u2013Euclidean, Ward\u2013Mahalanobis\n\n- EM with eigenvalue flooring and covariance constraints (spherical, diag, tied, full)\n\n- Model selection via BIC/AIC (unknown *K*)\n\n- Optional spectral front-end (ASE/LSE) for nonconvex structure\n\n- Parallel evaluation, clean API, reproducible scripts\n\n\n\n### Documentation\n- API & Guides: https://github.com/neurodata/autogmm/\n- Examples: [examples/](examples) (benchmarks; stress tests; runtime scaling)\n- Reproducibility: [scripts/reproduce.sh](scripts/reproduce.sh) (regenerates all figures with fixed seeds)\n\n### Legacy & Independence\nAutoGMM was originally developed in the [graspologic](https://github.com/graspologic-org/graspologic/) library.\nAs of v1.0, it is a standalone package with no dependency on graspologic.\n\n### Contributing\nIssues and PRs are welcome. See [CONTRIBUTING.md](CONTRIBUTING.md).\n\n### Citation\n``` bibtex\n@software{autogmm,\n  title   = {AutoGMM: Automatic Gaussian Mixture Modeling in Python},\n  author  = {Liu, Tingshan and Athey, Thomas L. and Pedigo, Benjamin D. and Vogelstein, Joshua T.},\n  year    = {2025},\n  url     = {https://github.com/neurodata/autogmm}\n}\n```\n\n### License\nBSD 3-Clause License. See [LICENSE](LICENSE).\n",
    "bugtrack_url": null,
    "license": "BSD 3-Clause License\n        \n        Copyright (c) YEAR, NeuroData\n        All rights reserved.\n        \n        Redistribution and use in source and binary forms, with or without\n        modification, are permitted provided that the following conditions are met:\n        \n        1. Redistributions of source code must retain the above copyright notice,\n           this list of conditions and the following disclaimer.\n        \n        2. Redistributions in binary form must reproduce the above copyright notice,\n           this list of conditions and the following disclaimer in the documentation\n           and/or other materials provided with the distribution.\n        \n        3. Neither the name of the copyright holder nor the names of its\n           contributors may be used to endorse or promote products derived from this\n           software without specific prior written permission.\n        \n        THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS \"AS IS\"\n        AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,\n        THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR\n        PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR\n        CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,\n        EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,\n        PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;\n        OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,\n        WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR\n        OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF\n        ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\n        ",
    "summary": "Automatic Gaussian Mixture Modeling in Python",
    "version": "0.1.0",
    "project_urls": {
        "Homepage": "https://github.com/neurodata/autogmm",
        "Issues": "https://github.com/neurodata/autogmm/issues",
        "Repository": "https://github.com/neurodata/autogmm"
    },
    "split_keywords": [
        "clustering",
        " gmm",
        " mixture",
        " model selection"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "5bb6d8e92c04e20321ef501286cb0d2473abb0d271587e396e0f6d38d1c1973a",
                "md5": "4fbdfb913ae17684779a7eb7cd59152c",
                "sha256": "c58f4fa256fca3ebee799e94cfa4375c417724290581179c7963837caebd5697"
            },
            "downloads": -1,
            "filename": "autogmm-0.1.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "4fbdfb913ae17684779a7eb7cd59152c",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.9",
            "size": 16641,
            "upload_time": "2025-09-14T01:44:11",
            "upload_time_iso_8601": "2025-09-14T01:44:11.637806Z",
            "url": "https://files.pythonhosted.org/packages/5b/b6/d8e92c04e20321ef501286cb0d2473abb0d271587e396e0f6d38d1c1973a/autogmm-0.1.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "19e9a518e84de84435bbae7e1de9ad85b5d5e8d30bad50e45b9d303938445bf0",
                "md5": "c93aac0691094bf5526bf4b7a3e7b9ac",
                "sha256": "0586b741ea30a71281004205e552fea78a752e3fd85420844f37870ecd55d3bf"
            },
            "downloads": -1,
            "filename": "autogmm-0.1.0.tar.gz",
            "has_sig": false,
            "md5_digest": "c93aac0691094bf5526bf4b7a3e7b9ac",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9",
            "size": 1915783,
            "upload_time": "2025-09-14T01:44:13",
            "upload_time_iso_8601": "2025-09-14T01:44:13.702174Z",
            "url": "https://files.pythonhosted.org/packages/19/e9/a518e84de84435bbae7e1de9ad85b5d5e8d30bad50e45b9d303938445bf0/autogmm-0.1.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-09-14 01:44:13",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "neurodata",
    "github_project": "autogmm",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "autogmm"
}
        
Elapsed time: 1.42801s