| Name | shootout-opt JSON |
| Version |
0.2.2
JSON |
| download |
| home_page | |
| Summary | Run algorithms, store and compare their outputs |
| upload_time | 2023-04-11 14:51:34 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.9 |
| license | MIT License Copyright (c) 2023 Jeremy E. Cohen 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 |
numerical optimisation
visualisation
python
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# SHOOTOUT toolbox
## Why I wrote this package
Comparing numerical optimization algorithms is always a pain for me. Things I hate to do:
- writing lots of loops for testing various hyperparameters.
- writing the code to store the results, painfully changing details all the time.
- comparing algorithms in a fair manner though lengthy plotting scripts.
- comming back to old codes for review updates a year after the simulations, and finding I did not store all the hyperpameters by mistake.
- looking up plotly syntax when updating plots, every single time.
- reading papers that compare algorithms in one run/one set of parameters.
Plus I am a very chaotic person, changing workflow every single paper. So I needed some tools to balance this entropy and make my life easier.
## What this does
- Using a decorator function @run_and_track(), one may run a script many times with user-defined hyperparameters grid; store all the results in clearly formatted pandas dataframe usable by plotly express.
- provide a few helpful functions for processing this dataframe, to produce interesting comparison plots (convergence plots, who is fastest at given threshold plots)
## Installation
The package can be pip installed using
```python
pip install shootout-opt
```
or by cloning the repo and running
```python
pip install -e .
```
with root in the root folder of this package.
## TODOS
- TODO: auto-tests on push on github
- TODO: sphynx doc, online
- TODO: pipelines
- TODO: examples
## Feedback
I wrote this for myself, but if you have some ideas for improvements or new features, feel free to drop an issue or a pull request.
Raw data
{
"_id": null,
"home_page": "",
"name": "shootout-opt",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": "",
"keywords": "numerical optimisation,visualisation,python",
"author": "",
"author_email": "\"Jeremy E. Cohen\" <jeremy.cohen@cnrs.fr>",
"download_url": "https://files.pythonhosted.org/packages/b5/b2/55bd03f43bd92d5a4df169d0f11318e92e75802b4228352d69b757818d81/shootout-opt-0.2.2.tar.gz",
"platform": null,
"description": "# SHOOTOUT toolbox\n\n## Why I wrote this package\nComparing numerical optimization algorithms is always a pain for me. Things I hate to do: \n- writing lots of loops for testing various hyperparameters.\n- writing the code to store the results, painfully changing details all the time.\n- comparing algorithms in a fair manner though lengthy plotting scripts.\n- comming back to old codes for review updates a year after the simulations, and finding I did not store all the hyperpameters by mistake.\n- looking up plotly syntax when updating plots, every single time.\n- reading papers that compare algorithms in one run/one set of parameters.\n\nPlus I am a very chaotic person, changing workflow every single paper. So I needed some tools to balance this entropy and make my life easier.\n\n## What this does\n- Using a decorator function @run_and_track(), one may run a script many times with user-defined hyperparameters grid; store all the results in clearly formatted pandas dataframe usable by plotly express.\n- provide a few helpful functions for processing this dataframe, to produce interesting comparison plots (convergence plots, who is fastest at given threshold plots)\n\n## Installation\nThe package can be pip installed using\n```python\npip install shootout-opt\n```\nor by cloning the repo and running\n```python\npip install -e .\n```\nwith root in the root folder of this package.\n\n## TODOS\n- TODO: auto-tests on push on github\n- TODO: sphynx doc, online\n- TODO: pipelines\n- TODO: examples\n\n## Feedback\nI wrote this for myself, but if you have some ideas for improvements or new features, feel free to drop an issue or a pull request.\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2023 Jeremy E. Cohen 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": "Run algorithms, store and compare their outputs",
"version": "0.2.2",
"split_keywords": [
"numerical optimisation",
"visualisation",
"python"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "668aa99c515b1ed568a0fc3292eb97369053a39471a2aa586ba762b5d641beb9",
"md5": "5a78e3caffe779f54c244171611ff267",
"sha256": "9abb44d3b02231151557187e1c81d4f1a348c239da1974918e38b03be45a4878"
},
"downloads": -1,
"filename": "shootout_opt-0.2.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "5a78e3caffe779f54c244171611ff267",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 16745,
"upload_time": "2023-04-11T14:51:32",
"upload_time_iso_8601": "2023-04-11T14:51:32.732590Z",
"url": "https://files.pythonhosted.org/packages/66/8a/a99c515b1ed568a0fc3292eb97369053a39471a2aa586ba762b5d641beb9/shootout_opt-0.2.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "b5b255bd03f43bd92d5a4df169d0f11318e92e75802b4228352d69b757818d81",
"md5": "9bbf01c02be13b6445c4a602c6cb503e",
"sha256": "ac76b887d97f40ea26b87f8ea64d069472e59d1995f2f021a93414223a05933c"
},
"downloads": -1,
"filename": "shootout-opt-0.2.2.tar.gz",
"has_sig": false,
"md5_digest": "9bbf01c02be13b6445c4a602c6cb503e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 15920,
"upload_time": "2023-04-11T14:51:34",
"upload_time_iso_8601": "2023-04-11T14:51:34.188729Z",
"url": "https://files.pythonhosted.org/packages/b5/b2/55bd03f43bd92d5a4df169d0f11318e92e75802b4228352d69b757818d81/shootout-opt-0.2.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-04-11 14:51:34",
"github": false,
"gitlab": false,
"bitbucket": false,
"lcname": "shootout-opt"
}
