New Machine Learning Model Extension Version 2.0.alpha schema and (de)serialization, validation package

.gitignore

@@ -1,2 +1,3 @@
 /package-lock.json
-/node_modules
+/node_modules
+.vscode

CHANGELOG.md

@@ -6,6 +6,31 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Added
+- more Task Enum tasks
+- accelerator options
+- batch_size and hardware suggestion
+- ram_size_mb to specify model ram requirements during inference
+- added time to the Tensor object as an optional dim
+- Use common metadata Asset Object to refer to Model Artifact and artifact metadata as a Collection level object
+
+### Changed
+- selected_bands > band_names, the same human readable names used in the common metadata band objects.
+- replaced normalization:mean, etc. with statistics from STAC 1.1 common metadata
+- added pydantic models for internal schema objects in stac_model package and published to PYPI
+
+[raster-band-object]: https://github.com/stac-extensions/raster/#raster-band-object
+
+### Deprecated
+-
+
+### Removed
+- Data Object, replaced with common metadata band object which also records data_type and nodata type
+
+# TODO link release here
+
+## [Unreleased]
+
 ### Added
 - Added example model architecture summary text.
 

stac_model/.dockerignore

@@ -0,0 +1,38 @@
+# Git
+.git
+.gitignore
+.github
+
+# Docker
+.dockerignore
+
+# IDE
+.idea
+.vscode
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+**/__pycache__/
+*.pyc
+*.pyo
+*.pyd
+.Python
+*.py[cod]
+*$py.class
+.pytest_cache/
+..mypy_cache/
+
+# poetry
+.venv
+
+# C extensions
+*.so
+
+# Virtual environment
+.venv
+venv
+
+.DS_Store
+.AppleDouble
+.LSOverride
+._*

stac_model/.editorconfig

@@ -0,0 +1,24 @@
+# Check http://editorconfig.org for more information
+# This is the main config file for this project:
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+insert_final_newline = true
+indent_style = space
+indent_size = 2
+trim_trailing_whitespace = true
+
+[*.{py, pyi}]
+indent_style = space
+indent_size = 4
+
+[Makefile]
+indent_style = tab
+
+[*.md]
+trim_trailing_whitespace = false
+
+[*.{diff,patch}]
+trim_trailing_whitespace = false

stac_model/.github/.stale.yml

@@ -0,0 +1,17 @@
+# Number of days of inactivity before an issue becomes stale
+daysUntilStale: 120
+# Number of days of inactivity before a stale issue is closed
+daysUntilClose: 30
+# Issues with these labels will never be considered stale
+exemptLabels:
+  - pinned
+  - security
+# Label to use when marking an issue as stale
+staleLabel: stale
+# Comment to post when marking an issue as stale. Set to `false` to disable
+markComment: >
+  This issue has been automatically marked as stale because it has not had
+  recent activity. It will be closed if no further activity occurs. Thank you
+  for your contributions.
+# Comment to post when closing a stale issue. Set to `false` to disable
+closeComment: false

stac_model/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,42 @@
+---
+name: ":bug: Bug report"
+about: If something isn't working 🔧
+title: ''
+labels: bug, needs-triage
+assignees:
+---
+
+## :bug: Bug Report
+
+<!-- A clear and concise description of what the bug is. -->
+
+## :microscope: How To Reproduce
+
+Steps to reproduce the behaviour:
+
+1. ...
+
+### Code sample
+
+<!-- If applicable, attach a minimal code sample to reproduce the described issue. -->
+
+### Environment
+
+* OS: [e.g. Linux / Windows / macOS]
+* Python version, get it with:
+
+```bash
+python --version
+```
+
+### Screenshots
+
+<!-- If applicable, add screenshots to help explain your problem. -->
+
+## :chart_with_upwards_trend: Expected behavior
+
+<!-- A clear and concise description of what you expected to happen. -->
+
+## :paperclip: Additional context
+
+<!-- Add any other context about the problem here. -->

stac_model/.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,3 @@
+# Configuration: https://help.github.com/en/github/building-a-strong-community/configuring-issue-templates-for-your-repository
+
+blank_issues_enabled: false

stac_model/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,23 @@
+---
+name: ":rocket: Feature request"
+about: Suggest an idea for this project 🏖
+title: ''
+labels: enhancement, needs-triage
+assignees:
+---
+
+## :rocket: Feature Request
+
+<!-- A clear and concise description of the feature proposal. -->
+
+## :sound: Motivation
+
+<!-- Please describe the motivation for this proposal, such as the problem it solves, the intended users for the feature and what does success look like and how we can measure that. -->
+
+## :satellite: Alternatives
+
+<!-- A clear and concise description of any alternative solutions or features you've considered. -->
+
+## :paperclip: Additional context
+
+<!-- Add any other context or screenshots about the feature request here. -->

stac_model/.github/ISSUE_TEMPLATE/question.md

@@ -0,0 +1,28 @@
+---
+name: "red_question_mark Question"
+about: Ask a question about this project 🎓
+title: ''
+labels: question, needs-triage
+assignees:
+---
+
+## Checklist
+
+<!-- Mark with an `x` all the checkboxes that apply (like `[x]`) -->
+
+- [ ] I've searched the project's [`issues`][1], looking for the following terms:
+  - [...]
+
+## :question: Question
+
+<!-- What is your question -->
+
+How can I [...]?
+
+Is it possible to [...]?
+
+## :paperclip: Additional context
+
+<!-- Add any other context or screenshots about the feature request here. -->
+
+[1]: https://github.com/rbavery/stac-model/issues

