Osml-model-runner

This release introduces updates to OSML Model Runner, including the new default variable overlap tiling strategy for enhanced flexibility, region status tracking for improved process monitoring, and various bug fixes addressing feature selection and Kinesis integration issues. Refactors and testing enhancements further improve code maintainability and reliability, while updates to documentation and CI/CD workflows streamline development processes. These changes ensure a more robust and adaptable framework for image processing and feature detection tasks.

Bug Fixes

- **Feature Selection**:
Resolved issues in feature selection, particularly addressing errors related to zero-area features, ensuring accurate and error-free processing.

- **Kinesis Integration**:
Addressed rate exceedance issues with Kinesis by implementing the `put_records` method, improving data throughput and stability.

- **Miscellaneous Fixes**:
Corrected missing list handling in `FeatureCollection` dump calls and removed redundant logic in the no-operation model, streamlining the processing workflow.

Chores and Miscellaneous

- **Documentation and Comments**:
Added comprehensive comments to test files and updated documentation for tiling strategies, aiding in developer understanding and future code maintenance.

- **Continuous Integration**:
Updated workflow configurations, including `workflow_dispatch` and Docker tags, to enhance the CI/CD pipeline's efficiency and reliability.

---

Breaking Changes:
N/A

Limitations:
N/A

New Dependency:
N/A

Pull Requests Merged
* refactor: tiling strategy refactor by edparris in https://github.com/aws-solutions-library-samples/osml-model-runner/pull/88
* feat: add variable overlap tiling strategy by edparris in https://github.com/aws-solutions-library-samples/osml-model-runner/pull/90
* feat: variable overlap is now default tiling strategy by edparris in https://github.com/aws-solutions-library-samples/osml-model-runner/pull/91
* fix: refactor featureselection tuneup by RanbirAulakh in https://github.com/aws-solutions-library-samples/osml-model-runner/pull/87
* fix: feature selection error for zero area features by edparris in https://github.com/aws-solutions-library-samples/osml-model-runner/pull/93
* fix: use put_records for kinesis due to rate exceeded by RanbirAulakh in https://github.com/aws-solutions-library-samples/osml-model-runner/pull/92
* feat: implement region status tracking by drduhe in https://github.com/aws-solutions-library-samples/osml-model-runner/pull/89
* fix: add missing List in FeatureCollection dump calls by RanbirAulakh in https://github.com/aws-solutions-library-samples/osml-model-runner/pull/94
* fix: remove noop model logic by drduhe in https://github.com/aws-solutions-library-samples/osml-model-runner/pull/95
* ci: add workflow_dispatch and update docker tags by RanbirAulakh in https://github.com/aws-solutions-library-samples/osml-model-runner/pull/96
* refactor: migrate logic from app.py by drduhe in https://github.com/aws-solutions-library-samples/osml-model-runner/pull/97
* refactor: break out RegionRequestHandler class from app.py by drduhe in https://github.com/aws-solutions-library-samples/osml-model-runner/pull/100
* refactor: migrate methods from app.py to submodules by drduhe in https://github.com/aws-solutions-library-samples/osml-model-runner/pull/101
* refactor: implement ImageRequestHandler class by drduhe in https://github.com/aws-solutions-library-samples/osml-model-runner/pull/102
* refactor: update app.py by drduhe in https://github.com/aws-solutions-library-samples/osml-model-runner/pull/103
* chore: update database tests by drduhe in https://github.com/aws-solutions-library-samples/osml-model-runner/pull/106
* chore: updating test coverage for tile_worker_utils.py by drduhe in https://github.com/aws-solutions-library-samples/osml-model-runner/pull/105
* fix: improving feature util test coverage by drduhe in https://github.com/aws-solutions-library-samples/osml-model-runner/pull/104
* chore: updating test coverage for sink submodule by drduhe in https://github.com/aws-solutions-library-samples/osml-model-runner/pull/107
* Test/update inference submodule tests by drduhe in https://github.com/aws-solutions-library-samples/osml-model-runner/pull/112
* chore: adding comments to test_sns_helper.py by drduhe in https://github.com/aws-solutions-library-samples/osml-model-runner/pull/111
* refactor: refatoring updating image_request.py and updating tests by drduhe in https://github.com/aws-solutions-library-samples/osml-model-runner/pull/108
* test: cleaning up structure and comments in test_request_queue.py by drduhe in https://github.com/aws-solutions-library-samples/osml-model-runner/pull/113
* refactor: updating region_request.py and tests for the class by drduhe in https://github.com/aws-solutions-library-samples/osml-model-runner/pull/109
* chore: cleanup tiling strategy comments for classes and tests by drduhe in https://github.com/aws-solutions-library-samples/osml-model-runner/pull/110
* build: version update to v2.3.0 by drduhe in https://github.com/aws-solutions-library-samples/osml-model-runner/pull/114


