alquimodelia


Namealquimodelia JSON
Version 0.0.6 PyPI version JSON
download
home_pagehttps://github.com/alquimodelia/alquimodelia
SummaryKeras based model builder
upload_time2024-10-24 15:01:48
maintainerNone
docs_urlNone
authorJoão Santos
requires_python<4.0,>=3.9
licenseLICENSE
keywords python machine learning forecast model builder
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # Alquimodelia

Alquimodelia is a Python package that provides a Keras-based forecast model builder.

[![Python](https://img.shields.io/badge/python-3.6%20%7C%203.7%20%7C%203.8%20%7C%203.9-blue)](https://www.python.org/)
[![Keras](https://img.shields.io/badge/keras-2.4.3-blue)](https://keras.io/)

It provides the arquitectures for CNN, LSTM, and Encoder Decoder, and even from imagery UNET.
Any suggestions and tips are welcome.
Use this to fastly have your forecast models ready to use!


## Usage

To use Alquimodelia, follow these steps:

```bash
    pip install alquimodelia
```

Since Alquimodelia is based on keras-core you can choose which backend to use, otherwise it will default to tensorflow.
To change backend change the ```KERAS-BACKEND``` enviromental variable. Follow [this](https://keras.io/keras/#configuring-your-backend).

To get an arquiteture you only need to have a simple configuration and call the module:

```python
import alquimodelia

# The input arguments
input_args = {
    "X_timeseries": 168,
    "Y_timeseries": 24,
    "n_features_train": 18,
    "n_features_predict": 1,
}
# This is make a model with shapes:
    # input_shape = (N, 168, 18)
    # output_shape = (N, 24, 1)

forearch = alquimodelia.CNNArch(**input_args)

# Now for Vanilla and Stacked CNN:
architecture_args = {}
VanillaCNN = forearch.architecture(**architecture_args)

architecture_args = {"block_repetition": 2}
StackedCNN = forearch.architecture(**architecture_args)

# Keras Models ready to use:
VanillaCNN.summary()
StackedCNN.summary()


```

## [Contribution](CONTRIBUTING.md)

Contributions to Alquimodelia are welcome! If you find any issues or have suggestions for improvement, please feel free to contribute. Make sure to update tests as appropriate and follow the contribution guidelines.

## License

Alquimodelia is licensed under the MIT License, which allows you to use, modify, and distribute the package according to the terms of the license. For more details, please refer to the [LICENSE](LICENSE) file.

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/alquimodelia/alquimodelia",
    "name": "alquimodelia",
    "maintainer": null,
    "docs_url": null,
    "requires_python": "<4.0,>=3.9",
    "maintainer_email": null,
    "keywords": "python, machine learning, forecast, model builder",
    "author": "Jo\u00e3o Santos",
    "author_email": "jotaflame@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/d5/c2/7e385f54970ca8e23a6a248414bbeaca802c9f3a0b3309d57fb20a44c0a8/alquimodelia-0.0.6.tar.gz",
    "platform": null,
    "description": "# Alquimodelia\n\nAlquimodelia is a Python package that provides a Keras-based forecast model builder.\n\n[![Python](https://img.shields.io/badge/python-3.6%20%7C%203.7%20%7C%203.8%20%7C%203.9-blue)](https://www.python.org/)\n[![Keras](https://img.shields.io/badge/keras-2.4.3-blue)](https://keras.io/)\n\nIt provides the arquitectures for CNN, LSTM, and Encoder Decoder, and even from imagery UNET.\nAny suggestions and tips are welcome.\nUse this to fastly have your forecast models ready to use!\n\n\n## Usage\n\nTo use Alquimodelia, follow these steps:\n\n```bash\n    pip install alquimodelia\n```\n\nSince Alquimodelia is based on keras-core you can choose which backend to use, otherwise it will default to tensorflow.\nTo change backend change the ```KERAS-BACKEND``` enviromental variable. Follow [this](https://keras.io/keras/#configuring-your-backend).\n\nTo get an arquiteture you only need to have a simple configuration and call the module:\n\n```python\nimport alquimodelia\n\n# The input arguments\ninput_args = {\n    \"X_timeseries\": 168,\n    \"Y_timeseries\": 24,\n    \"n_features_train\": 18,\n    \"n_features_predict\": 1,\n}\n# This is make a model with shapes:\n    # input_shape = (N, 168, 18)\n    # output_shape = (N, 24, 1)\n\nforearch = alquimodelia.CNNArch(**input_args)\n\n# Now for Vanilla and Stacked CNN:\narchitecture_args = {}\nVanillaCNN = forearch.architecture(**architecture_args)\n\narchitecture_args = {\"block_repetition\": 2}\nStackedCNN = forearch.architecture(**architecture_args)\n\n# Keras Models ready to use:\nVanillaCNN.summary()\nStackedCNN.summary()\n\n\n```\n\n## [Contribution](CONTRIBUTING.md)\n\nContributions to Alquimodelia are welcome! If you find any issues or have suggestions for improvement, please feel free to contribute. Make sure to update tests as appropriate and follow the contribution guidelines.\n\n## License\n\nAlquimodelia is licensed under the MIT License, which allows you to use, modify, and distribute the package according to the terms of the license. For more details, please refer to the [LICENSE](LICENSE) file.\n",
    "bugtrack_url": null,
    "license": "LICENSE",
    "summary": "Keras based model builder",
    "version": "0.0.6",
    "project_urls": {
        "Bug Tracker": "https://github.com/alquimodelia/alquimodelia/issues",
        "Documentation": "https://alquimodelia.github.io/alquimodelia/",
        "Homepage": "https://github.com/alquimodelia/alquimodelia",
        "Repository": "https://github.com/alquimodelia/alquimodelia",
        "Source Code": "https://github.com/alquimodelia/alquimodelia"
    },
    "split_keywords": [
        "python",
        " machine learning",
        " forecast",
        " model builder"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "c76e87ddc135e76464f2fbe376771b97b3dba6963ccd913beae7623e029c927c",
                "md5": "2732a8d0c1e74b5841c36d5d3d955737",
                "sha256": "506908c366d5bd7735f9d23566e2cfa9f0f09dd6c4ac01ca40bd99f693b5ea02"
            },
            "downloads": -1,
            "filename": "alquimodelia-0.0.6-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "2732a8d0c1e74b5841c36d5d3d955737",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<4.0,>=3.9",
            "size": 34082,
            "upload_time": "2024-10-24T15:01:46",
            "upload_time_iso_8601": "2024-10-24T15:01:46.859243Z",
            "url": "https://files.pythonhosted.org/packages/c7/6e/87ddc135e76464f2fbe376771b97b3dba6963ccd913beae7623e029c927c/alquimodelia-0.0.6-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "d5c27e385f54970ca8e23a6a248414bbeaca802c9f3a0b3309d57fb20a44c0a8",
                "md5": "cddeb1833efcf6182069ffc606cc355d",
                "sha256": "5b51779e487409f17e7a2bfabe515938fcdce87de23875158181eae848b69c6f"
            },
            "downloads": -1,
            "filename": "alquimodelia-0.0.6.tar.gz",
            "has_sig": false,
            "md5_digest": "cddeb1833efcf6182069ffc606cc355d",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<4.0,>=3.9",
            "size": 28530,
            "upload_time": "2024-10-24T15:01:48",
            "upload_time_iso_8601": "2024-10-24T15:01:48.259238Z",
            "url": "https://files.pythonhosted.org/packages/d5/c2/7e385f54970ca8e23a6a248414bbeaca802c9f3a0b3309d57fb20a44c0a8/alquimodelia-0.0.6.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-10-24 15:01:48",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "alquimodelia",
    "github_project": "alquimodelia",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "alquimodelia"
}
        
Elapsed time: 0.39261s