Model Metadata YAML Validation

[isaaccorley]

Description

Adding an example yaml of only the ML model metadata only minus the STAC required components. This can be validated using the pydantic classes like so:

import yaml
from stac_model.schema import MLModelProperties

with open("examples/mlm-metadata.yaml", "r") as f:
    metadata = yaml.safe_load(f)

MLModelProperties.model_validate(metadata)  # validates that the required metadata fields are filled out and the correct types

Related Issue

N/A

Type of Change

• 📚 Examples, docs, tutorials or dependencies update;
• 🔧 Bug fix (non-breaking change which fixes an issue);
• 🥂 Improvement (non-breaking change which improves an existing feature);
• 🚀 New feature (non-breaking change which adds functionality);
• 💥 Breaking change (fix or feature that would cause existing functionality to change);
• 🔐 Security fix.

Checklist

• I've read the CONTRIBUTING.md guide;
• I've updated the code style using make check;
• I've written tests for all new methods and classes that I created;
• I've written the docstring in Google format for all the methods and classes that I used.

[fmigneault]

Please update the CHANGELOG.md with a brief information of added feature.

[fmigneault]

just the pre_processing_function part left to decide

[isaaccorley]

I think these errors in the README.md markdown linting are unrelated to my PR but I can go ahead and fix them:

> stac-mlm@1.4.0 check-markdown
> remark . -f -r .github/remark.yaml -i .remarkignore

CHANGELOG.md: no issues found
CONTRIBUTING.md: no issues found
README.md
  181:1-181:162  warning  Link to unknown heading in `best-practices.md`: `recommended-extensions-to-compose-with-the-ml-model-extension`. Did you mean `recommended-extensions-to-compose-with-the-mlm-extension`  missing-heading-in-file  remark-validate-links
   188:1-188:96  warning  Link to unknown heading in `best-practices.md`: `using-stac-common-metadata-fields-for-the-ml-model-extension`. Did you mean `using-stac-common-metadata-fields-for-the-mlm-extension`    missing-heading-in-file  remark-validate-links

[fmigneault]

@isaaccorley I think you need to update/merge with master. The force-push override them in your branch.

[isaaccorley]

@fmigneault my branch is up to date with the main branch. Looks like these issues are also present on main

[fmigneault]

Thanks for the changes!

[rbavery]

Thanks @isaaccorley !