**Full Changelog**: https://github.com/aws-solutions-library-samples/osml-model-runner/compare/v2.2.0...v2.3.0

This release of the OSML Model Runner (v2.2.0) includes several key updates and improvements. Notable changes include a new feature that counts total succeeded and failed tiles in the region status table, providing more detailed status tracking. Additionally, performance has been enhanced by changing the put_object method to upload_file, ensuring more efficient file uploads. This release also includes important bug fixes, such as deprecating the ``job_arn`` request parameter and renaming "sync" to "sink" to improve terminology consistency. Minor updates, such as a revised ``.gitignore`` file, round out this release.

Breaking Changes:
N/A

Limitations:
N/A

New Dependency:
N/A

Pull Requests Merged
* feature: count total tiles succeeded and failed tiles in the region status table by duncanBotti in https://github.com/aws-solutions-library-samples/osml-model-runner/pull/80
* chore: updating .gitignore file by drduhe in https://github.com/aws-solutions-library-samples/osml-model-runner/pull/82
* fix: deprecate job_arn request parameter by RanbirAulakh in https://github.com/aws-solutions-library-samples/osml-model-runner/pull/83
* fix: rename sync to sink by markveerman in https://github.com/aws-solutions-library-samples/osml-model-runner/pull/84
* fix: change put_object to upload_file to improve performance by RanbirAulakh in https://github.com/aws-solutions-library-samples/osml-model-runner/pull/85
* build: version update to v2.2.0 by drduhe in https://github.com/aws-solutions-library-samples/osml-model-runner/pull/86

New Contributors
* duncanBotti made their first contribution in https://github.com/aws-solutions-library-samples/osml-model-runner/pull/80
* markveerman made their first contribution in https://github.com/aws-solutions-library-samples/osml-model-runner/pull/84

**Full Changelog**: https://github.com/aws-solutions-library-samples/osml-model-runner/compare/v2.1.1...v2.1.2

What's Changed
* build(fix): Add ref tag to cut submodule PR to guidance repo by RanbirAulakh in https://github.com/aws-solutions-library-samples/osml-model-runner/pull/76
* fix: remove broken classification property from sourceMetadata by edparris in https://github.com/aws-solutions-library-samples/osml-model-runner/pull/78
* build: version update to v2.1.1 by RanbirAulakh in https://github.com/aws-solutions-library-samples/osml-model-runner/pull/79


**Full Changelog**: https://github.com/aws-solutions-library-samples/osml-model-runner/compare/v2.1.0...v2.1.1

The latest updates to the `osml-model-runner` repository bring several enhancements and maintenance tasks. Notably, copyright information has been updated by jtblack-aws, ensuring compliance and accuracy. Additionally, jtblack-aws has refactored code, transitioning from the .format() method to f-strings, improving code readability and efficiency. drduhe has contributed by updating the project for future work and enhancing its build process through updates to GitHub Actions. These collaborative efforts reflect the ongoing commitment to maintaining and improving the `osml-model-runner` repository.

