Create README.md

README.md

@@ -0,0 +1,173 @@
+---
+license: mit
+language:
+- en
+pipeline_tag: text2text-generation
+
+model-index:
+- name: crystal-11b
+  results:
+  - task:
+      type: question-answering
+      name: Commonsense Question Answering
+    dataset:
+      type: openbookqa
+      name: OpenBookQA
+    metrics:
+      - type: accuracy
+        value: 84.58
+        name: Accuracy
+  - task:
+      type: question-answering
+      name: Commonsense Question Answering
+    dataset:
+      type: ai2_arc
+      name: ARC (easy)
+      config: ARC-Easy
+    metrics:
+      - type: accuracy
+        value: 87.54
+        name: Accuracy
+  - task:
+      type: question-answering
+      name: Commonsense Question Answering
+    dataset:
+      type: ai2_arc
+      name: ARC (challenge)
+      config: ARC-Challenge
+    metrics:
+      - type: accuracy
+        value: 73.24
+        name: Accuracy
+  - task:
+      type: question-answering
+      name: Commonsense Question Answering
+    dataset:
+      type: commonsense_qa
+      name: CommonsenseQA
+    metrics:
+      - type: accuracy
+        value: 82.31
+        name: Accuracy
+  - task:
+      type: question-answering
+      name: Commonsense Question Answering
+    dataset:
+      type: qasc
+      name: QASC
+    metrics:
+      - type: accuracy
+        value: 81.97
+        name: Accuracy
+  - task:
+      type: question-answering
+      name: Commonsense Question Answering
+    dataset:
+      type: piqa
+      name: Physical IQA
+    metrics:
+      - type: accuracy
+        value: 88.08
+        name: Accuracy
+  - task:
+      type: question-answering
+      name: Commonsense Question Answering
+    dataset:
+      type: social_i_qa
+      name: Social IQA
+    metrics:
+      - type: accuracy
+        value: 82.24
+        name: Accuracy
+  - task:
+      type: question-answering
+      name: Commonsense Question Answering
+    dataset:
+      type: winogrande
+      name: Winogrande
+      config: winogrande_xl
+    metrics:
+      - type: accuracy
+        value: 90.77
+        name: Accuracy
+---
+
+# Model Card for Crystal
+
+<!-- Provide a quick summary of what the model is/does. -->
+
+Crystal is an introspective reasoning model commonsense QA. See our paper at: <>.
+
+## Model Details
+
+### Model Description
+
+<!-- Provide a longer summary of what this model is. -->
+
+Crystal can answer a given commonsense question by first generating a relevant knowledge statement, and then predict the final answer by referencing the generated knowledge.
+We call this process "introspective reasoning", and it improves both the prediction accuracy and the interpretability of neural models at reasoning tasks.
+
+- **Developed by:** Jiacheng Liu, Ramakanth Pasunuru, Hannaneh Hajishirzi, Yejin Choi, Asli Celikyilmaz
+- **Shared by [optional]:** Jiacheng Liu
+- **Model type:** Transformers
+- **Language(s) (NLP):** English
+- **License:** MIT
+- **Finetuned from model [optional]:** t5-11b
+
+### Model Sources [optional]
+
+<!-- Provide the basic links for the model. -->
+
+- **Repository:** <https://github.com/liujch1998/crystal>
+- **Paper [optional]:** <>
+- **Demo [optional]:** <https://huggingface.co/spaces/liujch1998/crystal>
+
+## Uses
+
+<!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
+
+### Direct Use
+
+<!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
+
+Crystal is intended to answer commonsense questions via an "introspective reasoning" process.
+
+### Out-of-Scope Use
+
+<!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
+
+Crystal is a research prototype and may give incorrect answers or reasoning process. Do not use for making critical decisions. It is intended to answer questions about commonsense, and may be unreliable when taking input out of this scope.
+
+## Bias, Risks, and Limitations
+
+<!-- This section is meant to convey both technical and sociotechnical limitations. -->
+
+See the **Limitations** section of our paper.
+
+### Recommendations
+
+<!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
+
+Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
+
+## How to Get Started with the Model
+
+Use the code below to get started with the model.
+
+```python
+```
+
+You may also refer to <https://huggingface.co/spaces/liujch1998/crystal/blob/main/app.py#L10-L86> for implementation.
+
+## Citation [optional]
+
+<!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
+
+**BibTeX:**
+
+```
+```
+
+## Model Card Contact
+
+Jiacheng Liu