Skip to content

Commit f975453

Browse files
committed
1 parent a670b84 commit f975453

File tree

1 file changed

+22
-3
lines changed

1 file changed

+22
-3
lines changed

docs/legacy/ml-model.md

Lines changed: 22 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,15 +8,30 @@
88
99
<!-- lint enable no-undefined-references -->
1010

11-
## Migration Table
11+
## Notable Differences
12+
13+
- The [MLM][mlm-spec] Extension covers more details at both the [Item](#item-properties) and [Asset](#asset-objects)
14+
levels, making it easier to describe and use model metadata.
15+
- The [MLM][mlm-spec] extension covers Runtime requirements within the [Container Asset](./../../README.md#container-asset),
16+
while the [ML-Model][ml-model] extension records [similar information][ml-model-runtimes] in
17+
the `ml-model:inference-runtime` or `ml-model:training-runtime` [Asset Roles](#roles).
18+
- The [MLM][mlm-spec] extension has a corresponding Python library, [`stac-model`](https://pypi.org/project/stac-model/)
19+
which can be used to create and validate MLM metadata.
20+
An example of the library in action is [provided in examples](./../../stac_model/examples.py).
21+
The [ML-Model][ml-model] extension does not support this and requires the JSON to be written manually
22+
by interpreting the JSON Schema or existing examples.
23+
- The [MLM][mlm-spec] extension is easier to maintain and enhance in a fast moving ML ecosystem thanks to it's use
24+
of [pydantic][pydantic] models, while still being compatible with [pystac][pystac] for extension and STAc core validation.
25+
26+
## Migration Tables
1227

1328
Following are the corresponding fields between the legacy [ML-Model][ml-model] and the current [MLM][mlm-spec]
1429
extension, which can be used to completely migrate to the newer *Machine Leaning Model* extension providing
1530
enhanced features and interconnectivity with other STAC extensions (see also [Best Practices][mlm-bp]).
1631

1732
<!-- lint disable no-undefined-references -->
1833

19-
> [!NOTE]
34+
> [!IMPORTANT]
2035
> Only the limited set of [`ml-model`][ml-model] fields are listed below for migration guidelines.
2136
> See the full [MLM Specification](./../../README.md) for all additional fields provided to further describe models.
2237
@@ -49,7 +64,7 @@ Further roles are also proposed in [MLM Asset Roles](./../../README.md#mlm-asset
4964

5065
<!-- lint disable no-undefined-references -->
5166

52-
> [!NOTE]
67+
> [!TIP]
5368
> In the context of [ML-Model][ml-model], Assets providing [Inference/Training Runtimes][ml-model-runtimes]
5469
> are strictly provided as [Docker Compose][docker-compose-file] definitions. While this is still permitted,
5570
> the MLM extension offers alternatives using any relevant definition for the model, as long as it is properly
@@ -78,4 +93,8 @@ Further roles are also proposed in [MLM Asset Roles](./../../README.md#mlm-asset
7893

7994
[ml-model-runtimes]: https://github.com/stac-extensions/ml-model/blob/main/README.md#inferencetraining-runtimes
8095

96+
[pydantic]: https://docs.pydantic.dev/latest/
97+
98+
[pystac]: https://pystac.readthedocs.io/en/latest/
99+
81100
[docker-compose-file]: https://github.com/compose-spec/compose-spec/blob/master/spec.md#compose-file

0 commit comments

Comments
 (0)