What's Changed
* fix: updating copyright by jtblack-aws in https://github.com/aws-solutions-library-samples/osml-model-runner/pull/66
* refactor: moving from .format() to f-strings by jtblack-aws in https://github.com/aws-solutions-library-samples/osml-model-runner/pull/67
* chore: update for tbd by drduhe in https://github.com/aws-solutions-library-samples/osml-model-runner/pull/69
* build: update github actions by drduhe in https://github.com/aws-solutions-library-samples/osml-model-runner/pull/72
* chore: fix dev merge conflict w/ main branch by RanbirAulakh in https://github.com/aws-solutions-library-samples/osml-model-runner/pull/74


**Full Changelog**: https://github.com/aws-solutions-library-samples/osml-model-runner/compare/v2.0.0...v.2.1.0

This release of the OversightML ModelRunner defines explicit data contract for the GeoJSON features returned by CV models and the updates to those feature that from the overall end-to-end processing. In prior versions of this application the properties used to track image coordinates, detected object types, and task metadata were built on conventions used by early adopters but they were not well refined standards with solid documentation. This release introduces a new Model Developer's guide to cover that information to help 3rd party teams that want to package models for use with OversightML do so in a consistent and standardized way.

Note that this version of ModelRunner should still work with CV models that work with v1.+ but the final results written to S3 or Kinesis are different. This is a breaking change for consumers of the ModelRunner results but existing CV model containers should continue to function.

What's Changed
* feat!: use well documented standards for feature properties by edparris in https://github.com/aws-solutions-library-samples/osml-model-runner/pull/64
* fix: Update Documentation / Publish workflow by RanbirAulakh in https://github.com/aws-solutions-library-samples/osml-model-runner/pull/62


**Full Changelog**: https://github.com/aws-solutions-library-samples/osml-model-runner/compare/v1.4.0...v2.0.0

The latest release of the AWS Solutions Library Samples' OSML Model Runner repository includes several significant updates and fixes. Key changes include the update all of the python logging in ModelRunner to output JSON structured log records to easily debug/root cause an issue, the addition of additional unit tests to enhance code reliability, and support a broader range of imagery that is reprocessed orthorectified imagery. These changes collectively improve the functionality, efficiency, and reliability of the OSML Model Runner.

What's Changed
* fix: merge history by drduhe in https://github.com/aws-solutions-library-samples/osml-model-runner/pull/51
* fix: test imports by jtblack-aws in https://github.com/aws-solutions-library-samples/osml-model-runner/pull/52
* fix: test organization by jtblack-aws in https://github.com/aws-solutions-library-samples/osml-model-runner/pull/53
* fix: optimize container size by drduhe in https://github.com/aws-solutions-library-samples/osml-model-runner/pull/55
* fix: updating deps by drduhe in https://github.com/aws-solutions-library-samples/osml-model-runner/pull/56
* fix: updating extents calculation by drduhe in https://github.com/aws-solutions-library-samples/osml-model-runner/pull/57
* feat: output structured logs with job context by edparris in https://github.com/aws-solutions-library-samples/osml-model-runner/pull/58
* feat: new standardized metrics with dimensions by edparris in https://github.com/aws-solutions-library-samples/osml-model-runner/pull/59


**Full Changelog**: https://github.com/aws-solutions-library-samples/osml-model-runner/compare/v.1.3.0...v1.4.0

v.1.3.0
The latest release of the AWS Solutions Library Samples' OSML Model Runner repository includes several significant updates and fixes. Key changes include the correction of an incorrect status issue on failed tiles, the addition of additional unit tests to enhance code reliability, and a fix for a bug in the HTTP detector. This release sees the implementation of an interface for generic MapReduce post-processing, indicating a move towards more versatile data processing. There are also updates in the dependencies, with both the OSML Imagery Toolkit and Shapely versions being upgraded. Lastly, there's an update in the DynamoDB helper to utilize batch writing, along with modifications to the NMS to accommodate tile overlap during runs. These changes collectively improve the functionality, efficiency, and reliability of the OSML Model Runner. There has also been efforts made to optimize the DDBHelper classes to support larger feature sets associated with large amounts of detects from noisy models.

