Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,28 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

### Added

- n/a

### Changed

- n/a

### Deprecated

- n/a

### Removed

- n/a

### Fixed

- n/a

## [v1.5.0](https://github.com/stac-extensions/mlm/tree/v1.5.0)

### Added

- Add explicit JSON schema validation checks for `bands` and `variables` definitions against corresponding `"bands"`
and `"variables"` dimensions indicated in `dim_order` to ensure they are coherent. Because of this validation, the
`"bands"` and `"variables"` dimension names are now considered reserved for this purpose and cannot be employed as
Expand Down
2 changes: 1 addition & 1 deletion CITATION.cff
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ references:
authors: *authors
identifiers:
- type: url
value: "https://stac-extensions.github.io/mlm/v1.4.0/schema.json"
value: "https://stac-extensions.github.io/mlm/v1.5.0/schema.json"
description: "Latest extension URL used in 'stac_extensions' references."
- type: url
value: "https://stac-extensions.github.io/mlm/"
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
[![hackmd-github-sync-badge](https://hackmd.io/XveEXOukQ52ZdpUxT8maeA/badge)](https://hackmd.io/XveEXOukQ52ZdpUxT8maeA?both)

- **Title:** Machine Learning Model Extension
- **Identifier:** <https://stac-extensions.github.io/mlm/v1.4.0/schema.json>
- **Identifier:** <https://stac-extensions.github.io/mlm/v1.5.0/schema.json>
- **Field Name Prefix:** mlm
- **Scope:** Collection, Item, Asset, Links
- **Extension Maturity Classification:** Candidate
Expand Down
4 changes: 2 additions & 2 deletions best-practices.md
Original file line number Diff line number Diff line change
Expand Up @@ -176,7 +176,7 @@ leading to a new MLM STAC Item definition (see also [STAC Version Extension](#ve
{
"id": "stac-item-model",
"stac_extensions": [
"https://stac-extensions.github.io/mlm/v1.4.0/schema.json",
"https://stac-extensions.github.io/mlm/v1.5.0/schema.json",
"https://stac-extensions.github.io/ml-aoi/v0.2.0/schema.json"
],
"assets": {
Expand Down Expand Up @@ -251,7 +251,7 @@ that the model is properly instantiated from the expected weights, or that suffi
```json
{
"stac_extensions": [
"https://stac-extensions.github.io/mlm/v1.4.0/schema.json",
"https://stac-extensions.github.io/mlm/v1.5.0/schema.json",
"https://stac-extensions.github.io/file/v2.1.0/schema.json"
],
"assets": {
Expand Down
2 changes: 1 addition & 1 deletion examples/item_bands_expression.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"$comment": "Demonstrate the use of MLM and EO for bands description, with EO bands directly in the Model Asset.",
"stac_version": "1.0.0",
"stac_extensions": [
"https://stac-extensions.github.io/mlm/v1.4.0/schema.json",
"https://stac-extensions.github.io/mlm/v1.5.0/schema.json",
"https://stac-extensions.github.io/eo/v1.1.0/schema.json",
"https://stac-extensions.github.io/raster/v1.1.0/schema.json",
"https://stac-extensions.github.io/file/v1.0.0/schema.json",
Expand Down
2 changes: 1 addition & 1 deletion examples/item_basic.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"stac_version": "1.0.0",
"stac_extensions": [
"https://stac-extensions.github.io/mlm/v1.4.0/schema.json"
"https://stac-extensions.github.io/mlm/v1.5.0/schema.json"
],
"type": "Feature",
"id": "example-model",
Expand Down
2 changes: 1 addition & 1 deletion examples/item_datacube_variables.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"$comment": "Demonstrate the use of MLM and DataCube variables description.",
"stac_version": "1.0.0",
"stac_extensions": [
"https://stac-extensions.github.io/mlm/v1.4.0/schema.json",
"https://stac-extensions.github.io/mlm/v1.5.0/schema.json",
"https://stac-extensions.github.io/datacube/v2.3.0/schema.json",
"https://stac-extensions.github.io/file/v2.1.0/schema.json",
"https://stac-extensions.github.io/scientific/v1.0.0/schema.json"
Expand Down
2 changes: 1 addition & 1 deletion examples/item_eo_and_raster_bands.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"stac_version": "1.0.0",
"stac_extensions": [
"https://stac-extensions.github.io/mlm/v1.4.0/schema.json",
"https://stac-extensions.github.io/mlm/v1.5.0/schema.json",
"https://stac-extensions.github.io/eo/v1.1.0/schema.json",
"https://stac-extensions.github.io/raster/v1.1.0/schema.json",
"https://stac-extensions.github.io/file/v1.0.0/schema.json",
Expand Down
2 changes: 1 addition & 1 deletion examples/item_eo_bands.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"$comment": "Demonstrate the use of MLM and EO for bands description, with EO bands directly in the Model Asset.",
"stac_version": "1.0.0",
"stac_extensions": [
"https://stac-extensions.github.io/mlm/v1.4.0/schema.json",
"https://stac-extensions.github.io/mlm/v1.5.0/schema.json",
"https://stac-extensions.github.io/eo/v1.1.0/schema.json",
"https://stac-extensions.github.io/file/v1.0.0/schema.json",
"https://stac-extensions.github.io/ml-aoi/v0.2.0/schema.json"
Expand Down
2 changes: 1 addition & 1 deletion examples/item_eo_bands_summarized.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"$comment": "Demonstrate the use of MLM and EO for bands description, with EO bands summarized in the Item properties and referenced by name in the Model Asset.",
"stac_version": "1.0.0",
"stac_extensions": [
"https://stac-extensions.github.io/mlm/v1.4.0/schema.json",
"https://stac-extensions.github.io/mlm/v1.5.0/schema.json",
"https://stac-extensions.github.io/eo/v1.1.0/schema.json",
"https://stac-extensions.github.io/file/v1.0.0/schema.json",
"https://stac-extensions.github.io/ml-aoi/v0.2.0/schema.json"
Expand Down
2 changes: 1 addition & 1 deletion examples/item_multi_io.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"stac_version": "1.0.0",
"stac_extensions": [
"https://stac-extensions.github.io/mlm/v1.4.0/schema.json",
"https://stac-extensions.github.io/mlm/v1.5.0/schema.json",
"https://stac-extensions.github.io/raster/v1.1.0/schema.json",
"https://stac-extensions.github.io/file/v1.0.0/schema.json",
"https://stac-extensions.github.io/ml-aoi/v0.2.0/schema.json"
Expand Down
2 changes: 1 addition & 1 deletion examples/item_pytorch_geo_unet.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"type": "Feature",
"stac_version": "1.0.0",
"stac_extensions": [
"https://stac-extensions.github.io/mlm/v1.4.0/schema.json",
"https://stac-extensions.github.io/mlm/v1.5.0/schema.json",
"https://stac-extensions.github.io/eo/v1.1.0/schema.json"
],
"id": "pytorch_geo_unet",
Expand Down
2 changes: 1 addition & 1 deletion examples/item_raster_bands.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"stac_version": "1.0.0",
"stac_extensions": [
"https://stac-extensions.github.io/mlm/v1.4.0/schema.json",
"https://stac-extensions.github.io/mlm/v1.5.0/schema.json",
"https://stac-extensions.github.io/raster/v1.1.0/schema.json",
"https://stac-extensions.github.io/file/v1.0.0/schema.json",
"https://stac-extensions.github.io/ml-aoi/v0.2.0/schema.json"
Expand Down
2 changes: 1 addition & 1 deletion examples/torch/mlm-metadata.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
$schema: "https://stac-extensions.github.io/mlm/v1.4.0/schema.json"
$schema: "https://stac-extensions.github.io/mlm/v1.5.0/schema.json"
properties:
name: Unet
architecture: Unet
Expand Down
4 changes: 2 additions & 2 deletions json-schema/schema.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"$schema": "http://json-schema.org/draft-07/schema#",
"$id": "https://stac-extensions.github.io/mlm/v1.4.0/schema.json",
"$id": "https://stac-extensions.github.io/mlm/v1.5.0/schema.json",
"title": "Machine Learning Model STAC Extension Schema",
"description": "This object represents the metadata for a Machine Learning Model (MLM) used in STAC documents.",
"$comment": "Use 'allOf+if/then' for each 'type' to allow implementations to report more specific messages about the exact case in error (if any). Using only a 'oneOf/allOf' with the 'type' caused any incompatible 'type' to be reported first with a minimal and poorly described error by 'pystac'.",
Expand Down Expand Up @@ -119,7 +119,7 @@
"stac_extensions": {
"type": "array",
"contains": {
"const": "https://stac-extensions.github.io/mlm/v1.4.0/schema.json"
"const": "https://stac-extensions.github.io/mlm/v1.5.0/schema.json"
}
}
}
Expand Down
6 changes: 3 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
{
"name": "stac-mlm",
"version": "1.4.0",
"version": "1.5.0",
"scripts": {
"test": "npm run check-markdown && npm run check-examples",
"check-markdown": "remark . -f -r .github/remark.yaml -i .remarkignore",
"format-markdown": "remark . -f -r .github/remark.yaml -i .remarkignore -o",
"check-examples": "stac-node-validator . --lint --verbose --schemaMap https://stac-extensions.github.io/mlm/v1.4.0/schema.json=./json-schema/schema.json",
"format-examples": "stac-node-validator . --format --schemaMap https://stac-extensions.github.io/mlm/v1.4.0/schema.json=./json-schema/schema.json"
"check-examples": "stac-node-validator . --lint --verbose --schemaMap https://stac-extensions.github.io/mlm/v1.5.0/schema.json=./json-schema/schema.json",
"format-examples": "stac-node-validator . --format --schemaMap https://stac-extensions.github.io/mlm/v1.5.0/schema.json=./json-schema/schema.json"
},
"dependencies": {
"remark-cli": "^8.0.0",
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -139,7 +139,7 @@ stac-model = "stac_model.__main__:app"
# they are actually intented for versioning the MLM specification itself.
# To version 'stac-model', use the 'bump-my-version bump' operation using the 'stac-model.bump.toml' file.
# See also https://github.com/stac-extensions/mlm/blob/main/CONTRIBUTING.md#building-and-releasing
current_version = "1.4.0"
current_version = "1.5.0"
parse = "(?P<major>\\d+)\\.(?P<minor>\\d+)\\.(?P<patch>\\d+)"
serialize = ["{major}.{minor}.{patch}"]
search = "{current_version}"
Expand Down
2 changes: 1 addition & 1 deletion stac_model/schema.py
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@
)

SchemaName = Literal["mlm"]
SCHEMA_URI: str = "https://stac-extensions.github.io/mlm/v1.4.0/schema.json"
SCHEMA_URI: str = "https://stac-extensions.github.io/mlm/v1.5.0/schema.json"
PREFIX = f"{get_args(SchemaName)[0]}:"


Expand Down
2 changes: 1 addition & 1 deletion tests/torch/metadata.yaml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# This file is used in torch export tests to check that the metadata is
# validated using the MLModelMetadata Pydantic model and the export
# functions work as expected.
$schema: "https://stac-extensions.github.io/mlm/v1.4.0/schema.json"
$schema: "https://stac-extensions.github.io/mlm/v1.5.0/schema.json"
properties:
name: FTW 3 Class Unet
architecture: torchgeo.models.unet
Expand Down