Make model card details collapsible
Browse files
README.md
CHANGED
|
@@ -18,15 +18,19 @@ In order to contribute to the FMZ, you must first request to join the FathomNet
|
|
| 18 |
To contribute a model, click the "New" button at the top of the page and select "Model". Give your repository unique name and mark it as public.
|
| 19 |
At a minimum, you should include your model **weights**, training **metrics**, and a **model card**.
|
| 20 |
|
| 21 |
-
|
| 22 |
-
|
| 23 |
-
|
| 24 |
-
|
| 25 |
-
|
| 26 |
-
|
| 27 |
-
|
| 28 |
-
|
| 29 |
-
|
| 30 |
-
|
| 31 |
-
|
| 32 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 18 |
To contribute a model, click the "New" button at the top of the page and select "Model". Give your repository unique name and mark it as public.
|
| 19 |
At a minimum, you should include your model **weights**, training **metrics**, and a **model card**.
|
| 20 |
|
| 21 |
+
<details>
|
| 22 |
+
<summary><b>Model card</b></summary>
|
| 23 |
+
|
| 24 |
+
The model card should detail the following information:
|
| 25 |
+
<ol>
|
| 26 |
+
<li><b>Intended Use</b>: What are the intended use cases of the model? What are the limitations that should be considered by people using the model?</li>
|
| 27 |
+
<li><b>Factors</b>: What are the primary factors that contribute to the model's performance? How was the model trained and evaluated?</li>
|
| 28 |
+
<li><b>Metrics</b>: What are the metrics used to evaluate the model's performance? How does the model perform on these metrics on relevant validation/test sets?</li>
|
| 29 |
+
<li><b>Training and Evaluation Data</b>: What data was used to train the model? How was the data collected and processed?</li>
|
| 30 |
+
<li><b>Deployment</b>: What are the steps required to deploy the model?</li>
|
| 31 |
+
</ol>
|
| 32 |
+
|
| 33 |
+
See the [FathomNet/MBARI-midwater-supercategory-detector](https://huggingface.co/FathomNet/MBARI-midwater-supercategory-detector) for an example of a model card. For more information on writing a model card, see the [model card documentation](https://huggingface.co/docs/hub/model-cards).
|
| 34 |
+
</details>
|
| 35 |
+
|
| 36 |
+
For more information on how to upload these files, see the [model upload documentation](https://huggingface.co/docs/hub/models-uploading).
|