|
8 | 8 |
|
9 | 9 | <!-- lint enable no-undefined-references --> |
10 | 10 |
|
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 |
12 | 27 |
|
13 | 28 | Following are the corresponding fields between the legacy [ML-Model][ml-model] and the current [MLM][mlm-spec] |
14 | 29 | extension, which can be used to completely migrate to the newer *Machine Leaning Model* extension providing |
15 | 30 | enhanced features and interconnectivity with other STAC extensions (see also [Best Practices][mlm-bp]). |
16 | 31 |
|
17 | 32 | <!-- lint disable no-undefined-references --> |
18 | 33 |
|
19 | | -> [!NOTE] |
| 34 | +> [!IMPORTANT] |
20 | 35 | > Only the limited set of [`ml-model`][ml-model] fields are listed below for migration guidelines. |
21 | 36 | > See the full [MLM Specification](./../../README.md) for all additional fields provided to further describe models. |
22 | 37 |
|
@@ -49,7 +64,7 @@ Further roles are also proposed in [MLM Asset Roles](./../../README.md#mlm-asset |
49 | 64 |
|
50 | 65 | <!-- lint disable no-undefined-references --> |
51 | 66 |
|
52 | | -> [!NOTE] |
| 67 | +> [!TIP] |
53 | 68 | > In the context of [ML-Model][ml-model], Assets providing [Inference/Training Runtimes][ml-model-runtimes] |
54 | 69 | > are strictly provided as [Docker Compose][docker-compose-file] definitions. While this is still permitted, |
55 | 70 | > 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 |
78 | 93 |
|
79 | 94 | [ml-model-runtimes]: https://github.com/stac-extensions/ml-model/blob/main/README.md#inferencetraining-runtimes |
80 | 95 |
|
| 96 | +[pydantic]: https://docs.pydantic.dev/latest/ |
| 97 | + |
| 98 | +[pystac]: https://pystac.readthedocs.io/en/latest/ |
| 99 | + |
81 | 100 | [docker-compose-file]: https://github.com/compose-spec/compose-spec/blob/master/spec.md#compose-file |
0 commit comments