iteraa

Name	iteraa JSON
Version	0.2.0 JSON
	download
home_page	None
Summary	A package to conduct accelerated archetypal analysis with an iterative approach.
upload_time	2025-01-27 12:56:00
maintainer	None
docs_url	None
author	Jonathan Yik Chang Ting
requires_python	<4.0,>=3.11
license	MIT
keywords
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # Iterative Archetypal Analysis (IterAA)

## Description

`IterAA` is a package that provides functionalities to conduct accelerated archetypal analysis via an iterative approach.

## Background
* Archetypal analysis is an unsupervised learning technique that uses a convex polytope to summarise multivariate data.
* The classical algorithm involves an alternating minimisation algorithm, which grows quadratically in complexity.
* An iterative approach could be implemented to accelerate the execution of the archetypal analysis algorithm.
* The acceleration achieved by the iterative approach is in addition to the acceleration as a result of the optimisation of other portions of the algorithm execution, as was typically done in the past.

## Features
* Implementation of an iterative approach to conduct archetypal analysis.
* Implementation of a parallelised iterative approach to conduct archetypal analysis.
* Utilisation of high-performance-computing cluster for parallelisation of individual archetypal analysis execution on data subsets.

## Installation

Use `pip` to install `IAA`:

```bash
$ pip install iteraa
```

## Usage

```python
from iteraa import ArchetypalAnalysis

X = getExampleData()  # Replace with your data
aa = ArchetypalAnalysis()
aa.fit(X)
```

