artlib


Nameartlib JSON
Version 0.1.1 PyPI version JSON
download
home_pagehttps://github.com/NiklasMelton/AdaptiveResonanceLib
SummaryA Python library for Adaptive Resonance Theory (ART) algorithms.
upload_time2024-08-29 18:32:10
maintainerNone
docs_urlNone
authorNiklas M. Melton
requires_python<4.0,>=3.9
licenseMIT
keywords adaptive resonance theory art machine learning neural networks clustering
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            
# AdaptiveResonanceLib

Welcome to AdaptiveResonanceLib, a comprehensive and modular Python library for Adaptive Resonance Theory (ART) algorithms. Based on scikit-learn, our library offers a wide range of ART models designed for both researchers and practitioners in the field of machine learning and neural networks. Whether you're working on classification, clustering, or pattern recognition, AdaptiveResonanceLib provides the tools you need to implement ART algorithms efficiently and effectively.

## Available Models

AdaptiveResonanceLib includes implementations for the following ART models:

- #### Elementary Clustering
    - ART1
    - ART2
    - Bayesian ART
    - Gaussian ART
    - Hypersphere ART
    - Ellipsoidal ART
    - Fuzzy ART
    - Quadratic Neuron ART
    - Dual Vigilance ART
- #### Topological
    - Topo ART
- #### Classification
    - Simple ARTMAP
      
- #### Regression
    - ARTMAP
- #### Hierarchical
    - DeepARTMAP
    - SMART
- #### Data Fusion and Reinforcement Learning
    - Fusion ART
- #### Biclustering
    - Biclustering ARTMAP

