Skip to content

Commit

Permalink
correct the deleted unreleased items in the CHANGELOG, woops
Browse files Browse the repository at this point in the history
  • Loading branch information
rbavery committed Dec 13, 2024
1 parent b54dd11 commit 2c3c44e
Showing 1 changed file with 26 additions and 2 deletions.
28 changes: 26 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,20 +8,44 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
## [v1.4.0](https://github.com/stac-extensions/mlm/tree/v1.4.0)

### Added
- Add better descriptions about required and recommended *MLM Asset Roles* and their implications
(fixes [#54](https://github.com/stac-extensions/mlm/issues/54)).
- Add explicit check of `value_scaling` sub-fields `minimum`, `maximum`, `mean`, `stddev`, etc. for
corresponding `type` values `min-max` and `z-score` that depend on it.
- Allow different `value_scaling` operations per band/channel/dimension as needed by the model.
- Allow a `processing:expression` for a band/channel/dimension-specific `value_scaling` operation,
granting more flexibility in the definition of input preparation in contrast to having it applied
for the entire input (but still possible).
- mlm:compile_method with options 'aot' for Ahead of Time Compilation, 'jit' for Just-In Time Compilation

### Changed
- Explicitly disallow `mlm:name`, `mlm:input`, `mlm:output` and `mlm:hyperparameters` at the Asset level.
These fields describe the model as a whole and should therefore be defined in Item properties.
- Moved `norm_type` to `value_scaling` object to better reflect the expected operation, which could be another
operation than what is typically known as "normalization" or "standardization" techniques in machine learning.
- Moved `statistics` to `value_scaling` object to better reflect their mutual `type` and additional
properties dependencies.
- moved mlm:artifact_type field value descriptions that are framework specific to best-practices section.
- expanded suggested mlm:artifact_type values to include Tensorflow/Keras

### Deprecated
- n/a

### Removed
- n/a
- Removed `norm_type` enum values that were ambiguous regarding their expected result.
Instead, a `processing:expression` should be employed to explicitly define the calculation they represent.
- Removed `norm_clip` property. It is now represented under `value_scaling` objects with a
corresponding `type` definition.
- Removed `norm_by_channel` from `mlm:input` objects. If rescaling (previously normalization in the documentation)
is a single value, broadcasting to the relevant bands should be performed implicitly.
Otherwise, the amount of `value_scaling` objects should match the number of bands or channels involved in the input.

### Fixed
- n/a
- Fix missing `mlm:artifact_type` property check for a Model Asset definition
(fixes <https://github.com/stac-extensions/mlm/issues/42>).
The `mlm:artifact_type` is now mutually and exclusively required by the corresponding Asset with `mlm:model` role.
- Fix check of disallowed unknown/undefined `mlm:`-prefixed fields
(fixes [#41](https://github.com/stac-extensions/mlm/issues/41)).

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

Expand Down

0 comments on commit 2c3c44e

Please sign in to comment.