Text Generation
Transformers
Safetensors
Indonesian
English
qwen2
conversational
convAI
text-generation-inference
Inference Endpoints
gmonsoon commited on
Commit
77f1b32
1 Parent(s): d2fde8c

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +6 -157
README.md CHANGED
@@ -36,8 +36,13 @@ Due to limited resources, only 0.5B, 1.8B, 4B and 7B models are available. If yo
36
  - **License:** Nusantara is licensed under Apache-2.0, but any usage of this model should comply with [Qwen License](https://huggingface.co/Qwen/Qwen1.5-4B/blob/main/LICENSE)
37
  - **Finetuned from model:** [Qwen1.5-4B](https://huggingface.co/Qwen/Qwen1.5-4B/tree/main)
38
 
 
 
 
39
 
40
- ## Quickstart
 
 
41
 
42
  Here provides a code snippet with `apply_chat_template` to show you how to load the tokenizer and model and how to generate contents.
43
 
@@ -75,136 +80,6 @@ generated_ids = [
75
  response = tokenizer.batch_decode(generated_ids, skip_special_tokens=True)[0]
76
  ```
77
 
78
- ### Direct Use
79
-
80
- <!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
81
-
82
- [More Information Needed]
83
-
84
- ### Downstream Use [optional]
85
-
86
- <!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
87
-
88
- [More Information Needed]
89
-
90
- ### Out-of-Scope Use
91
-
92
- <!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
93
-
94
- [More Information Needed]
95
-
96
- ## Bias, Risks, and Limitations
97
-
98
- <!-- This section is meant to convey both technical and sociotechnical limitations. -->
99
-
100
- [More Information Needed]
101
-
102
- ### Recommendations
103
-
104
- <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
105
-
106
- Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
107
-
108
- ## How to Get Started with the Model
109
-
110
- Use the code below to get started with the model.
111
-
112
- [More Information Needed]
113
-
114
- ## Training Details
115
-
116
- ### Training Data
117
-
118
- <!-- This should link to a Dataset 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. -->
119
-
120
- [More Information Needed]
121
-
122
- ### Training Procedure
123
-
124
- <!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
125
-
126
- #### Preprocessing [optional]
127
-
128
- [More Information Needed]
129
-
130
-
131
- #### Training Hyperparameters
132
-
133
- - **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
134
-
135
- #### Speeds, Sizes, Times [optional]
136
-
137
- <!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
138
-
139
- [More Information Needed]
140
-
141
- ## Evaluation
142
-
143
- <!-- This section describes the evaluation protocols and provides the results. -->
144
-
145
- ### Testing Data, Factors & Metrics
146
-
147
- #### Testing Data
148
-
149
- <!-- This should link to a Dataset Card if possible. -->
150
-
151
- [More Information Needed]
152
-
153
- #### Factors
154
-
155
- <!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
156
-
157
- [More Information Needed]
158
-
159
- #### Metrics
160
-
161
- <!-- These are the evaluation metrics being used, ideally with a description of why. -->
162
-
163
- [More Information Needed]
164
-
165
- ### Results
166
-
167
- [More Information Needed]
168
-
169
- #### Summary
170
-
171
-
172
-
173
- ## Model Examination [optional]
174
-
175
- <!-- Relevant interpretability work for the model goes here -->
176
-
177
- [More Information Needed]
178
-
179
- ## Environmental Impact
180
-
181
- <!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
182
-
183
- 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).
184
-
185
- - **Hardware Type:** [More Information Needed]
186
- - **Hours used:** [More Information Needed]
187
- - **Cloud Provider:** [More Information Needed]
188
- - **Compute Region:** [More Information Needed]
189
- - **Carbon Emitted:** [More Information Needed]
190
-
191
- ## Technical Specifications [optional]
192
-
193
- ### Model Architecture and Objective
194
-
195
- [More Information Needed]
196
-
197
- ### Compute Infrastructure
198
-
199
- [More Information Needed]
200
-
201
- #### Hardware
202
-
203
- [More Information Needed]
204
-
205
- #### Software
206
-
207
- [More Information Needed]
208
 
209
  ## Citation
210
 
@@ -226,29 +101,3 @@ If you use the Nusantara language model in your research or project, please cite
226
  year={2023}
227
  }
228
  ```
229
-
230
- **BibTeX:**
231
-
232
- [More Information Needed]
233
-
234
- **APA:**
235
-
236
- [More Information Needed]
237
-
238
- ## Glossary [optional]
239
-
240
- <!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
241
-
242
- [More Information Needed]
243
-
244
- ## More Information [optional]
245
-
246
- [More Information Needed]
247
-
248
- ## Model Card Authors [optional]
249
-
250
- [More Information Needed]
251
-
252
- ## Model Card Contact
253
-
254
- [More Information Needed]
 
36
  - **License:** Nusantara is licensed under Apache-2.0, but any usage of this model should comply with [Qwen License](https://huggingface.co/Qwen/Qwen1.5-4B/blob/main/LICENSE)
37
  - **Finetuned from model:** [Qwen1.5-4B](https://huggingface.co/Qwen/Qwen1.5-4B/tree/main)
38
 
39
+ ### Recommendations
40
+
41
+ <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
42
 
43
+ Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model.
44
+
45
+ ## How to Get Started with the Model
46
 
47
  Here provides a code snippet with `apply_chat_template` to show you how to load the tokenizer and model and how to generate contents.
48
 
 
80
  response = tokenizer.batch_decode(generated_ids, skip_special_tokens=True)[0]
81
  ```
82
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
83
 
84
  ## Citation
85
 
 
101
  year={2023}
102
  }
103
  ```