Update README.md

README.md

@@ -1,3 +1,63 @@
----
-license: mit
----
+---
+license: mit
+---
+
+# Model Card for SHEET Models
+
+This model card describes the models implemented in the [SHEET](https://github.com/unilight/sheet) toolkit trained using the training sets in MOS-Bench and benchmarked using the test sets in MOS-Bench.
+
+## Model Details
+
+- **Developed by:** Wen-Chin Huang
+- **Model type:** SSL-MOS or AlignNet
+- **License:** MIT
+- **Repository:** [SHEET](https://github.com/unilight/sheet)
+- **Paper:** to be uploaded
+- **Demo :** https://huggingface.co/spaces/unilight/sheet-demo
+
+## Uses
+
+Please refer to the [README in the sheet repo](https://github.com/unilight/sheet/tree/main/egs/bvcc) for more details.
+
+## Bias, Risks, and Limitations
+
+The models are not yet ready to be used to replace subjective tests in scientific papers. They can however be used to compare systems in a heterogeneous way.
+
+## How to Get Started with the Model
+
+Please refer to the [README in the sheet repo](https://github.com/unilight/sheet/tree/main/egs/bvcc) for more details.
+
+## Evaluation
+
+<!-- This section describes the evaluation protocols and provides the results. -->
+
+### Testing Data, Factors & Metrics
+
+#### Testing Data
+
+Please refer to the [`egs` folder in the sheet repo](https://github.com/unilight/sheet/tree/main/egs/bvcc) for more details.
+
+#### Metrics
+
+Please refer to the MOS-Bench paper (to be uploaded) for details.
+
+### Results
+
+Please refer to the MOS-Bench paper (to be uploaded) for details.
+
+
+## Citation
+
+**BibTeX:**
+
+To be updated.
+
+<!-- ## Glossary [optional] -->
+<!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
+
+## Model Card Contact
+
+Wen-Chin Huang  
+Nagoya University  
+Email: wen.chinhuang@g.sp.m.is.nagoya-u.ac.jp  
+GitHub: unilight