Skip to content

Commit 5528a9d

Browse files
fmigneaultfmigneault
committed
adjust more explicit links between extensions
1 parent d3e0978 commit 5528a9d

File tree

1 file changed

+32
-27
lines changed

1 file changed

+32
-27
lines changed

‎docs/legacy/ml-model.md‎

Lines changed: 32 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -3,38 +3,34 @@
33
<!-- lint disable no-undefined-references -->
44

55
> [!WARNING]
6-
> This is legacy documentation reference of [ML-Model](https://github.com/stac-extensions/ml-model)
7-
> preceding the current Machine Learning Model (MLM) extension.
6+
> This is legacy documentation reference of [ML-Model][ml-model]
7+
> preceding the current Machine Learning Model ([MLM][mlm-spec]) extension.
88
99
<!-- lint enable no-undefined-references -->
1010

1111
## Migration Table
1212

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

1717
<!-- lint disable no-undefined-references -->
1818

1919
> [!NOTE]
20-
> Only the limited set of `ml-model` fields are listed below for migration guidelines.
20+
> Only the limited set of [`ml-model`][ml-model] fields are listed below for migration guidelines.
2121
> See the full [MLM Specification](./../../README.md) for all additional fields provided to further describe models.
2222
2323
<!-- lint enable no-undefined-references -->
2424

2525
### Item Properties
2626

27-
| ML-Model Field | MLM Field | Migration Details |
28-
|----------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
29-
| `ml-model:type` <br> (`"ml-model"` constant) | *n/a* | Including the MLM URI in `stac_extensions` is sufficient to indicate that the Item is a Model. |
30-
| `ml-model:learning_approach` | *n/a* | No direct mapping. Machine Learning training approaches can be very convoluted to describe. Instead, it is recommended to employ `derived_from` collection and other STAC Extension references to describe explicitly how the model was obtained. See [Best Practices][mlm-bp] for more details. |
31-
| `ml-model:prediction_type` <br> (`string`) | `mlm:tasks` <br> (`[string]`) | ML-Model limited to a single task. MLM allows multiple. Use `["<original-mlm-task>"]` to migrate directly. |
32-
| `ml-model:architecture` | `mlm:architecture` | Direct mapping. |
33-
| `ml-model:training-processor-type` <br> `ml-model:training-os` | `mlm:framework` <br> `mlm:framework_version` <br> `mlm:accelerator` <br> `mlm:accelerator_constrained` <br> `mlm:accelerator_summary` <br> `mlm:accelerator_count` | More fields are provided to describe the subtleties of compute hardware and ML frameworks that can be intricated between them. If compute hardware imposes OS dependencies, they are typically reflected through the framework version and/or the specific accelerator. Further subtleties are permitted with [complex accelerator values][acc-type]. |
34-
35-
[acc-type]: ./../../README.md#accelerator-type-enum
36-
37-
[mlm-bp]: ./../../best-practices.md
27+
| ML-Model Field | MLM Field | Migration Details |
28+
|----------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
29+
| `ml-model:type` <br> (`"ml-model"` constant) | *n/a* | Including the MLM URI in `stac_extensions` is sufficient to indicate that the Item is a model. |
30+
| `ml-model:learning_approach` | *n/a* | No direct mapping. Machine Learning training approaches can be very convoluted to describe. Instead, it is recommended to employ `derived_from` collection and other STAC Extension references to describe explicitly how the model was obtained. See [Best Practices][mlm-bp] for more details. |
31+
| `ml-model:prediction_type` <br> (`string`) | `mlm:tasks` <br> (`[string]`) | ML-Model limited to a single task. MLM allows multiple. Use `["<original-mlm-task>"]` to migrate directly. |
32+
| `ml-model:architecture` | `mlm:architecture` | Direct mapping. |
33+
| `ml-model:training-processor-type` <br> `ml-model:training-os` | `mlm:framework` <br> `mlm:framework_version` <br> `mlm:accelerator` <br> `mlm:accelerator_constrained` <br> `mlm:accelerator_summary` <br> `mlm:accelerator_count` | More fields are provided to describe the subtleties of compute hardware and ML frameworks that can be intricated between them. If compute hardware imposes OS dependencies, they are typically reflected through the framework version and/or the specific accelerator. Further subtleties are permitted with [complex accelerator values][mlm-acc-type]. |
3834

3935
### Asset Objects
4036

@@ -45,33 +41,42 @@ are available with a prefix change with the same sematic meaning.
4541

4642
Further roles are also proposed in [MLM Asset Roles](./../../README.md#mlm-asset-roles).
4743

48-
| ML-Model Field | MLM Field | Migration Details |
49-
| ---------------------------- | ----------------------- | -------------------------------------------------------------------------------------------------------------------------------------- |
50-
| `ml-model:inference-runtime` | `mlm:inference-runtime` | Prefix change. |
51-
| `ml-model:training-runtime` | `mlm:training-runtime` | Prefix change. |
44+
| ML-Model Field | MLM Field | Migration Details |
45+
|------------------------------|-------------------------|--------------------------------------------------------------------------------------------------------------------------------------------|
46+
| `ml-model:inference-runtime` | `mlm:inference-runtime` | Prefix change. |
47+
| `ml-model:training-runtime` | `mlm:training-runtime` | Prefix change. |
5248
| `ml-model:checkpoint` | `mlm:checkpoint` | Prefix change. Recommended addition of further `mlm` properties for [Model Asset](./../../README.md#model-asset) to describe the artifact. |
5349

5450
<!-- lint disable no-undefined-references -->
5551

5652
> [!NOTE]
57-
> In the context of ML-Model, Assets providing [Inference/Training Runtimes][ml-model-runtimes]
53+
> In the context of [ML-Model][ml-model], Assets providing [Inference/Training Runtimes][ml-model-runtimes]
5854
> are strictly provided as [Docker Compose][docker-compose-file] definitions. While this is still permitted,
5955
> the MLM extension offers alternatives using any relevant definition for the model, as long as it is properly
6056
> identified by its applicable media-type. Additional recommendations and Asset property fields are provided
6157
> under [MLM Assets Objects](./../../README.md#assets-objects) for specific cases.
6258
6359
<!-- lint enable no-undefined-references -->
6460

65-
[ml-model-runtimes]: https://github.com/stac-extensions/ml-model/blob/main/README.md#inferencetraining-runtimes
66-
67-
[docker-compose-file]: https://github.com/compose-spec/compose-spec/blob/master/spec.md#compose-file
68-
6961
### Relation Types
7062

7163
| ML-Model Field | MLM Field | Migration Details |
72-
| ----------------------------------------------- | -------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
64+
|-------------------------------------------------|----------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
7365
| `ml-model:inferencing-image` | *n/a* | Deemed redundant with `mlm:inference-runtime` Asset Role. |
7466
| `ml-model:training-image` | *n/a* | Deemed redundant with `mlm:training-runtime` Asset Role. |
7567
| `ml-model:train-data` <br> `ml-model:test-data` | `derived_from` | Use one or more `derived_from` links (as many as needed with regard to data involved during the model creation. Linked data should employ `ml-aoi` as appropriate (see [ML-AOI Best Practices][mlm-ml-aoi]). |
7668

69+
70+
[mlm-acc-type]: ./../../README.md#accelerator-type-enum
71+
72+
[mlm-spec]: ./../../README.md
73+
74+
[mlm-bp]: ./../../best-practices.md
75+
7776
[mlm-ml-aoi]: ./../../best-practices.md#ml-aoi-and-label-extensions
77+
78+
[ml-model]: https://github.com/stac-extensions/ml-model
79+
80+
[ml-model-runtimes]: https://github.com/stac-extensions/ml-model/blob/main/README.md#inferencetraining-runtimes
81+
82+
[docker-compose-file]: https://github.com/compose-spec/compose-spec/blob/master/spec.md#compose-file

0 commit comments

Comments
 (0)