richard-park commited on
Commit
b68acf2
1 Parent(s): e174268

update readme

Browse files
Files changed (1) hide show
  1. README.md +194 -5
README.md CHANGED
@@ -1,5 +1,194 @@
1
- ---
2
- license: llama3
3
- language:
4
- - ko
5
- ---
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # Model Card for Model ID
2
+
3
+ <!-- Provide a quick summary of what the model is/does. -->
4
+
5
+ This modelcard aims to be a base template for new models. It has been generated using [this raw template](https://github.com/huggingface/huggingface_hub/blob/main/src/huggingface_hub/templates/modelcard_template.md?plain=1).
6
+
7
+ ## Model Details
8
+
9
+ ### Model Description
10
+
11
+ <!-- Provide a longer summary of what this model is. -->
12
+
13
+
14
+
15
+ - **Developed by:** Richard
16
+ - **Funded by [optional]:** [More Information Needed]
17
+ - **Shared by [optional]:** [More Information Needed]
18
+ - **Model type:** Text Generation
19
+ - **Language(s) (NLP):** 영여, 한국어
20
+ - **License:** llama 3 Community license agreement
21
+ - **Finetuned from model [optional]:** Llama-3-8B-Instruction
22
+
23
+ ### Model Sources [optional]
24
+
25
+ <!-- Provide the basic links for the model. -->
26
+
27
+ - **Repository:** [More Information Needed]
28
+ - **Paper [optional]:** [More Information Needed]
29
+ - **Demo [optional]:** [More Information Needed]
30
+
31
+ ## Uses
32
+
33
+ <!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
34
+
35
+ ### Direct Use
36
+
37
+ <!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
38
+
39
+ [More Information Needed]
40
+
41
+ ### Downstream Use [optional]
42
+
43
+ <!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
44
+
45
+ [More Information Needed]
46
+
47
+ ### Out-of-Scope Use
48
+
49
+ <!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
50
+
51
+ [More Information Needed]
52
+
53
+ ## Bias, Risks, and Limitations
54
+
55
+ <!-- This section is meant to convey both technical and sociotechnical limitations. -->
56
+
57
+ [More Information Needed]
58
+
59
+ ### Recommendations
60
+
61
+ <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
62
+
63
+ Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
64
+
65
+ ## How to Get Started with the Model
66
+
67
+ Use the code below to get started with the model.
68
+
69
+ [More Information Needed]
70
+
71
+ ## Training Details
72
+
73
+ ### Training Data
74
+
75
+ <!-- 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. -->
76
+
77
+ [More Information Needed]
78
+
79
+ ### Training Procedure
80
+
81
+ <!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
82
+
83
+ #### Preprocessing [optional]
84
+
85
+ [More Information Needed]
86
+
87
+
88
+ #### Training Hyperparameters
89
+
90
+ - **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
91
+
92
+ #### Speeds, Sizes, Times [optional]
93
+
94
+ <!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
95
+
96
+ [More Information Needed]
97
+
98
+ ## Evaluation
99
+
100
+ <!-- This section describes the evaluation protocols and provides the results. -->
101
+
102
+ ### Testing Data, Factors & Metrics
103
+
104
+ #### Testing Data
105
+
106
+ <!-- This should link to a Dataset Card if possible. -->
107
+
108
+ [More Information Needed]
109
+
110
+ #### Factors
111
+
112
+ <!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
113
+
114
+ [More Information Needed]
115
+
116
+ #### Metrics
117
+
118
+ <!-- These are the evaluation metrics being used, ideally with a description of why. -->
119
+
120
+ [More Information Needed]
121
+
122
+ ### Results
123
+
124
+ [More Information Needed]
125
+
126
+ #### Summary
127
+
128
+
129
+
130
+ ## Model Examination [optional]
131
+
132
+ <!-- Relevant interpretability work for the model goes here -->
133
+
134
+ [More Information Needed]
135
+
136
+ ## Environmental Impact
137
+
138
+ <!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
139
+
140
+ 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).
141
+
142
+ - **Hardware Type:** [More Information Needed]
143
+ - **Hours used:** [More Information Needed]
144
+ - **Cloud Provider:** [More Information Needed]
145
+ - **Compute Region:** [More Information Needed]
146
+ - **Carbon Emitted:** [More Information Needed]
147
+
148
+ ## Technical Specifications [optional]
149
+
150
+ ### Model Architecture and Objective
151
+
152
+ [More Information Needed]
153
+
154
+ ### Compute Infrastructure
155
+
156
+ [More Information Needed]
157
+
158
+ #### Hardware
159
+
160
+ [More Information Needed]
161
+
162
+ #### Software
163
+
164
+ [More Information Needed]
165
+
166
+ ## Citation [optional]
167
+
168
+ <!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
169
+
170
+ **BibTeX:**
171
+
172
+ [More Information Needed]
173
+
174
+ **APA:**
175
+
176
+ [More Information Needed]
177
+
178
+ ## Glossary [optional]
179
+
180
+ <!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
181
+
182
+ [More Information Needed]
183
+
184
+ ## More Information [optional]
185
+
186
+ [More Information Needed]
187
+
188
+ ## Model Card Authors [optional]
189
+
190
+ [More Information Needed]
191
+
192
+ ## Model Card Contact
193
+
194
+ [More Information Needed]