ts-hyperparam-opt


Namets-hyperparam-opt JSON
Version 0.1.3 PyPI version JSON
download
home_page
SummaryConvenience package for parallelized hyperparameter optimization (e.g. in Jupyter Notebooks) using grid search and CV
upload_time2023-03-26 21:00:35
maintainer
docs_urlNone
authornick2202
requires_python>=3.8
licenseMIT License Copyright (c) 2023 nick2202 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.
keywords python time series hyperparameter optimization cross validation parallel
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            

# Time Series Hyperparameter Optimization (CV + Parallel)

Convenience package for optimizing hyperparameters for Time Series forecasting
using methods like _ExponentialSmoothing_ or _SARIMAX_. Especially useful
for Jupyter Notebooks where parallelization (with e.g. `ProcessPoolExecutor`)
only works when importing the function used in parallel.

## Install it from PyPI

```bash
pip install ts-hyperparam-opt
```

## Usage

```py
from ts_hyperparam_opt import parallel_hyperparameter_optimization as pho

params_sarima = [
    [(1,1,1), (1,1,1,7)],
    [(1,1,0), (1,1,1,7)]
    ]

if __name__ == '__main__':
    freeze_support()
    results = process_map(functools.partial(pho.optimize_hyperparams,
                            data=df_data, func="sarima", 
                            n_steps=15), params_sarima)
    results_sorted = pho.sort_results(results)
```

## Development

Alpha Version

Currently supported methods:
- (Triple) Exponential Smoothing (Holt-Winters)
- SARIMA(X)

            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "ts-hyperparam-opt",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": "",
    "keywords": "python,time series,hyperparameter optimization,cross validation,parallel",
    "author": "nick2202",
    "author_email": "",
    "download_url": "https://files.pythonhosted.org/packages/5e/30/1ee04080e66c8682dc3729098ad7eb85b898a948cd90a317844936873685/ts_hyperparam_opt-0.1.3.tar.gz",
    "platform": null,
    "description": "\r\n\r\n# Time Series Hyperparameter Optimization (CV + Parallel)\r\n\r\nConvenience package for optimizing hyperparameters for Time Series forecasting\r\nusing methods like _ExponentialSmoothing_ or _SARIMAX_. Especially useful\r\nfor Jupyter Notebooks where parallelization (with e.g. `ProcessPoolExecutor`)\r\nonly works when importing the function used in parallel.\r\n\r\n## Install it from PyPI\r\n\r\n```bash\r\npip install ts-hyperparam-opt\r\n```\r\n\r\n## Usage\r\n\r\n```py\r\nfrom ts_hyperparam_opt import parallel_hyperparameter_optimization as pho\r\n\r\nparams_sarima = [\r\n    [(1,1,1), (1,1,1,7)],\r\n    [(1,1,0), (1,1,1,7)]\r\n    ]\r\n\r\nif __name__ == '__main__':\r\n    freeze_support()\r\n    results = process_map(functools.partial(pho.optimize_hyperparams,\r\n                            data=df_data, func=\"sarima\", \r\n                            n_steps=15), params_sarima)\r\n    results_sorted = pho.sort_results(results)\r\n```\r\n\r\n## Development\r\n\r\nAlpha Version\r\n\r\nCurrently supported methods:\r\n- (Triple) Exponential Smoothing (Holt-Winters)\r\n- SARIMA(X)\r\n",
    "bugtrack_url": null,
    "license": "MIT License  Copyright (c) 2023 nick2202  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. ",
    "summary": "Convenience package for parallelized hyperparameter optimization (e.g. in Jupyter Notebooks) using grid search and CV",
    "version": "0.1.3",
    "split_keywords": [
        "python",
        "time series",
        "hyperparameter optimization",
        "cross validation",
        "parallel"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "f9fdd0cc191c203e29c8ed05f10cafa9bc6f62dbb5cdb51021524ceffe6c0568",
                "md5": "0f6866c4347183a81a6f62a18ce9bce0",
                "sha256": "cf3135e9e7ff49c3fbea04e9e5322df39d084a89a54123df6eebf9688319de2c"
            },
            "downloads": -1,
            "filename": "ts_hyperparam_opt-0.1.3-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "0f6866c4347183a81a6f62a18ce9bce0",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 5391,
            "upload_time": "2023-03-26T21:00:33",
            "upload_time_iso_8601": "2023-03-26T21:00:33.340282Z",
            "url": "https://files.pythonhosted.org/packages/f9/fd/d0cc191c203e29c8ed05f10cafa9bc6f62dbb5cdb51021524ceffe6c0568/ts_hyperparam_opt-0.1.3-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "5e301ee04080e66c8682dc3729098ad7eb85b898a948cd90a317844936873685",
                "md5": "070ef6bba7997c8fc5c8da5b4f970cf1",
                "sha256": "26776739c4f00fcbbc48c48f97ab3f2f62497b79d8255810a0fb8a073c6cfb39"
            },
            "downloads": -1,
            "filename": "ts_hyperparam_opt-0.1.3.tar.gz",
            "has_sig": false,
            "md5_digest": "070ef6bba7997c8fc5c8da5b4f970cf1",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 4282,
            "upload_time": "2023-03-26T21:00:35",
            "upload_time_iso_8601": "2023-03-26T21:00:35.433555Z",
            "url": "https://files.pythonhosted.org/packages/5e/30/1ee04080e66c8682dc3729098ad7eb85b898a948cd90a317844936873685/ts_hyperparam_opt-0.1.3.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-03-26 21:00:35",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "lcname": "ts-hyperparam-opt"
}
        
Elapsed time: 0.06235s