Skip to content
This repository has been archived by the owner on Oct 2, 2024. It is now read-only.

Commit

Permalink
add details about link releation types
Browse files Browse the repository at this point in the history
  • Loading branch information
fmigneault committed Mar 30, 2024
1 parent edcc8a2 commit 06ee0ef
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 4 deletions.
13 changes: 9 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -401,11 +401,16 @@ See the documentation for the
## Relation types

The following types should be used as applicable `rel` types in the
[Link Object](https://github.com/radiantearth/stac-spec/tree/master/item-spec/item-spec.md#link-object) of STAC Items describing Band Assets used with a model.
[Link Object](https://github.com/radiantearth/stac-spec/tree/master/item-spec/item-spec.md#link-object)
of STAC Items describing Band Assets that result from the inference of a model described by the MLM extension.

| Type | Description |
|--------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| derived_from | This link points to <model>_item.json or <model>_collection.json. Replace <model> with the unique [`mlm:name`](#item-properties-and-collection-fields) field's value. |
| Type | Description |
|--------------|----------------------------------------------------------------------------------------------------------------------------------------------|
| derived_from | This link points to a STAC Collection or Item using MLM, using the corresponding [`mlm:name`](#item-properties-and-collection-fields) value. |

Note that a derived product from model inference described by STAC should also consider using
additional indications that it came of a model, such as described by
the [Best Practices - Processing Extension](best-practices.md#processing-extension).

## Contributing

Expand Down
20 changes: 20 additions & 0 deletions best-practices.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,7 @@ A potential representation of a STAC Asset could be as follows:
```json
{
"model-output": {
"mlm:name": "<name-in-MLM-STAC-Item",
"processing:level": "L4",
"processing:expression": {
"format": "stac-mlm",
Expand All @@ -72,6 +73,25 @@ A potential representation of a STAC Asset could be as follows:
}
```

Furthermore, the STAC Item representing the derived product could also include
a [Link Object](https://github.com/radiantearth/stac-spec/tree/master/item-spec/item-spec.md#link-object)
referring back to the MLM definition using `rel: derived_from`, as described in
[MLM Relation Types](README.md#relation-types). Such a link would like something like the following:

```json
{
"links": [
{
"rel": "derived_from",
"type": "application/geo+json",
"href": "<URI-to-MLM-STAC-Item>",
"mlm:name": "<name-in-MLM-STAC-Item",
"processing:level": "L4"
}
]
}
```

### ML-AOI and Label Extensions

Supervised machine learning models will typically employ a dataset of training, validation and test samples.
Expand Down

0 comments on commit 06ee0ef

Please sign in to comment.