| Name | osml-model-runner-test JSON |
| Version |
2.0.2
JSON |
| download |
| home_page | None |
| Summary | Package to run tests against osml-model-runner deployments. |
| upload_time | 2024-08-22 19:52:03 |
| maintainer | None |
| docs_url | None |
| author | Amazon Web Services |
| requires_python | >=3.9 |
| license | MIT No Attribution Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. 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. 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 |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
|
# OSML Model Runner Test
This package contains the integration tests for OSML application
### Table of Contents
* [Getting Started](#getting-started)
* [Prerequisites](#prerequisites)
* [Installation Guide](#installation-guide)
* [Documentation](#documentation)
* [Build and Local Testing](#build-and-local-testing)
* [Running LoadTest](#running-loadtest)
* [Support & Feedback](#support--feedback)
* [Security](#security)
* [License](#license)
## Getting Started
### Prerequisites
First, ensure you have installed the following tools locally
1. [aws cli](https://docs.aws.amazon.com/cli/latest/userguide/install-cliv2.html)
2. [tox](https://tox.wiki/en/latest/installation.html)
### Installation Guide
1. Clone `osml-model-runner-test` package into your desktop
```sh
git clone https://github.com/aws-solutions-library-samples/osml-model-runner-test.git
```
1. Run `tox` to create a virtual environment
```sh
cd osml-model-runner-test
tox
```
### Documentation
You can find documentation for this library in the `./doc` directory. Sphinx is used to construct a searchable HTML
version of the API documents.
```shell
tox -e docs
```
### Local Testing
#### Credentials
Credentials from the user's account are volume mounted into the container's root directory.
**Processing an image:**
You can run the integration tests against your dev account by exporting the required parameters and using the pytest CLI by
using the python script ``bin/process_image.py``. Remember to load up your AWS credentials into your terminal, please follow this [guide](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-configure.html) on how to load your aws credentials.
```
python bin/process_image.py --image <image type> --model <model type>
```
**Examples:**
```
python3 bin/process_image.py --image small --model centerpoint
python3 bin/process_image.py --image meta --model centerpoint
python3 bin/process_image.py --image large --model flood
python3 bin/process_image.py --image tile_tif --model aircraft
```
To print out the usage for python script, execute:
```
python3 bin/process_image.py --help
```
To execute the integration test, exclude `--skip_integ` from the command line interface. It is essential that the images and models listed in the table below are aligned accurately for the test to succeed. Conversely, by adding `--skip_integ` to the CLI, all comparison checks will be bypassed, rendering the table irrelevant for testing purposes.
| image | model |
|-----------------------------|-------------|
| small | centerpoint |
| meta | centerpoint |
| sicd_capella_chip_ntf | centerpoint |
| sicd_umbra_chip_ntf | centerpoint |
| sicd_interferometric_hh_ntf | centerpoint |
| wbid | centerpoint |
| large | flood |
| tile_tif | aircraft |
| tile_ntf | aircraft |
| tile_jpeg | aircraft |
| tile_png | aircraft |
### Running LoadTest
You can run the load test against your dev account and be able to determine the cost and the performance. **Please advise** it can potentially rack up your AWS bills!
**Examples:**
```
python3 bin/run_load_test.py --periodic_sleep 60 --processing_window 1
```
To print out the usage for this load test script, execute:
```
python3 bin/run_load_test.py --help
```
## Support & Feedback
To post feedback, submit feature ideas, or report bugs, please use the [Issues](https://github.com/aws-solutions-library-samples/osml-model-runner-test/issues) section of this GitHub repo.
If you are interested in contributing to OversightML Model Runner, see the [CONTRIBUTING](https://github.com/aws-solutions-library-samples/osml-model-runner-test/tree/main/CONTRIBUTING.md) guide.
## Security
See [CONTRIBUTING](https://github.com/aws-solutions-library-samples/osml-model-runner-test/tree/main/CONTRIBUTING.md) for more information.
## License
MIT No Attribution Licensed. See [LICENSE](https://github.com/aws-solutions-library-samples/osml-model-runner-test/tree/main/LICENSE).
Raw data
{
"_id": null,
"home_page": null,
"name": "osml-model-runner-test",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": null,
"author": "Amazon Web Services",
"author_email": "aws-osml-admin@amazon.com",
"download_url": "https://files.pythonhosted.org/packages/db/da/a15497579d862576ab0efaa2d53b750cb4afc6565575eee71b934cf575b6/osml_model_runner_test-2.0.2.tar.gz",
"platform": null,
"description": "# OSML Model Runner Test\n\nThis package contains the integration tests for OSML application\n\n### Table of Contents\n* [Getting Started](#getting-started)\n * [Prerequisites](#prerequisites)\n * [Installation Guide](#installation-guide)\n * [Documentation](#documentation)\n * [Build and Local Testing](#build-and-local-testing)\n * [Running LoadTest](#running-loadtest)\n* [Support & Feedback](#support--feedback)\n* [Security](#security)\n* [License](#license)\n\n\n## Getting Started\n### Prerequisites\n\nFirst, ensure you have installed the following tools locally\n\n1. [aws cli](https://docs.aws.amazon.com/cli/latest/userguide/install-cliv2.html)\n2. [tox](https://tox.wiki/en/latest/installation.html)\n\n### Installation Guide\n\n1. Clone `osml-model-runner-test` package into your desktop\n\n```sh\ngit clone https://github.com/aws-solutions-library-samples/osml-model-runner-test.git\n```\n\n1. Run `tox` to create a virtual environment\n\n```sh\ncd osml-model-runner-test\ntox\n```\n\n### Documentation\n\nYou can find documentation for this library in the `./doc` directory. Sphinx is used to construct a searchable HTML\nversion of the API documents.\n\n```shell\ntox -e docs\n```\n\n### Local Testing\n\n\n#### Credentials\n\nCredentials from the user's account are volume mounted into the container's root directory.\n\n**Processing an image:**\n\nYou can run the integration tests against your dev account by exporting the required parameters and using the pytest CLI by\nusing the python script ``bin/process_image.py``. Remember to load up your AWS credentials into your terminal, please follow this [guide](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-configure.html) on how to load your aws credentials.\n\n\n```\npython bin/process_image.py --image <image type> --model <model type>\n```\n\n**Examples:**\n\n```\npython3 bin/process_image.py --image small --model centerpoint\n\npython3 bin/process_image.py --image meta --model centerpoint\n\npython3 bin/process_image.py --image large --model flood\n\npython3 bin/process_image.py --image tile_tif --model aircraft\n```\n\nTo print out the usage for python script, execute:\n```\npython3 bin/process_image.py --help\n```\n\nTo execute the integration test, exclude `--skip_integ` from the command line interface. It is essential that the images and models listed in the table below are aligned accurately for the test to succeed. Conversely, by adding `--skip_integ` to the CLI, all comparison checks will be bypassed, rendering the table irrelevant for testing purposes.\n\n| image | model |\n|-----------------------------|-------------|\n| small | centerpoint |\n| meta | centerpoint |\n| sicd_capella_chip_ntf | centerpoint |\n| sicd_umbra_chip_ntf | centerpoint |\n| sicd_interferometric_hh_ntf | centerpoint |\n| wbid | centerpoint |\n| large | flood |\n| tile_tif | aircraft |\n| tile_ntf | aircraft |\n| tile_jpeg | aircraft |\n| tile_png | aircraft |\n\n### Running LoadTest\n\nYou can run the load test against your dev account and be able to determine the cost and the performance. **Please advise** it can potentially rack up your AWS bills!\n\n**Examples:**\n```\npython3 bin/run_load_test.py --periodic_sleep 60 --processing_window 1\n```\n\nTo print out the usage for this load test script, execute:\n\n```\npython3 bin/run_load_test.py --help\n```\n\n## Support & Feedback\n\nTo post feedback, submit feature ideas, or report bugs, please use the [Issues](https://github.com/aws-solutions-library-samples/osml-model-runner-test/issues) section of this GitHub repo.\n\nIf you are interested in contributing to OversightML Model Runner, see the [CONTRIBUTING](https://github.com/aws-solutions-library-samples/osml-model-runner-test/tree/main/CONTRIBUTING.md) guide.\n\n## Security\n\nSee [CONTRIBUTING](https://github.com/aws-solutions-library-samples/osml-model-runner-test/tree/main/CONTRIBUTING.md) for more information.\n\n## License\n\nMIT No Attribution Licensed. See [LICENSE](https://github.com/aws-solutions-library-samples/osml-model-runner-test/tree/main/LICENSE).\n",
"bugtrack_url": null,
"license": " MIT No Attribution Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. 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. 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": "Package to run tests against osml-model-runner deployments.",
"version": "2.0.2",
"project_urls": {
"Source": "https://github.com/aws-solutions-library-samples/osml-model-runner-test",
"Tracker": "https://github.com/aws-solutions-library-samples/osml-model-runner-test/issues"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "58b287c642a579959235aa46140782748f356fa75c56c35bb1dbdf340f6e18e0",
"md5": "6c79fbb37160f49fb9f369cd1064eea1",
"sha256": "6b1e2e85a3093b702868d08078187b442e4009e16a27f1d3085be95f12dd43ad"
},
"downloads": -1,
"filename": "osml_model_runner_test-2.0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "6c79fbb37160f49fb9f369cd1064eea1",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 23426,
"upload_time": "2024-08-22T19:52:01",
"upload_time_iso_8601": "2024-08-22T19:52:01.845598Z",
"url": "https://files.pythonhosted.org/packages/58/b2/87c642a579959235aa46140782748f356fa75c56c35bb1dbdf340f6e18e0/osml_model_runner_test-2.0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "dbdaa15497579d862576ab0efaa2d53b750cb4afc6565575eee71b934cf575b6",
"md5": "939d9ceb918497b099dfa816dcd88ddb",
"sha256": "a96c1916bae53eb29365ab50e2e1adfb72a166bbf222c34da6441ecc2bd5c43c"
},
"downloads": -1,
"filename": "osml_model_runner_test-2.0.2.tar.gz",
"has_sig": false,
"md5_digest": "939d9ceb918497b099dfa816dcd88ddb",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 20143,
"upload_time": "2024-08-22T19:52:03",
"upload_time_iso_8601": "2024-08-22T19:52:03.195369Z",
"url": "https://files.pythonhosted.org/packages/db/da/a15497579d862576ab0efaa2d53b750cb4afc6565575eee71b934cf575b6/osml_model_runner_test-2.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-22 19:52:03",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "aws-solutions-library-samples",
"github_project": "osml-model-runner-test",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"tox": true,
"lcname": "osml-model-runner-test"
}
