Falcon2006VN commited on
Commit
fc44d67
1 Parent(s): 03c3906

Update README.md

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