AllenNeuralDynamics / aind-data-schema

A library that defines AIND data schema and validates JSON.
MIT License
23 stars 17 forks source link

Docs: derived data description should be in q&a #1130

Open dbirman opened 3 weeks ago

dbirman commented 3 weeks ago

User story

As a user I want to know how derived data_descriptions are generated, that information is currently missing from the documentation

https://aind-data-schema.readthedocs.io/en/latest/data_description.html

Acceptance criteria

Sprint Ready Checklist

Notes

Add any helpful notes here.

dbirman commented 3 weeks ago

Note from David: "Generally it's on the processing pipeline to make one. Most reliable way I have seen is to the take the input data description, apply aind-metadata-upgrader to upgrade in case it's an older version, and call DerivedDataDescription.from_data_description. data_description_upgrade.py AllenNeuralDynamics/aind-metadata-upgrader"

saskiad commented 2 weeks ago

Not all derived assets come via a pipeline. Documentation needs to be clear for other users