Spaces:
Runtime error
Runtime error
Add descriptions for all formatting scripts
Browse files- formatting/README.md +5 -3
formatting/README.md
CHANGED
@@ -1,7 +1,9 @@
|
|
1 |
# Formatting Utilities
|
2 |
|
3 |
The resources in this folder are used to format the saved datacard in a readable format.
|
4 |
-
The file `key_to_question.json` maps from the saved key back to the original question which can then be parsed into question/answer pairs.
|
5 |
|
6 |
-
|
7 |
-
|
|
|
|
|
|
|
|
1 |
# Formatting Utilities
|
2 |
|
3 |
The resources in this folder are used to format the saved datacard in a readable format.
|
|
|
4 |
|
5 |
+
File | Description
|
6 |
+
--- | ---
|
7 |
+
[`key_to_question.json`](https://huggingface.co/spaces/GEM/DatasetCardForm/blob/main/formatting/key_to_question.json) | Maps from the saved key back to the original question, which can then be parsed into question/answer pairs.
|
8 |
+
[`reformat_json.py`](https://huggingface.co/spaces/GEM/DatasetCardForm/blob/main/formatting/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.
|
9 |
+
[`json_to_md.py`](https://huggingface.co/spaces/GEM/DatasetCardForm/blob/main/formatting/json_to_md.py) | Transforms output from `reformat_json.py` into Markdown that is compatible with Data Cards Labs (e.g., special comment syntax).
|