haes95 commited on
Commit
e6118fc
1 Parent(s): cd60cef

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +163 -1
README.md CHANGED
@@ -35,4 +35,166 @@ from transformers import AutoTokenizer, AutoModelForCausalLM
35
 
36
  tokenizer = AutoTokenizer.from_pretrained("x2bee/PLOAR-14B-DPO-v1.0")
37
  model = AutoModelForCausalLM.from_pretrained("x2bee/PLOAR-14B-DPO-v1.0")
38
- ```
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
35
 
36
  tokenizer = AutoTokenizer.from_pretrained("x2bee/PLOAR-14B-DPO-v1.0")
37
  model = AutoModelForCausalLM.from_pretrained("x2bee/PLOAR-14B-DPO-v1.0")
38
+ ```
39
+
40
+ ## Downstream Use [Optional]
41
+
42
+ <!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
43
+ <!-- If the user enters content, print that. If not, but they enter a task in the list, use that. If neither, say "more info needed." -->
44
+
45
+
46
+
47
+
48
+ ## Out-of-Scope Use
49
+
50
+ <!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
51
+ <!-- If the user enters content, print that. If not, but they enter a task in the list, use that. If neither, say "more info needed." -->
52
+
53
+
54
+
55
+
56
+ # Bias, Risks, and Limitations
57
+
58
+ <!-- This section is meant to convey both technical and sociotechnical limitations. -->
59
+
60
+ Significant research has explored bias and fairness issues with language models (see, e.g., [Sheng et al. (2021)](https://aclanthology.org/2021.acl-long.330.pdf) and [Bender et al. (2021)](https://dl.acm.org/doi/pdf/10.1145/3442188.3445922)). Predictions generated by the model may include disturbing and harmful stereotypes across protected classes; identity characteristics; and sensitive, social, and occupational groups.
61
+
62
+
63
+ ## Recommendations
64
+
65
+ <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
66
+
67
+
68
+
69
+
70
+
71
+ # Training Details
72
+
73
+ ## Training Data
74
+
75
+ <!-- This should link to a Data Card, perhaps with a short stub of information on what the training data is all about as well as documentation related to data pre-processing or additional filtering. -->
76
+
77
+ More information on training data needed
78
+
79
+
80
+ ## Training Procedure
81
+
82
+ <!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
83
+
84
+ ### Preprocessing
85
+
86
+ More information needed
87
+
88
+ ### Speeds, Sizes, Times
89
+
90
+ <!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
91
+
92
+ More information needed
93
+
94
+ # Evaluation
95
+
96
+ <!-- This section describes the evaluation protocols and provides the results. -->
97
+
98
+ ## Testing Data, Factors & Metrics
99
+
100
+ ### Testing Data
101
+
102
+ <!-- This should link to a Data Card if possible. -->
103
+
104
+ More information needed
105
+
106
+
107
+ ### Factors
108
+
109
+ <!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
110
+
111
+ More information needed
112
+
113
+ ### Metrics
114
+
115
+ <!-- These are the evaluation metrics being used, ideally with a description of why. -->
116
+
117
+ More information needed
118
+
119
+ ## Results
120
+
121
+ More information needed
122
+
123
+ # Model Examination
124
+
125
+ More information needed
126
+
127
+ # Environmental Impact
128
+
129
+ <!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
130
+
131
+ Carbon emissions can be estimated using the [Machine Learning Impact calculator](https://mlco2.github.io/impact#compute) presented in [Lacoste et al. (2019)](https://arxiv.org/abs/1910.09700).
132
+
133
+ - **Hardware Type:** More information needed
134
+ - **Hours used:** More information needed
135
+ - **Cloud Provider:** More information needed
136
+ - **Compute Region:** More information needed
137
+ - **Carbon Emitted:** More information needed
138
+
139
+ # Technical Specifications [optional]
140
+
141
+ ## Model Architecture and Objective
142
+
143
+ More information needed
144
+
145
+ ## Compute Infrastructure
146
+
147
+ More information needed
148
+
149
+ ### Hardware
150
+
151
+ More information needed
152
+
153
+ ### Software
154
+
155
+ More information needed
156
+
157
+ # Citation
158
+
159
+ <!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
160
+
161
+ **BibTeX:**
162
+
163
+ More information needed
164
+
165
+ **APA:**
166
+
167
+ More information needed
168
+
169
+ # Glossary [optional]
170
+
171
+ <!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
172
+
173
+ More information needed
174
+
175
+ # More Information [optional]
176
+
177
+ If you would like more information about our company, please visit the link below.
178
+ [tech.x2bee.com](https://tech.x2bee.com/)
179
+
180
+
181
+ # Model Card Authors [optional]
182
+
183
+ <!-- This section provides another layer of transparency and accountability. Whose views is this model card representing? How many voices were included in its construction? Etc. -->
184
+
185
+ Woomun Jung, MinYoung Joo, Eunsu Ha, Seungjun Son
186
+
187
+ # Model Card Contact
188
+
189
+ More information needed
190
+
191
+ # How to Get Started with the Model
192
+
193
+ Use the code below to get started with the model.
194
+
195
+ <details>
196
+ <summary> Click to expand </summary>
197
+
198
+ More information needed
199
+
200
+ </details>