What's Changed
* Fixing incorrect status on failed tiles by jtblack-aws in https://github.com/aws-solutions-library-samples/osml-model-runner/pull/39
* Adding dditional unit tests by jtblack-aws in https://github.com/aws-solutions-library-samples/osml-model-runner/pull/40
*Fixing http detector bug by drduhe in https://github.com/aws-solutions-library-samples/osml-model-runner/pull/41
* Implementing interface for generic mr post processing by jtblack-aws in https://github.com/aws-solutions-library-samples/osml-model-runner/pull/43
* Updating osml-imagery-toolkit and shapely version by RanbirAulakh in https://github.com/aws-solutions-library-samples/osml-model-runner/pull/45
* Updating ddb helper to use batch write and tailor NMS to run on tile overlap by drduhe in https://github.com/aws-solutions-library-samples/osml-model-runner/pull/47

New Contributors
* jtblack-aws made their first contribution in https://github.com/aws-solutions-library-samples/osml-model-runner/pull/39

**Full Changelog**: https://github.com/aws-solutions-library-samples/osml-model-runner/compare/v.1.2.0...v.1.3.0

v.1.2.0
This changelog for the repository shows a series of updates, fixes, and feature additions aimed at enhancing functionality and usability. Key updates include the modification of MapReduce to create valid SICD tiles, and several fixes like correcting tile worker coordinates and updating to toolkit version 1.1.1 with associated test fixes. The repository's contribution guidelines were also updated.

Significant features introduced include the enabling of development actions, the introduction of support for HTTP model endpoints, and the addition of segmentation support. Additionally, there was a bump in the package version to 1.1.0, indicating a significant update.

Operational improvements are evident with updates to GitHub action workflows, a change in the DockerHub name, and a new script for running the model runner locally. Also, a fix was made by adding a missing 'requests' dependency.

Lastly, the repository maintains its synergy with related projects by notifying the guidance repository for updates. A routine merge from the main to the dev branch and an update to the osml-model-runner-publish.yml file were also carried out.

What's Changed
* update mr to create valid SICD tiles by RanbirAulakh in https://github.com/aws-solutions-library-samples/osml-model-runner/pull/18
* Updating CONTRIBUTING.md by drduhe in https://github.com/aws-solutions-library-samples/osml-model-runner/pull/17
* fix: fix tile worker coords by drduhe in https://github.com/aws-solutions-library-samples/osml-model-runner/pull/21
* fix: upate to toolkit-v1.1.1 and fix tests by edparris in https://github.com/aws-solutions-library-samples/osml-model-runner/pull/23
* feature: enable dev actions by drduhe in https://github.com/aws-solutions-library-samples/osml-model-runner/pull/22
* feature: bumping package to v1.1.0 by drduhe in https://github.com/aws-solutions-library-samples/osml-model-runner/pull/25
* feat: support http model endpoints by drduhe in https://github.com/aws-solutions-library-samples/osml-model-runner/pull/28
* Update Github action workflows by RanbirAulakh in https://github.com/aws-solutions-library-samples/osml-model-runner/pull/29
* Update the dockerhub name by RanbirAulakh in https://github.com/aws-solutions-library-samples/osml-model-runner/pull/31
* feat: adding script to run model runner locally by drduhe in https://github.com/aws-solutions-library-samples/osml-model-runner/pull/30
* fix: adding requests dep by drduhe in https://github.com/aws-solutions-library-samples/osml-model-runner/pull/32
* Notify guidance repo for updates by RanbirAulakh in https://github.com/aws-solutions-library-samples/osml-model-runner/pull/33
* feature: segmentation support by drduhe in https://github.com/aws-solutions-library-samples/osml-model-runner/pull/19
* Fix/merge main to dev by drduhe in https://github.com/aws-solutions-library-samples/osml-model-runner/pull/37
* Update osml-model-runner-publish.yml by RanbirAulakh in https://github.com/aws-solutions-library-samples/osml-model-runner/pull/35