CHANGELOG.md

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

Unreleased

Added

• n/a

Changed

• n/a

Deprecated

• The dlm-extension endpoint is itself deprecated in favor of mlm-extension (a direct fork of dlm-extension) with the corresponding schema hosted on https://crim-ca.github.io/mlm-extension/v1.0.0/schema.json.

Removed

• n/a

Fixed

• n/a

0.1.1.alpha4

Added

• more Task Enum tasks
• Model Output Object
• batch_size and hardware summary
• mlm:accelerator, mlm:accelerator_constrained, mlm:accelerator_summary to specify hardware requirements for the model
• Use common metadata Asset Object to refer to model asset and source code.
• use classification:classes in Model Output
• add scene-classification to the Enum Tasks to allow disambiguation between pixel-wise and patch-based classification

Changed

• disk_size replaced by file:size (see Best Practices - File Extension)
• memory_size under dlm:architecture moved directly under Item properties as mlm:memory_size
• replaced all hardware/accelerator/runtime definitions into distinct mlm fields directly under the STAC Item properties (top-level, not nested) to allow better search support by STAC API.
• reorganized dlm:architecture nested fields to exist at the top level of properties as mlm:name, mlm:summary and so on to provide STAC API search capabilities.
• 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
• specified rel_type to be derived_from and specify how model item or collection json should be named
• replaced all Enum Tasks names to use hyphens instead of spaces
• replaced dlm:task by mlm:tasks using an array of value instead of a single one, allowing models to represent multiple tasks they support simultaneously or interchangeably depending on context
• replace pre_processing_function and post_processing_function to use similar definitions to the Processing Extension - Expression Object such that more extended definitions of custom processors can be defined.
• updated JSON schema to reflect changes of MLM fields

Deprecated

• any dlm-prefixed field or property

Removed

• Data Object, replaced with Model Input Object that uses the name field from the common metadata band object which also records data_type and nodata type

Fixed

• n/a

v1.0.0-beta3

Added

• Added example model architecture summary text.

Changed

• Modified $id if the extension schema to refer to the expected location when eventually released (https://schemas.stacspec.org/v1.0.0-beta.3/extensions/dl-model/json-schema/schema.json).
• Replaced dtype field by data_type to better align with the corresponding field of raster:bands.
• Replaced nodata_value field by nodata to better align with the corresponding field of raster:bands.
• Refactored schema to use distinct definitions and references instead of embedding all objects within dl-model properties.
• Allow schema to contain other dlm:-prefixed elements using patternProperties and explicitly deny other additionalProperties.
• Allow class_name_mapping to be directly provided as a mapping of index-based properties and class-name values.

Deprecated

• Specifying class_name_mapping by array is deprecated. Direct mapping as an object of index to class name should be used. For backward compatibility, mapping as array and using nested objects with index and class_name properties is still permitted, although overly verbose compared to the direct mapping.

Removed

• Field nodata_value.
• Field dtype.

Fixed

• Fixed references to other STAC extensions to use the official schema links on https://stac-extensions.github.io/.
• Fixed examples to refer to local files.
• Fixed formatting of tables and descriptions in README.

v1.0.0-beta2

Added

• Initial release of the extension description and schema.

Changed

• n/a

Deprecated

• n/a

Removed

• n/a

Fixed

• n/a