aws-solutions-library-samples / osml-model-runner

MIT No Attribution
7 stars 1 forks source link

chore: cleanup tiling strategy comments for classes and tests #110

Closed drduhe closed 2 weeks ago

drduhe commented 3 weeks ago

Issue #, if available: n/a

Notes

Changes:

  1. Refactoring:

    • Added descriptive comments across all test cases to explain what each test validates.
    • Improved code organization with consistent spacing and formatting for better readability.
    • Ensured each section of the code is logically separated and easy to understand.
    • Added reST style PyDoc comments to class methods missing them.
  2. Test Clarifications:

    • For TestVariableTileTilingStrategy and TestVariableOverlapTilingStrategy:
      • Added detailed explanations of tiling strategies and feature deconfliction processes.
      • Ensured all test scenarios cover expected cases (e.g., full image, ROI, tiny images, edge tiles).
    • For TestTilingStrategy:
      • Explained the different scenarios for generating crops with various overlaps and sizes.
      • Highlighted invalid configuration checks for the chip generator, ensuring appropriate error handling.

Checklist

Before you submit a pull request, please make sure you have the following:

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.