stac-model 0.1.0__tar.gz

stac_model-0.1.0/LICENSE

@@ -0,0 +1,207 @@
+Apache License
+Version 2.0, January 2004
+http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+    "License" shall mean the terms and conditions for use, reproduction, and
+    distribution as defined by Sections 1 through 9 of this document.
+
+    "Licensor" shall mean the copyright owner or entity authorized by the
+    copyright owner that is granting the License.
+
+    "Legal Entity" shall mean the union of the acting entity and all other
+    entities that control, are controlled by, or are under common control with
+    that entity. For the purposes of this definition, "control" means (i) the
+    power, direct or indirect, to cause the direction or management of such
+    entity, whether by contract or otherwise, or (ii) ownership of
+    fifty percent (50%) or more of the outstanding shares, or (iii) beneficial
+    ownership of such entity.
+
+    "You" (or "Your") shall mean an individual or Legal Entity exercising
+    permissions granted by this License.
+
+    "Source" form shall mean the preferred form for making modifications,
+    including but not limited to software source code, documentation source,
+    and configuration files.
+
+    "Object" form shall mean any form resulting from mechanical transformation
+    or translation of a Source form, including but not limited to compiled
+    object code, generated documentation, and conversions to
+    other media types.
+
+    "Work" shall mean the work of authorship, whether in Source or Object
+    form, made available under the License, as indicated by a copyright notice
+    that is included in or attached to the work (an example is provided in the
+    Appendix below).
+
+    "Derivative Works" shall mean any work, whether in Source or Object form,
+    that is based on (or derived from) the Work and for which the editorial
+    revisions, annotations, elaborations, or other modifications represent,
+    as a whole, an original work of authorship. For the purposes of this
+    License, Derivative Works shall not include works that remain separable
+    from, or merely link (or bind by name) to the interfaces of, the Work and
+    Derivative Works thereof.
+
+    "Contribution" shall mean any work of authorship, including the original
+    version of the Work and any modifications or additions to that Work or
+    Derivative Works thereof, that is intentionally submitted to Licensor for
+    inclusion in the Work by the copyright owner or by an individual or
+    Legal Entity authorized to submit on behalf of the copyright owner.
+    For the purposes of this definition, "submitted" means any form of
+    electronic, verbal, or written communication sent to the Licensor or its
+    representatives, including but not limited to communication on electronic
+    mailing lists, source code control systems, and issue tracking systems
+    that are managed by, or on behalf of, the Licensor for the purpose of
+    discussing and improving the Work, but excluding communication that is
+    conspicuously marked or otherwise designated in writing by the copyright
+    owner as "Not a Contribution."
+
+    "Contributor" shall mean Licensor and any individual or Legal Entity on
+    behalf of whom a Contribution has been received by Licensor and
+    subsequently incorporated within the Work.
+
+2. Grant of Copyright License.
+
+    Subject to the terms and conditions of this License, each Contributor
+    hereby grants to You a perpetual, worldwide, non-exclusive, no-charge,
+    royalty-free, irrevocable copyright license to reproduce, prepare
+    Derivative Works of, publicly display, publicly perform, sublicense,
+    and distribute the Work and such Derivative Works in
+    Source or Object form.
+
+3. Grant of Patent License.
+
+    Subject to the terms and conditions of this License, each Contributor
+    hereby grants to You a perpetual, worldwide, non-exclusive, no-charge,
+    royalty-free, irrevocable (except as stated in this section) patent
+    license to make, have made, use, offer to sell, sell, import, and
+    otherwise transfer the Work, where such license applies only to those
+    patent claims licensable by such Contributor that are necessarily
+    infringed by their Contribution(s) alone or by combination of their
+    Contribution(s) with the Work to which such Contribution(s) was submitted.
+    If You institute patent litigation against any entity (including a
+    cross-claim or counterclaim in a lawsuit) alleging that the Work or a
+    Contribution incorporated within the Work constitutes direct or
+    contributory patent infringement, then any patent licenses granted to
+    You under this License for that Work shall terminate as of the date such
+    litigation is filed.
+
+4. Redistribution.
+
+    You may reproduce and distribute copies of the Work or Derivative Works
+    thereof in any medium, with or without modifications, and in Source or
+    Object form, provided that You meet the following conditions:
+
+    1. You must give any other recipients of the Work or Derivative Works a
+    copy of this License; and
+
+    2. You must cause any modified files to carry prominent notices stating
+    that You changed the files; and
+
+    3. You must retain, in the Source form of any Derivative Works that You
+    distribute, all copyright, patent, trademark, and attribution notices from
+    the Source form of the Work, excluding those notices that do not pertain
+    to any part of the Derivative Works; and
+
+    4. If the Work includes a "NOTICE" text file as part of its distribution,
+    then any Derivative Works that You distribute must include a readable copy
+    of the attribution notices contained within such NOTICE file, excluding
+    those notices that do not pertain to any part of the Derivative Works,
+    in at least one of the following places: within a NOTICE text file
+    distributed as part of the Derivative Works; within the Source form or
+    documentation, if provided along with the Derivative Works; or, within a
+    display generated by the Derivative Works, if and wherever such
+    third-party notices normally appear. The contents of the NOTICE file are
+    for informational purposes only and do not modify the License.
+    You may add Your own attribution notices within Derivative Works that You
+    distribute, alongside or as an addendum to the NOTICE text from the Work,
+    provided that such additional attribution notices cannot be construed
+    as modifying the License.
+
+    You may add Your own copyright statement to Your modifications and may
+    provide additional or different license terms and conditions for use,
+    reproduction, or distribution of Your modifications, or for any such
+    Derivative Works as a whole, provided Your use, reproduction, and
+    distribution of the Work otherwise complies with the conditions
+    stated in this License.
+
+5. Submission of Contributions.
+
+    Unless You explicitly state otherwise, any Contribution intentionally
+    submitted for inclusion in the Work by You to the Licensor shall be under
+    the terms and conditions of this License, without any additional
+    terms or conditions. Notwithstanding the above, nothing herein shall
+    supersede or modify the terms of any separate license agreement you may
+    have executed with Licensor regarding such Contributions.
+
+6. Trademarks.
+
+    This License does not grant permission to use the trade names, trademarks,
+    service marks, or product names of the Licensor, except as required for
+    reasonable and customary use in describing the origin of the Work and
+    reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty.
+
+    Unless required by applicable law or agreed to in writing, Licensor
+    provides the Work (and each Contributor provides its Contributions)
+    on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
+    either express or implied, including, without limitation, any warranties
+    or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS
+    FOR A PARTICULAR PURPOSE. You are solely responsible for determining the
+    appropriateness of using or redistributing the Work and assume any risks
+    associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability.
+
+    In no event and under no legal theory, whether in tort
+    (including negligence), contract, or otherwise, unless required by
+    applicable law (such as deliberate and grossly negligent acts) or agreed
+    to in writing, shall any Contributor be liable to You for damages,
+    including any direct, indirect, special, incidental, or consequential
+    damages of any character arising as a result of this License or out of
+    the use or inability to use the Work (including but not limited to damages
+    for loss of goodwill, work stoppage, computer failure or malfunction,
+    or any and all other commercial damages or losses), even if such
+    Contributor has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability.
+
+    While redistributing the Work or Derivative Works thereof, You may choose
+    to offer, and charge a fee for, acceptance of support, warranty,
+    indemnity, or other liability obligations and/or rights consistent with
+    this License. However, in accepting such obligations, You may act only
+    on Your own behalf and on Your sole responsibility, not on behalf of any
+    other Contributor, and only if You agree to indemnify, defend, and hold
+    each Contributor harmless for any liability incurred by, or claims
+    asserted against, such Contributor by reason of your accepting any such
+    warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work
+
+    To apply the Apache License to your work, attach the following boilerplate
+    notice, with the fields enclosed by brackets "[]" replaced with your own
+    identifying information. (Don't include the brackets!) The text should be
+    enclosed in the appropriate comment syntax for the file format. We also
+    recommend that a file or class name and description of purpose be included
+    on the same "printed page" as the copyright notice for easier
+    identification within third-party archives.
+
+        Copyright 2023 Ryan Avery
+
+        Licensed under the Apache License, Version 2.0 (the "License");
+        you may not use this file except in compliance with the License.
+        You may obtain a copy of the License at
+
+        http://www.apache.org/licenses/LICENSE-2.0
+
+        Unless required by applicable law or agreed to in writing, software
+        distributed under the License is distributed on an "AS IS" BASIS,
+        WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
+        or implied. See the License for the specific language governing
+        permissions and limitations under the License.

stac_model-0.1.0/PKG-INFO

@@ -0,0 +1,189 @@
+Metadata-Version: 2.1
+Name: stac-model
+Version: 0.1.0
+Summary: A PydanticV2 validation and serialization libary for the STAC ML Model Extension
+Home-page: https://github.com/rbavery/stac-model
+License: Apache Software License 2.0
+Author: Ryan Avery
+Author-email: ryan@wherobots.com
+Requires-Python: >=3.10,<4.0
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: License :: Other/Proprietary License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Dist: numpy (>=1.26.2,<2.0.0)
+Requires-Dist: pydantic (>=2.3.0,<2.4.0)
+Requires-Dist: pydantic-core (>=2,<3)
+Requires-Dist: rich (>=12.6.0,<13.0.0)
+Requires-Dist: typer[all] (>=0.7.0,<0.8.0)
+Project-URL: Repository, https://github.com/rbavery/stac-model
+Description-Content-Type: text/markdown
+
+# stac-model
+
+<div align="center">
+
+[![Python support][bp1]][bp2]
+[![PyPI Release][bp3]][bp2]
+[![Repository][bscm1]][bp4]
+[![Releases][bscm2]][bp5]
+[![Docs][bdoc1]][bdoc2]
+
+[![Contributions Welcome][bp8]][bp9]
+
+[![Poetry][bp11]][bp12]
+[![Pre-commit][bp15]][bp16]
+[![Semantic versions][blic3]][bp5]
+[![Pipelines][bscm6]][bscm7]
+
+_A PydanticV2 validation and serialization library for the STAC ML Model Extension_
+
+</div>
+
+## Installation
+
+```bash
+pip install -U stac-model
+```
+
+or install with `Poetry`:
+
+```bash
+poetry add stac-model
+```
+Then you can run
+
+```bash
+stac-model --help
+```
+
+or with `Poetry`:
+
+```bash
+poetry run stac-model --help
+```
+
+## Creating an example metadata json
+
+```
+poetry run stac-model
+```
+
+This will make an example example.json metadata file for an example model.
+
+Currently this looks like
+
+```
+{
+  "signatures": {
+    "inputs": [
+      {
+        "name": "input_tensor",
+        "dtype": "float32",
+        "shape": [
+          -1,
+          13,
+          64,
+          64
+        ]
+      }
+    ],
+    "outputs": [
+      {
+        "name": "output_tensor",
+        "dtype": "float32",
+        "shape": [
+          -1,
+          10
+        ]
+      }
+    ],
+    "params": null
+  },
+  "artifact": {
+    "path": "s3://example/s3/uri/model.pt",
+    "additional_files": null
+  },
+  "id": "3fa03dceb4004b6e8a9e8591e4b3a99d",
+  "class_map": {
+    "class_to_label_id": {
+      "Annual Crop": 0,
+      "Forest": 1,
+      "Herbaceous Vegetation": 2,
+      "Highway": 3,
+      "Industrial Buildings": 4,
+      "Pasture": 5,
+      "Permanent Crop": 6,
+      "Residential Buildings": 7,
+      "River": 8,
+      "SeaLake": 9
+    }
+  },
+  "runtime_config": null,
+  "name": "eurosat",
+  "ml_model_type": null,
+  "ml_model_processor_type": "cpu",
+  "ml_model_learning_approach": null,
+  "ml_model_prediction_type": null,
+  "ml_model_architecture": null
+}
+```
+
+## :chart_with_upwards_trend: Releases
+
+You can see the list of available releases on the [GitHub Releases][r1] page.
+
+
+[![License][blic1]][blic2]
+
+This project is licenced under the terms of the `Apache Software License 2.0` licence. See [LICENCE][blic2] for more details.
+
+
+## Credits [![Python project templated from galactipy.][bp6]][bp7]
+
+This project was generated with [`galactipy`][bp7].
+
+<!-- Anchors -->
+
+[bp1]: https://img.shields.io/pypi/pyversions/stac-model?style=for-the-badge
+[bp2]: https://pypi.org/project/stac-model/
+[bp3]: https://img.shields.io/pypi/v/stac-model?style=for-the-badge&logo=pypi&color=3775a9
+[bp4]: https://github.com/stac-extensions/stac-model
+[bp5]: https://github.com/stac-extensions/stac-model/releases
+[bp6]: https://img.shields.io/badge/made%20with-galactipy%20%F0%9F%8C%8C-179287?style=for-the-badge&labelColor=193A3E
+[bp7]: https://kutt.it/7fYqQl
+[bp8]: https://img.shields.io/static/v1.svg?label=Contributions&message=Welcome&color=0059b3&style=for-the-badge
+[bp9]: https://github.com/stac-extensions/stac-model/blob/main/CONTRIBUTING.md
+[bp11]: https://img.shields.io/endpoint?url=https://python-poetry.org/badge/v0.json&style=for-the-badge
+[bp12]: https://python-poetry.org/
+
+[bp15]: https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white&style=for-the-badge
+[bp16]: https://github.com/stac-extensions/stac-model/blob/main/.pre-commit-config.yaml
+
+[blic1]: https://img.shields.io/github/license/stac-extensions/stac-model?style=for-the-badge
+[blic2]: https://github.com/stac-extensions/stac-model/blob/main/LICENCE
+[blic3]: https://img.shields.io/badge/%F0%9F%93%A6-semantic%20versions-4053D6?style=for-the-badge
+
+[r1]: https://github.com/stac-extensions/stac-model/releases
+
+[bscm1]: https://img.shields.io/badge/GitHub-100000?style=for-the-badge&logo=github&logoColor=white
+[bscm2]: https://img.shields.io/github/v/release/stac-extensions/stac-model?style=for-the-badge&logo=semantic-release&color=347d39
+[bscm6]: https://img.shields.io/github/actions/workflow/status/stac-extensions/stac-model/build.yml?style=for-the-badge&logo=github
+[bscm7]: https://github.com/stac-extensions/stac-model/actions/workflows/build.yml
+
+[hub1]: https://docs.github.com/en/code-security/dependabot/dependabot-version-updates/configuring-dependabot-version-updates#enabling-dependabot-version-updates
+[hub2]: https://github.com/marketplace/actions/close-stale-issues
+[hub5]: https://github.com/stac-extensions/stac-model/blob/main/.github/workflows/build.yml
+[hub6]: https://docs.github.com/en/code-security/dependabot
+[hub8]: https://github.com/stac-extensions/stac-model/blob/main/.github/release-drafter.yml
+[hub9]: https://github.com/stac-extensions/stac-model/blob/main/.github/.stale.yml
+
+[bdoc1]: https://img.shields.io/badge/docs-github%20pages-0a507a?style=for-the-badge
+[bdoc2]: https://stac-extensions.github.io/stac-model
+

stac_model-0.1.0/README.md

@@ -0,0 +1,161 @@
+# stac-model
+
+<div align="center">
+
+[![Python support][bp1]][bp2]
+[![PyPI Release][bp3]][bp2]
+[![Repository][bscm1]][bp4]
+[![Releases][bscm2]][bp5]
+[![Docs][bdoc1]][bdoc2]
+
+[![Contributions Welcome][bp8]][bp9]
+
+[![Poetry][bp11]][bp12]
+[![Pre-commit][bp15]][bp16]
+[![Semantic versions][blic3]][bp5]
+[![Pipelines][bscm6]][bscm7]
+
+_A PydanticV2 validation and serialization library for the STAC ML Model Extension_
+
+</div>
+
+## Installation
+
+```bash
+pip install -U stac-model
+```
+
+or install with `Poetry`:
+
+```bash
+poetry add stac-model
+```
+Then you can run
+
+```bash
+stac-model --help
+```
+
+or with `Poetry`:
+
+```bash
+poetry run stac-model --help
+```
+
+## Creating an example metadata json
+
+```
+poetry run stac-model
+```
+
+This will make an example example.json metadata file for an example model.
+
+Currently this looks like
+
+```
+{
+  "signatures": {
+    "inputs": [
+      {
+        "name": "input_tensor",
+        "dtype": "float32",
+        "shape": [
+          -1,
+          13,
+          64,
+          64
+        ]
+      }
+    ],
+    "outputs": [
+      {
+        "name": "output_tensor",
+        "dtype": "float32",
+        "shape": [
+          -1,
+          10
+        ]
+      }
+    ],
+    "params": null
+  },
+  "artifact": {
+    "path": "s3://example/s3/uri/model.pt",
+    "additional_files": null
+  },
+  "id": "3fa03dceb4004b6e8a9e8591e4b3a99d",
+  "class_map": {
+    "class_to_label_id": {
+      "Annual Crop": 0,
+      "Forest": 1,
+      "Herbaceous Vegetation": 2,
+      "Highway": 3,
+      "Industrial Buildings": 4,
+      "Pasture": 5,
+      "Permanent Crop": 6,
+      "Residential Buildings": 7,
+      "River": 8,
+      "SeaLake": 9
+    }
+  },
+  "runtime_config": null,
+  "name": "eurosat",
+  "ml_model_type": null,
+  "ml_model_processor_type": "cpu",
+  "ml_model_learning_approach": null,
+  "ml_model_prediction_type": null,
+  "ml_model_architecture": null
+}
+```
+
+## :chart_with_upwards_trend: Releases
+
+You can see the list of available releases on the [GitHub Releases][r1] page.
+
+
+[![License][blic1]][blic2]
+
+This project is licenced under the terms of the `Apache Software License 2.0` licence. See [LICENCE][blic2] for more details.
+
+
+## Credits [![Python project templated from galactipy.][bp6]][bp7]
+
+This project was generated with [`galactipy`][bp7].
+
+<!-- Anchors -->
+
+[bp1]: https://img.shields.io/pypi/pyversions/stac-model?style=for-the-badge
+[bp2]: https://pypi.org/project/stac-model/
+[bp3]: https://img.shields.io/pypi/v/stac-model?style=for-the-badge&logo=pypi&color=3775a9
+[bp4]: https://github.com/stac-extensions/stac-model
+[bp5]: https://github.com/stac-extensions/stac-model/releases
+[bp6]: https://img.shields.io/badge/made%20with-galactipy%20%F0%9F%8C%8C-179287?style=for-the-badge&labelColor=193A3E
+[bp7]: https://kutt.it/7fYqQl
+[bp8]: https://img.shields.io/static/v1.svg?label=Contributions&message=Welcome&color=0059b3&style=for-the-badge
+[bp9]: https://github.com/stac-extensions/stac-model/blob/main/CONTRIBUTING.md
+[bp11]: https://img.shields.io/endpoint?url=https://python-poetry.org/badge/v0.json&style=for-the-badge
+[bp12]: https://python-poetry.org/
+
+[bp15]: https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white&style=for-the-badge
+[bp16]: https://github.com/stac-extensions/stac-model/blob/main/.pre-commit-config.yaml
+
+[blic1]: https://img.shields.io/github/license/stac-extensions/stac-model?style=for-the-badge
+[blic2]: https://github.com/stac-extensions/stac-model/blob/main/LICENCE
+[blic3]: https://img.shields.io/badge/%F0%9F%93%A6-semantic%20versions-4053D6?style=for-the-badge
+
+[r1]: https://github.com/stac-extensions/stac-model/releases
+
+[bscm1]: https://img.shields.io/badge/GitHub-100000?style=for-the-badge&logo=github&logoColor=white
+[bscm2]: https://img.shields.io/github/v/release/stac-extensions/stac-model?style=for-the-badge&logo=semantic-release&color=347d39
+[bscm6]: https://img.shields.io/github/actions/workflow/status/stac-extensions/stac-model/build.yml?style=for-the-badge&logo=github
+[bscm7]: https://github.com/stac-extensions/stac-model/actions/workflows/build.yml
+
+[hub1]: https://docs.github.com/en/code-security/dependabot/dependabot-version-updates/configuring-dependabot-version-updates#enabling-dependabot-version-updates
+[hub2]: https://github.com/marketplace/actions/close-stale-issues
+[hub5]: https://github.com/stac-extensions/stac-model/blob/main/.github/workflows/build.yml
+[hub6]: https://docs.github.com/en/code-security/dependabot
+[hub8]: https://github.com/stac-extensions/stac-model/blob/main/.github/release-drafter.yml
+[hub9]: https://github.com/stac-extensions/stac-model/blob/main/.github/.stale.yml
+
+[bdoc1]: https://img.shields.io/badge/docs-github%20pages-0a507a?style=for-the-badge
+[bdoc2]: https://stac-extensions.github.io/stac-model

stac_model-0.1.0/pyproject.toml

@@ -0,0 +1,201 @@
+
+# Poetry pyproject.toml: https://python-poetry.org/docs/pyproject/
+[build-system]
+requires = ["poetry_core>=1.0.0"]
+build-backend = "poetry.core.masonry.api"
+
+
+[tool.poetry]
+name = "stac-model"
+version = "0.1.0"
+description = "A PydanticV2 validation and serialization libary for the STAC ML Model Extension"
+readme = "README.md"
+authors = ["Ryan Avery <ryan@wherobots.com>"]
+license = "Apache Software License 2.0"
+repository = "https://github.com/rbavery/stac-model"
+homepage = "https://github.com/rbavery/stac-model"
+packages = [
+  {include = "stac_model"}
+]
+
+
+# Keywords description https://python-poetry.org/docs/pyproject/#keywords
+keywords = []  # UPDATEME with relevant keywords
+
+
+# Pypi classifiers: https://pypi.org/classifiers/
+classifiers = [  # UPDATEME with additional classifiers; remove last classifier to allow publishing on PyPI
+  "Development Status :: 3 - Alpha",
+  "Intended Audience :: Developers",
+  "Operating System :: OS Independent",
+  "Topic :: Software Development :: Libraries :: Python Modules",
+  "License :: OSI Approved :: Apache Software License",
+  "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3.10",
+  "Programming Language :: Python :: 3.11",
+]
+
+
+[tool.poetry.scripts]
+# Entry points for the package https://python-poetry.org/docs/pyproject/#scripts
+"stac-model" = "stac_model.__main__:app"
+
+
+[tool.poetry.dependencies]
+python = "^3.10"
+
+typer = {extras = ["all"], version = "^0.7.0"}
+rich = "^12.6.0"
+pydantic = "~2.3.0" # bug in post 2.3 https://github.com/pydantic/pydantic/issues/7720
+pydantic-core = "~2"
+numpy = "^1.26.2"
+
+
+[tool.poetry.group.dev.dependencies]
+mypy = "^1.0.0"
+mypy-extensions = "^0.4.3"
+pre-commit = "^2.21.0"
+bandit = "^1.7.5"
+safety = "^2.3.4"
+
+
+pydocstyle = {extras = ["toml"], version = "^6.2.0"}
+pydoclint = "^0.3.0"
+
+pytest = "^7.2.1"
+pytest-html = "^3.2.0"
+pytest-cov = "^4.1.0"
+pytest-mock = "^3.10.0"
+pytest-timeout = "^2.2.0"
+pytest-benchmark = "^4.0.0"
+pytest-sugar = "^0.9.7"
+pytest-click = "^1.1.0"
+pytest-pikachu = "^1.0.0"
+coverage = "^7.3.0"
+ruff = "^0.1.7"
+
+[tool.ruff]
+exclude = [
+    ".git",
+    "__pycache__",
+    ".mypy_cache",
+    ".tox",
+    ".venv",
+    "_build",
+    "buck-out",
+    "build",
+    "dist",
+    "env",
+    "venv"
+]
+
+
+[tool.mypy]
+# https://github.com/python/mypy
+# https://mypy.readthedocs.io/en/latest/config_file.html#using-a-pyproject-toml-file
+python_version = "3.10"
+pretty = true
+show_traceback = true
+color_output = true
+
+allow_redefinition = false
+check_untyped_defs = true
+disallow_any_generics = true
+disallow_incomplete_defs = true
+ignore_missing_imports = true
+implicit_reexport = false
+no_implicit_optional = true
+show_column_numbers = true
+show_error_codes = true
+show_error_context = true
+strict_equality = true
+strict_optional = true
+warn_no_return = true
+warn_redundant_casts = true
+warn_return_any = true
+warn_unreachable = true
+warn_unused_configs = true
+warn_unused_ignores = true
+
+plugins = [
+  "pydantic.mypy"
+]
+
+
+[tool.pydantic-mypy]
+init_forbid_extra = true
+init_typed = true
+warn_required_dynamic_aliases = true
+
+[tool.pydocstyle]
+# https://github.com/PyCQA/pydocstyle
+# http://www.pydocstyle.org/en/stable/usage.html#available-options
+convention = "google"
+
+
+[tool.pydoclint]
+# https://github.com/jsh9/pydoclint
+# https://jsh9.github.io/pydoclint/how_to_config.html
+style = "google"
+exclude = '''
+/(
+  \.git
+  | \.hg
+  | \.mypy_cache
+  | \.tox
+  | \.venv
+  | __pycache__
+  | _build
+  | buck-out
+  | build
+  | dist
+  | env
+  | venv
+)/
+'''
+
+
+[tool.pytest.ini_options]
+# https://github.com/pytest-dev/pytest
+# https://docs.pytest.org/en/6.2.x/customize.html#pyproject-toml
+# Directories that are not visited by pytest collector:
+norecursedirs =[
+  "hooks",
+  "*.egg",
+  ".eggs",
+  "dist",
+  "build",
+  "docs",
+  ".tox",
+  ".git",
+  "__pycache__"
+]
+doctest_optionflags = ["NUMBER", "NORMALIZE_WHITESPACE", "IGNORE_EXCEPTION_DETAIL"]
+timeout = 1000
+
+# Extra options:
+addopts = [
+  "--strict-markers",
+  "--tb=short",
+  "--doctest-modules",
+  "--doctest-continue-on-failure",
+  "--pikachu"
+]
+
+
+[tool.coverage.run]
+source = ["tests"]
+branch = true
+
+
+[tool.coverage.report]
+exclude_also = [
+  "def main",
+  "if __name__ == .__main__.:"
+]
+fail_under = 50
+show_missing = true
+
+
+[tool.coverage.paths]
+source = ["stac_model"]

stac_model-0.1.0/stac_model/__init__.py

@@ -0,0 +1,8 @@
+"""A PydanticV2 validation and serialization library for the STAC ML Model Extension"""
+
+from importlib import metadata
+
+try:
+    __version__ = metadata.version("stac-model")
+except metadata.PackageNotFoundError:
+    __version__ = "unknown"

stac_model-0.1.0/stac_model/__main__.py

@@ -0,0 +1,69 @@
+import typer
+from rich.console import Console
+
+from stac_model import __version__
+from stac_model.schema import *
+
+
+app = typer.Typer(
+    name="stac-model",
+    help="A PydanticV2 validation and serialization libary for the STAC ML Model Extension",
+    add_completion=False,
+)
+console = Console()
+
+
+def version_callback(print_version: bool) -> None:
+    """Print the version of the package."""
+    if print_version:
+        console.print(f"[yellow]stac-model[/] version: [bold blue]{__version__}[/]")
+        raise typer.Exit()
+
+
+@app.command(name="")
+def main(
+    print_version: bool = typer.Option(
+        None,
+        "-v",
+        "--version",
+        callback=version_callback,
+        is_eager=True,
+        help="Prints the version of the stac-model package.",
+    ),
+) -> None:
+    """Generate example spec."""
+
+    input_sig = TensorSignature(
+        name="input_tensor", dtype="float32", shape=(-1, 13, 64, 64)
+    )
+    output_sig = TensorSignature(name="output_tensor", dtype="float32", shape=(-1, 10))
+    model_sig = ModelSignature(inputs=[input_sig], outputs=[output_sig])
+    model_artifact = ModelArtifact(path="s3://example/s3/uri/model.pt")
+    class_map = ClassMap(
+        class_to_label_id={
+            "Annual Crop": 0,
+            "Forest": 1,
+            "Herbaceous Vegetation": 2,
+            "Highway": 3,
+            "Industrial Buildings": 4,
+            "Pasture": 5,
+            "Permanent Crop": 6,
+            "Residential Buildings": 7,
+            "River": 8,
+            "SeaLake": 9,
+        }
+    )
+    meta = ModelMetadata(
+        name="eurosat",
+        class_map=class_map,
+        signatures=model_sig,
+        artifact=model_artifact,
+        ml_model_processor_type="cpu",
+    )
+    json_str = meta.model_dump_json(indent=2)
+    with open("example.json", "w") as file:
+        file.write(json_str)
+    print(meta)
+
+if __name__ == "__main__":
+    app()

stac_model-0.1.0/stac_model/schema.py

@@ -0,0 +1,192 @@
+from pydantic import (
+    BaseModel,
+    Field,
+    FilePath,
+    field_validator,
+    field_serializer,
+    AnyUrl,
+    ConfigDict,
+)
+from typing import Optional
+import re
+from typing import List, Tuple, Dict, Optional, Literal, Any
+import numpy as np
+from uuid import uuid4
+# import numpy.typing as npt
+
+
+class TensorSignature(BaseModel):
+    """Tensor metadata, including the dtype (int8, float32, etc) and the tensor shape."""
+
+    name: Optional[str] = None
+    # TODO there's a couple of issues blocking numpy typing with
+    # pydantic or I'm not familiar enough with custom validators
+    # https://github.com/numpy/numpy/issues/25206
+    # dtype: npt.DTypeLike = Field(...)
+    dtype: str = Field(...)
+    shape: Tuple[int, ...] | List[int] = Field(...)
+    model_config = ConfigDict(arbitrary_types_allowed=True)
+
+    # TODO can't take numpy types for now until new pydant 2.6
+    # # NotImplementedError: Cannot check isinstance when validating from json, use a JsonOrPython validator instead.
+    # @field_serializer('dtype')
+    # def serialize_ndtype(self, dtype: np.dtype) -> str:
+    #     return dtype.name
+    # @field_validator('dtype', mode="before")
+    # @classmethod
+    # def convert_dtype(cls, v):
+    #     if isinstance(v, str):
+    #         v = np.dtype(v)
+    #     elif not isinstance(v, np.dtype):
+    #         raise ValueError(f'Expected np.dtype, received {type(v).__name__}')
+    #     return v
+
+    # @field_validator('shape')
+    # @classmethod
+    # def validate_shape(cls, v):
+    #     if not isinstance(v, (tuple, list)):
+    #         raise ValueError(f'Expected tuple or list for shape, received {type(v).__name__}')
+    #     return list(v)
+
+
+class ModelSignature(BaseModel):
+    """The name of the input tensor and accompanying tensor metadata."""
+
+    inputs: List[TensorSignature]
+    outputs: List[TensorSignature]
+    params: Optional[
+        Dict[str, int | float | str]
+    ] = None  # Or any other type that 'params' might take
+
+    class Config:
+        arbitrary_types_allowed = True
+
+    @property
+    def inputs_length(self) -> int:
+        return len(self.inputs)
+
+    @property
+    def outputs_length(self) -> int:
+        return len(self.outputs)
+
+
+class RuntimeConfig(BaseModel):
+    """TODO decide how to handle model runtime configurations. dependencies and hyperparams"""
+
+    environment: str
+
+
+class S3Path(AnyUrl):
+    allowed_schemes = {"s3"}
+    user_required = False
+    max_length = 1023
+    min_length = 8
+
+    @field_validator("url")
+    @classmethod
+    def validate_s3_url(cls, v):
+        if not v.startswith("s3://"):
+            raise ValueError("S3 path must start with s3://")
+        if len(v) < cls.min_length:
+            raise ValueError("S3 path is too short")
+        if len(v) > cls.max_length:
+            raise ValueError("S3 path is too long")
+        return v
+
+    @field_validator("host")
+    @classmethod
+    def validate_bucket_name(cls, v):
+        if not v:
+            raise ValueError("Bucket name cannot be empty")
+        if not 3 <= len(v) <= 63:
+            raise ValueError("Bucket name must be between 3 and 63 characters")
+        if not re.match(r"^[a-z0-9.\-]+$", v):
+            raise ValueError(
+                "Bucket name can only contain lowercase letters, numbers, dots, and hyphens"
+            )
+        if v.startswith("-") or v.endswith("-"):
+            raise ValueError("Bucket name cannot start or end with a hyphen")
+        if ".." in v:
+            raise ValueError("Bucket name cannot have consecutive periods")
+        return v
+
+    @field_validator("path")
+    @classmethod
+    def validate_key(cls, v):
+        if "//" in v:
+            raise ValueError("Key must not contain double slashes")
+        if "\\" in v:
+            raise ValueError("Backslashes are not standard in S3 paths")
+        if "\t" in v or "\n" in v:
+            raise ValueError("Key cannot contain tab or newline characters")
+        return v.strip("/")
+
+
+class ModelArtifact(BaseModel):
+    """Information about the model location and other additional file locations."""
+
+    path: S3Path | FilePath | str = Field(...)
+    additional_files: Optional[Dict[str, FilePath]] = None
+
+    class Config:
+        arbitrary_types_allowed = True
+
+    @field_validator("path")
+    @classmethod
+    def check_path_type(cls, v):
+        if isinstance(v, str):
+            if v.startswith("s3://"):
+                v = S3Path(url=v)
+            else:
+                v = FilePath(f=v)
+        else:
+            raise ValueError(
+                f"Expected str, S3Path, or FilePath input, received {type(v).__name__}"
+            )
+        return v
+
+
+class ClassMap(BaseModel):
+    class_to_label_id: Dict[str, int]
+
+    # Property to reverse the mapping
+    @property
+    def label_id_to_class(self) -> Dict[int, str]:
+        # Reverse the mapping
+        return {v: k for k, v in self.class_to_label_id.items()}
+
+    def get_class(self, class_id: int) -> str:
+        """Get class name from class id."""
+        if class_id not in self.label_id_to_class:
+            raise ValueError(f"Class ID '{class_id}' not found")
+        return self.label_id_to_class[class_id]
+
+    def get_label_id(self, class_name: str) -> int:
+        """Get class id from class name."""
+        if class_name not in self.class_to_label_id:
+            raise ValueError(f"Class name '{class_name}' not found")
+        return self.class_to_label_id[class_name]
+
+
+class ModelMetadata(BaseModel):
+    signatures: ModelSignature
+    artifact: ModelArtifact
+    id: str = Field(default_factory=lambda: uuid4().hex)
+    class_map: ClassMap
+
+    # Runtime configurations required to run the model.
+    # TODO requirements.txt , conda.yml, or lock files for each should be supported in future.
+    runtime_config: Optional[RuntimeConfig] = None
+
+    # the name of the model
+    name: str
+    ml_model_type: Optional[str] = None
+    ml_model_processor_type: Optional[Literal["cpu", "gpu", "tpu", "mps"]] = None
+    ml_model_learning_approach: Optional[str] = None
+    ml_model_prediction_type: Optional[
+        Literal["object-detection", "classification", "segmentation", "regression"]
+    ] = None
+    ml_model_architecture: Optional[str] = None
+
+    class Config:
+        arbitrary_types_allowed = True