search

earthpulse / eotdl

Earth Observation Training Datasets
https://eotdl.com
MIT License
17 stars 6 forks source link

add README.md in dataset/model ingestion folder #159

Closed juansensio closed 3 months ago

juansensio commented 5 months ago

At ingestion time, expect a README.md file alongside the metadata.yaml file, with the following sections:

Consider using the README.md metdata header as an alternative to the metadata.yaml file.

juansensio commented 4 months ago

The README.md can hold the metadata at the top using the frontmatter format. The metadata.yaml will be still supported for legacy reasons, but not mentioned on the docs (the README is now the default).

This file is NOT ingested with the rest of the dataset.

When downloading a dataset, this file is auto-generated by the CLI (so it is updated with changes in the UI).

When re-ingesting, the user will have to decide if overwritting the metadata in the UI with the local metadata or sync the metadata in the UI with the local metadata.