| Name | osml-models JSON |
| Version |
1.1.1
JSON |
| download |
| home_page | None |
| Summary | A set of demonstration models to test OSML with. |
| upload_time | 2024-04-04 19:18:59 |
| 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 Models
This package contains sample models that can be used to test OversightML installations without incurring high compute costs typically associated with complex Computer Vision models. These models implement an interface compatible with SageMaker and are suitable for deployment as endpoints with CPU instances.
### Table of Contents
* [Getting Started](#getting-started)
* [Prerequisites](#prerequisites)
* [Installation Guide](#installation-guide)
* [Documentation](#documentation)
* [Build and Local Testing](#build-and-local-testing)
* [Support & Feedback](#support--feedback)
* [Resources](#resources)
* [Security](#security)
* [License](#license)
## Getting Started
### Prerequisites:
First, ensure you have installed the following tools locally
- [docker](https://nodejs.org/en)
### Installation Guide
Clone `osml-models` package into your desktop
```sh
git clone https://github.com/aws-solutions-library-samples/osml-models.git
```
### 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
```
### Build and Local Testing
To build the container, it uses the default `Dockerfile` from the root of this repository. If you want to change to another `Dockerfile`, replace the `.` with the new `Dockerfile` path.
```bash
docker build . -t osml-models:latest
```
**Note**: The `MODEL_SELECTION` environment variable can be used to pick the model to run. Currently, we support 3 different types of a model and below are the appropriate naming convention:
- centerpoint
- flood
- aircraft
In one terminal, run the following command to start the server:
```bash
docker run -p 8080:8080 -e MODEL_SELECTION=${MODEL_SELECTION} osml-models:latest
```
In another terminal to invoke the rest server and return the inference on a single tile, run the following command from the root of this repository:
```bash
curl -I localhost:8080/ping
curl --request POST --data-binary "@<imagery file>" localhost:8080/invocations
```
- Example: `curl --request POST --data-binary "@assets/images/2_planes.tiff" localhost:8080/invocations`
Executing above should return:
```
{"type": "FeatureCollection", "features": [{"geometry": {"coordinates": [0.0, 0.0], "type": "Point"}, "id": "7683a11e4c93f0332be9a4a53e0c6762", "properties": {"bounds_imcoords": [204.8, 204.8, 307.2, 307.2], "detection_score": 1.0, "feature_types": {"sample_object": 1.0}, "image_id": "8cdac8849cae2b4a8885c0dd0d34f722"}, "type": "Feature"}]}
```
## Support & Feedback
OversightML Models are maintained by AWS Solution Architects.
It is not part of an AWS service and support is provided best-effort by the OversightML community.
To post feedback, submit feature ideas, or report bugs, please use the [Issues](https://github.com/aws-solutions-library-samples/osml-models/issues) section of this GitHub repo.
If you are interested in contributing to OversightML Models, see the [CONTRIBUTING](CONTRIBUTING.md) guide.
## Resources
- [Aircraft Models](https://www.cosmiqworks.org/rareplanes/)
## Security
See [CONTRIBUTING](CONTRIBUTING.md#security-issue-notifications) for more information.
## License
MIT No Attribution Licensed. See [LICENSE](LICENSE).
Raw data
{
"_id": null,
"home_page": null,
"name": "osml-models",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": null,
"author": "Amazon Web Services",
"author_email": "todo-public-library-poc@amazon.com",
"download_url": "https://files.pythonhosted.org/packages/88/2e/7c91a732a887c7458816a50a202f92a4486d796eda8d9782e4d763343093/osml-models-1.1.1.tar.gz",
"platform": null,
"description": "# OSML Models\n\nThis package contains sample models that can be used to test OversightML installations without incurring high compute costs typically associated with complex Computer Vision models. These models implement an interface compatible with SageMaker and are suitable for deployment as endpoints with CPU instances.\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* [Support & Feedback](#support--feedback)\n* [Resources](#resources)\n* [Security](#security)\n* [License](#license)\n\n\n## Getting Started\n### Prerequisites:\n\nFirst, ensure you have installed the following tools locally\n\n- [docker](https://nodejs.org/en)\n\n### Installation Guide\n\nClone `osml-models` package into your desktop\n\n```sh\ngit clone https://github.com/aws-solutions-library-samples/osml-models.git\n```\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### Build and Local Testing\n\nTo build the container, it uses the default `Dockerfile` from the root of this repository. If you want to change to another `Dockerfile`, replace the `.` with the new `Dockerfile` path.\n```bash\ndocker build . -t osml-models:latest\n```\n\n**Note**: The `MODEL_SELECTION` environment variable can be used to pick the model to run. Currently, we support 3 different types of a model and below are the appropriate naming convention:\n\n- centerpoint\n- flood\n- aircraft\n\nIn one terminal, run the following command to start the server:\n```bash\ndocker run -p 8080:8080 -e MODEL_SELECTION=${MODEL_SELECTION} osml-models:latest\n```\n\nIn another terminal to invoke the rest server and return the inference on a single tile, run the following command from the root of this repository:\n\n```bash\ncurl -I localhost:8080/ping\ncurl --request POST --data-binary \"@<imagery file>\" localhost:8080/invocations\n```\n- Example: `curl --request POST --data-binary \"@assets/images/2_planes.tiff\" localhost:8080/invocations`\n\nExecuting above should return:\n\n```\n{\"type\": \"FeatureCollection\", \"features\": [{\"geometry\": {\"coordinates\": [0.0, 0.0], \"type\": \"Point\"}, \"id\": \"7683a11e4c93f0332be9a4a53e0c6762\", \"properties\": {\"bounds_imcoords\": [204.8, 204.8, 307.2, 307.2], \"detection_score\": 1.0, \"feature_types\": {\"sample_object\": 1.0}, \"image_id\": \"8cdac8849cae2b4a8885c0dd0d34f722\"}, \"type\": \"Feature\"}]}\n```\n\n## Support & Feedback\n\nOversightML Models are maintained by AWS Solution Architects.\nIt is not part of an AWS service and support is provided best-effort by the OversightML community.\n\nTo post feedback, submit feature ideas, or report bugs, please use the [Issues](https://github.com/aws-solutions-library-samples/osml-models/issues) section of this GitHub repo.\n\nIf you are interested in contributing to OversightML Models, see the [CONTRIBUTING](CONTRIBUTING.md) guide.\n\n## Resources\n\n- [Aircraft Models](https://www.cosmiqworks.org/rareplanes/)\n\n## Security\n\nSee [CONTRIBUTING](CONTRIBUTING.md#security-issue-notifications) for more information.\n\n## License\n\nMIT No Attribution Licensed. See [LICENSE](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": "A set of demonstration models to test OSML with.",
"version": "1.1.1",
"project_urls": {
"Source": "https://github.com/aws-solutions-library-samples/osml-models",
"Tracker": "https://github.com/aws-solutions-library-samples/osml-models/issues"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "c649f47da531509dd56b9d8dbf77f77d08778cd7bf428afba6bdff0f5344a959",
"md5": "ab81017f59164d6ece6f1059ff989c1d",
"sha256": "c68670f7c65bdb6afd175e865dbd990bf0e7ee046d5ecc4611309a84336ac407"
},
"downloads": -1,
"filename": "osml_models-1.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ab81017f59164d6ece6f1059ff989c1d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 14666,
"upload_time": "2024-04-04T19:18:57",
"upload_time_iso_8601": "2024-04-04T19:18:57.730520Z",
"url": "https://files.pythonhosted.org/packages/c6/49/f47da531509dd56b9d8dbf77f77d08778cd7bf428afba6bdff0f5344a959/osml_models-1.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "882e7c91a732a887c7458816a50a202f92a4486d796eda8d9782e4d763343093",
"md5": "fe9dbf09019c2347b5695bbdc946f32e",
"sha256": "39297897c5d69ae9681c7f56b9554654b7b6b4098de8c302c798c4f237f97c7a"
},
"downloads": -1,
"filename": "osml-models-1.1.1.tar.gz",
"has_sig": false,
"md5_digest": "fe9dbf09019c2347b5695bbdc946f32e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 13196,
"upload_time": "2024-04-04T19:18:59",
"upload_time_iso_8601": "2024-04-04T19:18:59.403460Z",
"url": "https://files.pythonhosted.org/packages/88/2e/7c91a732a887c7458816a50a202f92a4486d796eda8d9782e4d763343093/osml-models-1.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-04 19:18:59",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "aws-solutions-library-samples",
"github_project": "osml-models",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"tox": true,
"lcname": "osml-models"
}