stac_model/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,31 @@
+## Description
+
+<!-- Add a more detailed description of the changes if needed. -->
+
+## Related Issue
+
+<!-- If your PR refers to a related issue, link it here. -->
+
+## Type of Change
+
+<!-- Mark with an `x` all the checkboxes that apply (like `[x]`) -->
+
+- [ ] :books: Examples, docs, tutorials or dependencies update;
+- [ ] :wrench: Bug fix (non-breaking change which fixes an issue);
+- [ ] :clinking_glasses: Improvement (non-breaking change which improves an existing feature);
+- [ ] :rocket: New feature (non-breaking change which adds functionality);
+- [ ] :boom: Breaking change (fix or feature that would cause existing functionality to change);
+- [ ] :closed_lock_with_key: Security fix.
+
+## Checklist
+
+<!-- Mark with an `x` all the checkboxes that apply (like `[x]`) -->
+
+- [ ] I've read the [`CODE_OF_CONDUCT.md`][1] document;
+- [ ] I've read the [`CONTRIBUTING.md`][2] guide;
+- [ ] I've updated the code style using `make codestyle`;
+- [ ] I've written tests for all new methods and classes that I created;
+- [ ] I've written the docstring in `Google` format for all the methods and classes that I used.
+
+[1]: https://github.com/rbavery/stac-model/blob/master/CODE_OF_CONDUCT.md
+[2]: https://github.com/rbavery/stac-model/blob/master/CONTRIBUTING.md

stac_model/.github/dependabot.yml

@@ -0,0 +1,35 @@
+# Configuration: https://dependabot.com/docs/config-file/
+# Docs: https://docs.github.com/en/github/administering-a-repository/keeping-your-dependencies-updated-automatically
+
+version: 2
+
+updates:
+  - package-ecosystem: "pip"
+    directory: "/"
+    schedule:
+      interval: "monthly"
+    allow:
+      - dependency-type: "all"
+    commit-message:
+      prefix: ":arrow_up:"
+    open-pull-requests-limit: 5
+
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "monthly"
+    allow:
+      - dependency-type: "all"
+    commit-message:
+      prefix: ":arrow_up:"
+    open-pull-requests-limit: 5
+
+  - package-ecosystem: "docker"
+    directory: "/docker"
+    schedule:
+      interval: "monthly"
+    allow:
+      - dependency-type: "all"
+    commit-message:
+      prefix: ":arrow_up:"
+    open-pull-requests-limit: 5

stac_model/.github/release-drafter.yml

@@ -0,0 +1,28 @@
+# Release drafter configuration https://github.com/release-drafter/release-drafter#configuration
+# Emojis were chosen to match the https://gitmoji.dev/
+
+name-template: "v$NEXT_PATCH_VERSION"
+tag-template: "v$NEXT_PATCH_VERSION"
+
+categories:
+  - title: ":rocket: Features"
+    labels: [enhancement, feature]
+  - title: ":wrench: Fixes & Refactoring"
+    labels: [bug, refactoring, bugfix, fix]
+  - title: ":package: Build System & CI/CD"
+    labels: [build, ci, testing]
+  - title: ":boom: Breaking Changes"
+    labels: [breaking]
+  - title: ":memo: Documentation"
+    labels: [documentation]
+  - title: ":arrow_up: Dependencies updates"
+    labels: [dependencies]
+
+template: |
+  ## What's Changed
+
+  $CHANGES
+
+  ## :busts_in_silhouette: List of contributors
+
+  $CONTRIBUTORS

stac_model/.github/workflows/build.yml

@@ -0,0 +1,44 @@
+
+# UPDATEME to suit your project's workflow
+name: build
+
+on: [push, pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.10", "3.11"]
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/[email protected]
+      with:
+        python-version: ${{ matrix.python-version }}
+
+    - name: Install poetry
+      run: make poetry-download
+
+    - name: Set up cache
+      uses: actions/[email protected]
+      with:
+        path: .venv
+        key: venv-${{ matrix.python-version }}-${{ hashFiles('pyproject.toml') }}-${{ hashFiles('poetry.lock') }}
+    - name: Install dependencies
+      run: |
+        poetry config virtualenvs.in-project true
+        poetry install
+
+    - name: Run style checks
+      run: |
+        make check-codestyle
+
+    - name: Run tests
+      run: |
+        make test
+
+    - name: Run safety checks
+      run: |
+        make check-safety

stac_model/.github/workflows/greetings.yml

@@ -0,0 +1,16 @@
+name: Greetings
+
+on: [pull_request, issues]
+
+jobs:
+  greeting:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/first-interaction@v1
+      with:
+        repo-token: ${{ secrets.GITHUB_TOKEN }}
+        pr-message:  'Hello @${{ github.actor }}, thank you for submitting a PR! We will respond as soon as possible.'
+        issue-message: |
+          Hello @${{ github.actor }}, thank you for your interest in our work!
+
+          If this is a bug report, please provide screenshots and **minimum viable code to reproduce your issue**, otherwise we can not help you.

stac_model/.github/workflows/release-drafter.yml

@@ -0,0 +1,16 @@
+name: Release Drafter
+
+on:
+  push:
+    # branches to consider in the event; optional, defaults to all
+    branches:
+      - main
+
+jobs:
+  update_release_draft:
+    runs-on: ubuntu-latest
+    steps:
+      # Drafts your next Release notes as Pull Requests are merged into "master"
+      - uses: release-drafter/[email protected]
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}