liujch1998 commited on
Commit
211b422
1 Parent(s): 6f2534e

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +1 -166
README.md CHANGED
@@ -3,171 +3,6 @@ license: mit
3
  language:
4
  - en
5
  pipeline_tag: text2text-generation
6
-
7
- model-index:
8
- - name: crystal-large
9
- results:
10
- - task:
11
- type: question-answering
12
- name: Commonsense Question Answering
13
- dataset:
14
- type: openbookqa
15
- name: OpenBookQA
16
- metrics:
17
- - type: accuracy
18
- value: 64.20
19
- name: Accuracy
20
- - task:
21
- type: question-answering
22
- name: Commonsense Question Answering
23
- dataset:
24
- type: ai2_arc
25
- name: ARC (easy)
26
- config: ARC-Easy
27
- metrics:
28
- - type: accuracy
29
- value: 65.61
30
- name: Accuracy
31
- - task:
32
- type: question-answering
33
- name: Commonsense Question Answering
34
- dataset:
35
- type: ai2_arc
36
- name: ARC (challenge)
37
- config: ARC-Challenge
38
- metrics:
39
- - type: accuracy
40
- value: 52.84
41
- name: Accuracy
42
- - task:
43
- type: question-answering
44
- name: Commonsense Question Answering
45
- dataset:
46
- type: commonsense_qa
47
- name: CommonsenseQA
48
- metrics:
49
- - type: accuracy
50
- value: 70.52
51
- name: Accuracy
52
- - task:
53
- type: question-answering
54
- name: Commonsense Question Answering
55
- dataset:
56
- type: qasc
57
- name: QASC
58
- metrics:
59
- - type: accuracy
60
- value: 56.80
61
- name: Accuracy
62
- - task:
63
- type: question-answering
64
- name: Commonsense Question Answering
65
- dataset:
66
- type: piqa
67
- name: Physical IQA
68
- metrics:
69
- - type: accuracy
70
- value: 75.68
71
- name: Accuracy
72
- - task:
73
- type: question-answering
74
- name: Commonsense Question Answering
75
- dataset:
76
- type: social_i_qa
77
- name: Social IQA
78
- metrics:
79
- - type: accuracy
80
- value: 69.81
81
- name: Accuracy
82
- - task:
83
- type: question-answering
84
- name: Commonsense Question Answering
85
- dataset:
86
- type: winogrande
87
- name: Winogrande
88
- config: winogrande_xl
89
- metrics:
90
- - type: accuracy
91
- value: 72.38
92
- name: Accuracy
93
  ---
94
 
95
- # Model Card for Rainier
96
-
97
- <!-- Provide a quick summary of what the model is/does. -->
98
-
99
- Crystal is an introspective reasoning model commonsense QA. See our paper at: <>.
100
-
101
- ## Model Details
102
-
103
- ### Model Description
104
-
105
- <!-- Provide a longer summary of what this model is. -->
106
-
107
- 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.
108
- We call this process "introspective reasoning", and it improves both the prediction accuracy and the interpretability of neural models at reasoning tasks.
109
-
110
- - **Developed by:** Jiacheng Liu, Ramakanth Pasunuru, Hannaneh Hajishirzi, Yejin Choi, Asli Celikyilmaz
111
- - **Shared by [optional]:** Jiacheng Liu
112
- - **Model type:** Transformers
113
- - **Language(s) (NLP):** English
114
- - **License:** MIT
115
- - **Finetuned from model [optional]:** google/t5-v1_1-large
116
-
117
- ### Model Sources [optional]
118
-
119
- <!-- Provide the basic links for the model. -->
120
-
121
- - **Repository:** <https://github.com/liujch1998/crystal>
122
- - **Paper [optional]:** <>
123
- - **Demo [optional]:** <https://huggingface.co/spaces/liujch1998/crystal>
124
-
125
- ## Uses
126
-
127
- <!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
128
-
129
- ### Direct Use
130
-
131
- <!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
132
-
133
- Crystal is intended to answer commonsense questions via an "introspective reasoning" process.
134
-
135
- ### Out-of-Scope Use
136
-
137
- <!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
138
-
139
- 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.
140
-
141
- ## Bias, Risks, and Limitations
142
-
143
- <!-- This section is meant to convey both technical and sociotechnical limitations. -->
144
-
145
- See the **Limitations** section of our paper.
146
-
147
- ### Recommendations
148
-
149
- <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
150
-
151
- Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
152
-
153
- ## How to Get Started with the Model
154
-
155
- Use the code below to get started with the model.
156
-
157
- ```python
158
- ```
159
-
160
- You may also refer to <https://huggingface.co/spaces/liujch1998/crystal/blob/main/app.py#L10-L86> for implementation.
161
-
162
- ## Citation [optional]
163
-
164
- <!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
165
-
166
- **BibTeX:**
167
-
168
- ```
169
- ```
170
-
171
- ## Model Card Contact
172
-
173
- Jiacheng Liu
 
3
  language:
4
  - en
5
  pipeline_tag: text2text-generation
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
6
  ---
7
 
8
+ See model card at <https://huggingface.co/liujch1998/crystal-11b>