| Name | vasim JSON |
| Version |
0.1.4
JSON |
| download |
| home_page | None |
| Summary | Vertical Autoscaler Simulator Toolkit |
| upload_time | 2024-09-20 18:09:38 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.9 |
| license | MIT License Copyright (c) Microsoft Corporation. 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 |
data analysis
visualization
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
|
# VASIM
[](https://github.com/microsoft/vasim/actions/workflows/pythonapp.yml)
[](https://codecov.io/github/microsoft/vasim?branch=main)
[](https://badge.fury.io/py/vasim)
VASIM (**V**ertical **A**utoscaling **SIM**ulator) is a tool designed to address the complexities involved in assessing autoscaling algorithms.
VASIM is designed for testing recommendation algorithms, with a particular focus on CPU usage in VMs and Kubernetes pods. The toolkit
replicates common components found in autoscaler architectures, including the controller, metrics collector, recommender, and
resource updater. It enables a comprehensive simulation of the entire autoscaling system’s behavior, with the flexibility to customize
various parameters.
If you are writing an academic paper, you can cite [this work](https://www.microsoft.com/en-us/research/publication/vasim-vertical-autoscaling-simulator-toolkit/) as:
```bibtex
@inproceedings{pavlenko2024vasim,
author = {Pavlenko, Anna and Saur, Karla and Zhu, Yiwen and Kroth, Brian and Cahoon, Joyce and Camacho-Rodríguez, Jesús},
title = {VASIM: Vertical Autoscaling Simulator Toolkit},
booktitle = {IEEE International Conference on Data Engineering (ICDE 2024)},
year = {2024},
month = {May},
}
```
## Start here!
Our documentation and working example is in our [notebook](https://github.com/microsoft/vasim/tree/v0.1.4//examples/using_vasim.ipynb) that shows how to get started simulating your data traces and tuning parameters. Our example provides the 3 things needed to run VASim: (1) a data csv file, (2) an autoscaling algorithm, and (3) a metadata.json file of parameters. Details of all of these can be found in the notebook.
### Additionally:
* Within each folder, there is a README explaining the code.
* [simulator](https://github.com/microsoft/vasim/tree/v0.1.4//src/vasim/simulator/README.md)
* [recommender](https://github.com/microsoft/vasim/tree/v0.1.4//src/vasim/recommender/README.md)
* [forecasting](https://github.com/microsoft/vasim/tree/v0.1.4//src/vasim/recommender/forecasting/README.md)
* [cluster state](https://github.com/microsoft/vasim/tree/v0.1.4//src/vasim/recommender/cluster_state_provider/README.md)
* [tests](https://github.com/microsoft/vasim/tree/v0.1.4//tests/README.md)
* For additional usage examples, see any test in the [tests](https://github.com/microsoft/vasim/tree/v0.1.4//tests) folder that starts with `test_e2e`.
* Please see our [blog post](https://www.microsoft.com/en-us/research/blog/enhanced-autoscaling-with-vasim-vertical-autoscaling-simulator-toolkit/?msockid=0d2280e91b2c6ea41f32935e1a9f6f36) or [research paper](https://www.microsoft.com/en-us/research/publication/vasim-vertical-autoscaling-simulator-toolkit/) for more details!
* You can also [`pip install vasim`](https://pypi.org/project/vasim)!
## Authors
* Anna Pavlenko ([@apavlen](https://github.com/apavlen), primary implementation)
* Karla Saur ([@ksaur](https://github.com/ksaur), editing, maintaining)
* Yiwen Zhu ([@zyw400](https://github.com/zyw400))
* Brian Kroth ([@bpkroth](https://github.com/bpkroth))
* Joyce Cahoon ([@jyuu](https://github.com/jyuu))
* Jesús Camacho Rodríguez ([@jcamachor](https://github.com/jcamachor))
## Contributing
Please see [CONTRIBUTING.md](https://github.com/microsoft/vasim/tree/v0.1.4//CONTRIBUTING.md) for techinical details.
This project welcomes contributions and suggestions. Most contributions require you to agree to a
Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us
the rights to use your contribution. For details, visit <https://cla.opensource.microsoft.com>.
When you submit a pull request, a CLA bot will automatically determine whether you need to provide
a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions
provided by the bot. You will only need to do this once across all repos using our CLA.
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or
contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.
## Trademarks
This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft
trademarks or logos is subject to and must follow
[Microsoft's Trademark & Brand Guidelines](https://www.microsoft.com/en-us/legal/intellectualproperty/trademarks/usage/general).
Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship.
Any use of third-party trademarks or logos are subject to those third-party's policies.
Raw data
{
"_id": null,
"home_page": null,
"name": "vasim",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": "VASim Maintainers <vasim-maintainers@service.microsoft.com>",
"keywords": "data analysis, visualization",
"author": null,
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/69/e6/cbc4e0787c6518336c47fbbcaf4e26907894561f690af78ceacddb690888/vasim-0.1.4.tar.gz",
"platform": null,
"description": "# VASIM\n\n[](https://github.com/microsoft/vasim/actions/workflows/pythonapp.yml)\n[](https://codecov.io/github/microsoft/vasim?branch=main)\n[](https://badge.fury.io/py/vasim)\n\nVASIM (**V**ertical **A**utoscaling **SIM**ulator) is a tool designed to address the complexities involved in assessing autoscaling algorithms.\n\nVASIM is designed for testing recommendation algorithms, with a particular focus on CPU usage in VMs and Kubernetes pods. The toolkit\nreplicates common components found in autoscaler architectures, including the controller, metrics collector, recommender, and\nresource updater. It enables a comprehensive simulation of the entire autoscaling system\u2019s behavior, with the flexibility to customize\nvarious parameters.\n\nIf you are writing an academic paper, you can cite [this work](https://www.microsoft.com/en-us/research/publication/vasim-vertical-autoscaling-simulator-toolkit/) as:\n\n```bibtex\n@inproceedings{pavlenko2024vasim,\n author = {Pavlenko, Anna and Saur, Karla and Zhu, Yiwen and Kroth, Brian and Cahoon, Joyce and Camacho-Rodr\u00edguez, Jes\u00fas},\n title = {VASIM: Vertical Autoscaling Simulator Toolkit},\n booktitle = {IEEE International Conference on Data Engineering (ICDE 2024)},\n year = {2024},\n month = {May},\n}\n```\n\n## Start here!\n\nOur documentation and working example is in our [notebook](https://github.com/microsoft/vasim/tree/v0.1.4//examples/using_vasim.ipynb) that shows how to get started simulating your data traces and tuning parameters. Our example provides the 3 things needed to run VASim: (1) a data csv file, (2) an autoscaling algorithm, and (3) a metadata.json file of parameters. Details of all of these can be found in the notebook.\n\n### Additionally:\n\n* Within each folder, there is a README explaining the code.\n * [simulator](https://github.com/microsoft/vasim/tree/v0.1.4//src/vasim/simulator/README.md)\n * [recommender](https://github.com/microsoft/vasim/tree/v0.1.4//src/vasim/recommender/README.md)\n * [forecasting](https://github.com/microsoft/vasim/tree/v0.1.4//src/vasim/recommender/forecasting/README.md)\n * [cluster state](https://github.com/microsoft/vasim/tree/v0.1.4//src/vasim/recommender/cluster_state_provider/README.md)\n * [tests](https://github.com/microsoft/vasim/tree/v0.1.4//tests/README.md)\n\n* For additional usage examples, see any test in the [tests](https://github.com/microsoft/vasim/tree/v0.1.4//tests) folder that starts with `test_e2e`.\n\n* Please see our [blog post](https://www.microsoft.com/en-us/research/blog/enhanced-autoscaling-with-vasim-vertical-autoscaling-simulator-toolkit/?msockid=0d2280e91b2c6ea41f32935e1a9f6f36) or [research paper](https://www.microsoft.com/en-us/research/publication/vasim-vertical-autoscaling-simulator-toolkit/) for more details!\n\n* You can also [`pip install vasim`](https://pypi.org/project/vasim)!\n\n## Authors\n\n* Anna Pavlenko ([@apavlen](https://github.com/apavlen), primary implementation)\n* Karla Saur ([@ksaur](https://github.com/ksaur), editing, maintaining)\n* Yiwen Zhu ([@zyw400](https://github.com/zyw400))\n* Brian Kroth ([@bpkroth](https://github.com/bpkroth))\n* Joyce Cahoon ([@jyuu](https://github.com/jyuu))\n* Jes\u00fas Camacho Rodr\u00edguez ([@jcamachor](https://github.com/jcamachor))\n\n## Contributing\n\nPlease see [CONTRIBUTING.md](https://github.com/microsoft/vasim/tree/v0.1.4//CONTRIBUTING.md) for techinical details.\n\nThis project welcomes contributions and suggestions. Most contributions require you to agree to a\nContributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us\nthe rights to use your contribution. For details, visit <https://cla.opensource.microsoft.com>.\n\nWhen you submit a pull request, a CLA bot will automatically determine whether you need to provide\na CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions\nprovided by the bot. You will only need to do this once across all repos using our CLA.\n\nThis project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).\nFor more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or\ncontact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.\n\n## Trademarks\n\nThis project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft\ntrademarks or logos is subject to and must follow\n[Microsoft's Trademark & Brand Guidelines](https://www.microsoft.com/en-us/legal/intellectualproperty/trademarks/usage/general).\nUse of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship.\nAny use of third-party trademarks or logos are subject to those third-party's policies.\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) Microsoft Corporation. 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": "Vertical Autoscaler Simulator Toolkit",
"version": "0.1.4",
"project_urls": {
"Issues": "https://github.com/microsoft/vasim/issues",
"Repository": "https://github.com/microsoft/vasim"
},
"split_keywords": [
"data analysis",
" visualization"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "ef4f977acc2357e83ccc13b422443386c6e7d6c2a9a651fd7b215ab9a307c969",
"md5": "f659c39ac81f30536023b7d00a0a756b",
"sha256": "3bdc08be3d0bef6a3b1fd5f36d57d5863cfbaea61dd4b48da9a939228de34091"
},
"downloads": -1,
"filename": "vasim-0.1.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f659c39ac81f30536023b7d00a0a756b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 45651,
"upload_time": "2024-09-20T18:09:36",
"upload_time_iso_8601": "2024-09-20T18:09:36.784362Z",
"url": "https://files.pythonhosted.org/packages/ef/4f/977acc2357e83ccc13b422443386c6e7d6c2a9a651fd7b215ab9a307c969/vasim-0.1.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "69e6cbc4e0787c6518336c47fbbcaf4e26907894561f690af78ceacddb690888",
"md5": "4799c25f4accc0389cf81539dc975dbf",
"sha256": "83607324bcbfeb29dd92d68ddb9c52caf81cc42b9e1a32a828c4751870bc2cc8"
},
"downloads": -1,
"filename": "vasim-0.1.4.tar.gz",
"has_sig": false,
"md5_digest": "4799c25f4accc0389cf81539dc975dbf",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 45243,
"upload_time": "2024-09-20T18:09:38",
"upload_time_iso_8601": "2024-09-20T18:09:38.634304Z",
"url": "https://files.pythonhosted.org/packages/69/e6/cbc4e0787c6518336c47fbbcaf4e26907894561f690af78ceacddb690888/vasim-0.1.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-20 18:09:38",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "microsoft",
"github_project": "vasim",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"lcname": "vasim"
}