Check out the notebooks for demonstrations of the [iterative](https://github.com/Jon-Ting/iaa/blob/main/docs/iaaDemo.ipynb) and [parallel iterative](https://github.com/Jon-Ting/iaa/blob/main/docs/piaaDemo.ipynb) approaches.

## Documentation

Detailed [documentations](https://iaa.readthedocs.io/en/latest/) are hosted by `Read the Docs`.

## Contributing

`IAA` appreciates your enthusiasm and welcomes your expertise!

Please check out the [contributing guidelines](https://github.com/Jon-Ting/iaa/blob/main/CONTRIBUTING.md) and [code of conduct](https://github.com/Jon-Ting/iaa/blob/main/CONDUCT.md). 
By contributing to this project, you agree to abide by its terms.

## License

The project was created by Jonathan Yik Chang Ting. It is licensed under the terms of the [MIT license](https://github.com/Jon-Ting/iaa/blob/main/LICENSE).

## Credits

The package was created with [`cookiecutter`](https://cookiecutter.readthedocs.io/en/latest/) and the `py-pkgs-cookiecutter` [template](https://github.com/py-pkgs/py-pkgs-cookiecutter).
The code is developed based on the [code structure and functionalities for visualisation of the *archetypes.py* written by Benyamin Motevalli](https://researchdata.edu.au/archetypal-analysis-package/1424520), who in turn developed his code based on ["Archetypal Analysis" by Adele Cutler and Leo Breiman, Technometrics, November 1994, Vol.36, No.4, pp. 338-347](https://www.jstor.org/stable/1269949).

## Contact

Email: `Jonathan.Ting@anu.edu.au`/`jonting97@gmail.com`

Feel free to reach out if you have any questions, suggestions, or feedback.

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "iteraa",
    "maintainer": null,
    "docs_url": null,
    "requires_python": "<4.0,>=3.11",
    "maintainer_email": null,
    "keywords": null,
    "author": "Jonathan Yik Chang Ting",
    "author_email": null,
    "download_url": "https://files.pythonhosted.org/packages/13/29/bc9cc4cdc5b8f03a4dc799b1656d4c47e3272a18404b7c667908c023c05c/iteraa-0.2.0.tar.gz",
    "platform": null,
    "description": "# Iterative Archetypal Analysis (IterAA)\n\n## Description\n\n`IterAA` is a package that provides functionalities to conduct accelerated archetypal analysis via an iterative approach.\n\n## Background\n* Archetypal analysis is an unsupervised learning technique that uses a convex polytope to summarise multivariate data.\n* The classical algorithm involves an alternating minimisation algorithm, which grows quadratically in complexity.\n* An iterative approach could be implemented to accelerate the execution of the archetypal analysis algorithm.\n* The acceleration achieved by the iterative approach is in addition to the acceleration as a result of the optimisation of other portions of the algorithm execution, as was typically done in the past.\n\n## Features\n* Implementation of an iterative approach to conduct archetypal analysis.\n* Implementation of a parallelised iterative approach to conduct archetypal analysis.\n* Utilisation of high-performance-computing cluster for parallelisation of individual archetypal analysis execution on data subsets.\n\n## Installation\n\nUse `pip` to install `IAA`:\n\n```bash\n$ pip install iteraa\n```\n\n## Usage\n\n```python\nfrom iteraa import ArchetypalAnalysis\n\nX = getExampleData()  # Replace with your data\naa = ArchetypalAnalysis()\naa.fit(X)\n```\n\nCheck out the notebooks for demonstrations of the [iterative](https://github.com/Jon-Ting/iaa/blob/main/docs/iaaDemo.ipynb) and [parallel iterative](https://github.com/Jon-Ting/iaa/blob/main/docs/piaaDemo.ipynb) approaches.\n\n## Documentation\n\nDetailed [documentations](https://iaa.readthedocs.io/en/latest/) are hosted by `Read the Docs`.\n\n## Contributing\n\n`IAA` appreciates your enthusiasm and welcomes your expertise!\n\nPlease check out the [contributing guidelines](https://github.com/Jon-Ting/iaa/blob/main/CONTRIBUTING.md) and [code of conduct](https://github.com/Jon-Ting/iaa/blob/main/CONDUCT.md). \nBy contributing to this project, you agree to abide by its terms.\n\n## License\n\nThe project was created by Jonathan Yik Chang Ting. It is licensed under the terms of the [MIT license](https://github.com/Jon-Ting/iaa/blob/main/LICENSE).\n\n## Credits\n\nThe package was created with [`cookiecutter`](https://cookiecutter.readthedocs.io/en/latest/) and the `py-pkgs-cookiecutter` [template](https://github.com/py-pkgs/py-pkgs-cookiecutter).\nThe code is developed based on the [code structure and functionalities for visualisation of the *archetypes.py* written by Benyamin Motevalli](https://researchdata.edu.au/archetypal-analysis-package/1424520), who in turn developed his code based on [\"Archetypal Analysis\" by Adele Cutler and Leo Breiman, Technometrics, November 1994, Vol.36, No.4, pp. 338-347](https://www.jstor.org/stable/1269949).\n\n## Contact\n\nEmail: `Jonathan.Ting@anu.edu.au`/`jonting97@gmail.com`\n\nFeel free to reach out if you have any questions, suggestions, or feedback.\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "A package to conduct accelerated archetypal analysis with an iterative approach.",
    "version": "0.2.0",
    "project_urls": null,
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "0d318e87a651137a05e8f72184ae8dadf2af2cfc4c232a2ef998408075116126",
                "md5": "1fa89445ae5b3f9e20108bec3af13eec",
                "sha256": "e1d29a66f60cc85592e07481061bbaf4f18315112899509015276f1dad1b1ee5"
            },
            "downloads": -1,
            "filename": "iteraa-0.2.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "1fa89445ae5b3f9e20108bec3af13eec",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<4.0,>=3.11",
            "size": 28682,
            "upload_time": "2025-01-27T12:55:55",
            "upload_time_iso_8601": "2025-01-27T12:55:55.349436Z",
            "url": "https://files.pythonhosted.org/packages/0d/31/8e87a651137a05e8f72184ae8dadf2af2cfc4c232a2ef998408075116126/iteraa-0.2.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "1329bc9cc4cdc5b8f03a4dc799b1656d4c47e3272a18404b7c667908c023c05c",
                "md5": "3a6019f9f3f5e04ce6d89aa655f6e1b0",
                "sha256": "4789ac4125e645a2170debd412397f417e481c748057f1f74f53d4e406b5a7b1"
            },
            "downloads": -1,
            "filename": "iteraa-0.2.0.tar.gz",
            "has_sig": false,
            "md5_digest": "3a6019f9f3f5e04ce6d89aa655f6e1b0",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<4.0,>=3.11",
            "size": 26567,
            "upload_time": "2025-01-27T12:56:00",
            "upload_time_iso_8601": "2025-01-27T12:56:00.388108Z",
            "url": "https://files.pythonhosted.org/packages/13/29/bc9cc4cdc5b8f03a4dc799b1656d4c47e3272a18404b7c667908c023c05c/iteraa-0.2.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-01-27 12:56:00",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "iteraa"
}