## Comparison of Elementary Models
![Comparison of Elementary Images](./img/comparison_of_elementary_methods.jpg?raw=true")

## Installation

To install AdaptiveResonanceLib, simply use pip:

[comment]: <> (```bash)

[comment]: <> (pip install AdaptiveResonanceLib)

[comment]: <> (```)

```bash
pip install artlib
```

Ensure you have Python 3.9 or newer installed.

## Quick Start

Here's a quick example of how to use AdaptiveResonanceLib with the Fuzzy ART model:

```python
from artlib import FuzzyART
import numpy as np

# Your dataset
train_X = np.array([...])
test_X = np.array([...])

# Initialize the Fuzzy ART model
model = FuzzyART(rho=0.7, alpha = 0.0, beta=1.0)

# Fit the model
model.fit(train_X)

# Predict new data points
predictions = model.predict(test_X)
```

Replace `params` with the parameters appropriate for your use case.

## Documentation

For more detailed documentation, including the full list of parameters for each model, visit our [documentation page](https://github.com/NiklasMelton/AdaptiveResonanceLib).

## Examples

For examples of how to use each model in AdaptiveResonanceLib, check out the `/examples` directory in our repository.

## Contributing

We welcome contributions to AdaptiveResonanceLib! If you have suggestions for improvements, or if you'd like to add more ART models, please see our `CONTRIBUTING.md` file for guidelines on how to contribute.

You can also join our [Discord server](https://discord.gg/E465HBwEuN) and participate directly in the discussion.

## License

AdaptiveResonanceLib is open source and available under the MIT license. See the `LICENSE` file for more info.

## Contact

For questions and support, please open an issue in the GitHub issue tracker or message us on our [Discord server](https://discord.gg/E465HBwEuN). We'll do our best to assist you.

Happy Modeling with AdaptiveResonanceLib!


            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/NiklasMelton/AdaptiveResonanceLib",
    "name": "artlib",
    "maintainer": null,
    "docs_url": null,
    "requires_python": "<4.0,>=3.9",
    "maintainer_email": null,
    "keywords": "adaptive resonance theory, ART, machine learning, neural networks, clustering",
    "author": "Niklas M. Melton",
    "author_email": "niklasmelton@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/87/25/6ddd5d4fabc3f40bb166a3a4fd24e5a2d3cd943afbaace63e4a32c7fd9a3/artlib-0.1.1.tar.gz",
    "platform": null,
    "description": "\n# AdaptiveResonanceLib\n\nWelcome to AdaptiveResonanceLib, a comprehensive and modular Python library for Adaptive Resonance Theory (ART) algorithms. Based on scikit-learn, our library offers a wide range of ART models designed for both researchers and practitioners in the field of machine learning and neural networks. Whether you're working on classification, clustering, or pattern recognition, AdaptiveResonanceLib provides the tools you need to implement ART algorithms efficiently and effectively.\n\n## Available Models\n\nAdaptiveResonanceLib includes implementations for the following ART models:\n\n- #### Elementary Clustering\n    - ART1\n    - ART2\n    - Bayesian ART\n    - Gaussian ART\n    - Hypersphere ART\n    - Ellipsoidal ART\n    - Fuzzy ART\n    - Quadratic Neuron ART\n    - Dual Vigilance ART\n- #### Topological\n    - Topo ART\n- #### Classification\n    - Simple ARTMAP\n      \n- #### Regression\n    - ARTMAP\n- #### Hierarchical\n    - DeepARTMAP\n    - SMART\n- #### Data Fusion and Reinforcement Learning\n    - Fusion ART\n- #### Biclustering\n    - Biclustering ARTMAP\n\n## Comparison of Elementary Models\n![Comparison of Elementary Images](./img/comparison_of_elementary_methods.jpg?raw=true\")\n\n## Installation\n\nTo install AdaptiveResonanceLib, simply use pip:\n\n[comment]: <> (```bash)\n\n[comment]: <> (pip install AdaptiveResonanceLib)\n\n[comment]: <> (```)\n\n```bash\npip install artlib\n```\n\nEnsure you have Python 3.9 or newer installed.\n\n## Quick Start\n\nHere's a quick example of how to use AdaptiveResonanceLib with the Fuzzy ART model:\n\n```python\nfrom artlib import FuzzyART\nimport numpy as np\n\n# Your dataset\ntrain_X = np.array([...])\ntest_X = np.array([...])\n\n# Initialize the Fuzzy ART model\nmodel = FuzzyART(rho=0.7, alpha = 0.0, beta=1.0)\n\n# Fit the model\nmodel.fit(train_X)\n\n# Predict new data points\npredictions = model.predict(test_X)\n```\n\nReplace `params` with the parameters appropriate for your use case.\n\n## Documentation\n\nFor more detailed documentation, including the full list of parameters for each model, visit our [documentation page](https://github.com/NiklasMelton/AdaptiveResonanceLib).\n\n## Examples\n\nFor examples of how to use each model in AdaptiveResonanceLib, check out the `/examples` directory in our repository.\n\n## Contributing\n\nWe welcome contributions to AdaptiveResonanceLib! If you have suggestions for improvements, or if you'd like to add more ART models, please see our `CONTRIBUTING.md` file for guidelines on how to contribute.\n\nYou can also join our [Discord server](https://discord.gg/E465HBwEuN) and participate directly in the discussion.\n\n## License\n\nAdaptiveResonanceLib is open source and available under the MIT license. See the `LICENSE` file for more info.\n\n## Contact\n\nFor questions and support, please open an issue in the GitHub issue tracker or message us on our [Discord server](https://discord.gg/E465HBwEuN). We'll do our best to assist you.\n\nHappy Modeling with AdaptiveResonanceLib!\n\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "A Python library for Adaptive Resonance Theory (ART) algorithms.",
    "version": "0.1.1",
    "project_urls": {
        "Documentation": "https://github.com/NiklasMelton/AdaptiveResonanceLib",
        "Homepage": "https://github.com/NiklasMelton/AdaptiveResonanceLib",
        "Repository": "https://github.com/NiklasMelton/AdaptiveResonanceLib"
    },
    "split_keywords": [
        "adaptive resonance theory",
        " art",
        " machine learning",
        " neural networks",
        " clustering"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "4534e454c94613e4c96867f82cfa3a3d6ec773b999bd0f1310e8901a024fac40",
                "md5": "05d0d1c49ccc76a06e4a13b28d61bc47",
                "sha256": "a08bac2412381be9adc0920e3cb144970907b08ea09919ac5ba2dcf98cf25d73"
            },
            "downloads": -1,
            "filename": "artlib-0.1.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "05d0d1c49ccc76a06e4a13b28d61bc47",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<4.0,>=3.9",
            "size": 43172,
            "upload_time": "2024-08-29T18:32:06",
            "upload_time_iso_8601": "2024-08-29T18:32:06.421553Z",
            "url": "https://files.pythonhosted.org/packages/45/34/e454c94613e4c96867f82cfa3a3d6ec773b999bd0f1310e8901a024fac40/artlib-0.1.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "87256ddd5d4fabc3f40bb166a3a4fd24e5a2d3cd943afbaace63e4a32c7fd9a3",
                "md5": "3d1b37a5e1b08e025c57103962e978cb",
                "sha256": "2069fa2525129a0daed40047d28f75705bf359e5ce89b84be7731c98dbe7f2df"
            },
            "downloads": -1,
            "filename": "artlib-0.1.1.tar.gz",
            "has_sig": false,
            "md5_digest": "3d1b37a5e1b08e025c57103962e978cb",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<4.0,>=3.9",
            "size": 26541,
            "upload_time": "2024-08-29T18:32:10",
            "upload_time_iso_8601": "2024-08-29T18:32:10.951845Z",
            "url": "https://files.pythonhosted.org/packages/87/25/6ddd5d4fabc3f40bb166a3a4fd24e5a2d3cd943afbaace63e4a32c7fd9a3/artlib-0.1.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-08-29 18:32:10",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "NiklasMelton",
    "github_project": "AdaptiveResonanceLib",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "artlib"
}
        
Elapsed time: 0.33752s