vivtsai's picture
Add descriptions for all formatting scripts
f667ef6
|
raw
history blame
977 Bytes

Formatting Utilities

The resources in this folder are used to format the saved datacard in a readable format.

File Description
key_to_question.json Maps from the saved key back to the original question, which can then be parsed into question/answer pairs.
reformat_json.py Uses key_to_question.json to transform dataset documentation into a JSON organized by Data Card standards (e.g., sections, subsections, scopes). Everything labeled N/A in the original documentation will be rendered; empty fields will be completely omitted.
json_to_md.py Transforms output from reformat_json.py into Markdown that is compatible with Data Cards Labs (e.g., special comment syntax).