This repository was archived by the owner on Sep 27, 2024. It is now read-only.
Make model_details.documentation field more human-readable/writable #297
jeongukjae
started this conversation in
Ideas
Replies: 0 comments
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Uh oh!
There was an error while loading. Please reload this page.
-
Hi, all.
model-card-toolkit/model_card_toolkit/schema/v0.0.2/model_card.schema.json
Lines 24 to 27 in 74d7e6d
The model_details.documentation's description says this field is for the description of the model and its usage, but I think it is very hard to fill/read it.
For example, if I want to write the code sample for the model, it is extremely hard to fill it. The
<code>
or<pre>
tags will be escaped (because the autoescape option is enabled), and no line break is possible since<br>
tag also will be escaped. Even though it becomes possible to inject tags for the code example, it is very hard to write multiline strings (guessing 10-20 lines of codes and comments) in JSON.It would be better if the way to fill it is improved or if there's a guide to fill it more simply. But for me, I don't have great ideas to improve this feature. So I want to discuss this.
Beta Was this translation helpful? Give feedback.
All reactions