xavierwoon commited on
Commit
7bfa745
·
verified ·
1 Parent(s): 5e97610

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +44 -42
README.md CHANGED
@@ -20,21 +20,18 @@ tags:
20
 
21
  This is the model card of a 🤗 transformers model that has been pushed on the Hub. This model card has been automatically generated.
22
 
23
- - **Developed by:** [More Information Needed]
24
- - **Funded by [optional]:** [More Information Needed]
25
- - **Shared by [optional]:** [More Information Needed]
26
- - **Model type:** [More Information Needed]
27
- - **Language(s) (NLP):** [More Information Needed]
28
- - **License:** [More Information Needed]
29
- - **Finetuned from model [optional]:** [More Information Needed]
30
 
31
- ### Model Sources [optional]
32
 
33
  <!-- Provide the basic links for the model. -->
34
 
35
- - **Repository:** [More Information Needed]
36
  - **Paper [optional]:** [More Information Needed]
37
- - **Demo [optional]:** [More Information Needed]
38
 
39
  ## Uses
40
 
@@ -44,107 +41,112 @@ This is the model card of a 🤗 transformers model that has been pushed on the
44
 
45
  <!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
46
 
47
- [More Information Needed]
48
 
49
- ### Downstream Use [optional]
50
 
51
  <!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
52
 
53
- [More Information Needed]
54
 
55
- ### Out-of-Scope Use
56
 
57
  <!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
58
 
59
- [More Information Needed]
60
 
61
  ## Bias, Risks, and Limitations
62
 
63
  <!-- This section is meant to convey both technical and sociotechnical limitations. -->
64
 
65
- [More Information Needed]
66
 
67
- ### Recommendations
68
 
69
  <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
70
 
71
- Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
72
 
73
- ## How to Get Started with the Model
74
 
75
- Use the code below to get started with the model.
76
 
77
- [More Information Needed]
78
 
79
  ## Training Details
80
 
 
 
81
  ### Training Data
82
 
83
  <!-- 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. -->
84
 
85
- [More Information Needed]
86
 
87
- ### Training Procedure
88
 
89
  <!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
90
 
91
- #### Preprocessing [optional]
92
 
93
- [More Information Needed]
94
 
95
 
96
- #### Training Hyperparameters
97
 
98
- - **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
99
 
100
- #### Speeds, Sizes, Times [optional]
101
 
102
  <!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
103
 
104
- [More Information Needed]
105
 
106
- ## Evaluation
107
 
108
  <!-- This section describes the evaluation protocols and provides the results. -->
109
 
110
  ### Testing Data, Factors & Metrics
111
 
 
 
112
  #### Testing Data
113
 
114
  <!-- This should link to a Dataset Card if possible. -->
115
 
116
- [More Information Needed]
117
 
118
- #### Factors
119
 
120
  <!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
121
 
122
- [More Information Needed]
123
 
124
- #### Metrics
125
 
126
  <!-- These are the evaluation metrics being used, ideally with a description of why. -->
127
 
128
- [More Information Needed]
129
 
130
  ### Results
131
 
132
- [More Information Needed]
133
 
134
  #### Summary
135
 
136
 
137
 
138
- ## Model Examination [optional]
139
 
140
  <!-- Relevant interpretability work for the model goes here -->
141
 
142
- [More Information Needed]
143
 
144
- ## Environmental Impact
145
 
146
  <!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
147
 
 
148
  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).
149
 
150
  - **Hardware Type:** [More Information Needed]
@@ -173,7 +175,7 @@ Carbon emissions can be estimated using the [Machine Learning Impact calculator]
173
 
174
  ## Citation [optional]
175
 
176
- <!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
177
 
178
  **BibTeX:**
179
 
@@ -185,7 +187,7 @@ Carbon emissions can be estimated using the [Machine Learning Impact calculator]
185
 
186
  ## Glossary [optional]
187
 
188
- <!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
189
 
190
  [More Information Needed]
191
 
@@ -199,4 +201,4 @@ Carbon emissions can be estimated using the [Machine Learning Impact calculator]
199
 
200
  ## Model Card Contact
201
 
202
- [More Information Needed]
 
20
 
21
  This is the model card of a 🤗 transformers model that has been pushed on the Hub. This model card has been automatically generated.
22
 
23
+ - **Developed by:** Xavier Woon
24
+ - **Shared by:** Xavier
25
+ - **Model type:** Text Generation
26
+ - **Finetuned from model [optional]:** Llama 3 8B
 
 
 
27
 
28
+ <!-- ### Model Sources [optional] -->
29
 
30
  <!-- Provide the basic links for the model. -->
31
 
32
+ <!--- **Repository:** [More Information Needed]
33
  - **Paper [optional]:** [More Information Needed]
34
+ - **Demo [optional]:** [More Information Needed] -->
35
 
36
  ## Uses
37
 
 
41
 
42
  <!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
43
 
44
+ <!-- [More Information Needed] -->
45
 
46
+ <!-- ### Downstream Use [optional] -->
47
 
48
  <!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
49
 
50
+ <!-- [More Information Needed] -->
51
 
52
+ <!-- ### Out-of-Scope Use -->
53
 
54
  <!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
55
 
56
+ <!-- [More Information Needed] -->
57
 
58
  ## Bias, Risks, and Limitations
59
 
60
  <!-- This section is meant to convey both technical and sociotechnical limitations. -->
61
 
62
+ <!-- [More Information Needed] -->
63
 
64
+ <!-- ### Recommendations -->
65
 
66
  <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
67
 
68
+ <!-- Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations. -->
69
 
70
+ <!-- ## How to Get Started with the Model -->
71
 
72
+ <!-- Use the code below to get started with the model. -->
73
 
74
+ <!-- [More Information Needed] -->
75
 
76
  ## Training Details
77
 
78
+ Trained with 3 epochs.
79
+
80
  ### Training Data
81
 
82
  <!-- 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. -->
83
 
84
+ <!-- [More Information Needed] -->
85
 
86
+ <!-- ### Training Procedure -->
87
 
88
  <!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
89
 
90
+ <!-- #### Preprocessing [optional] -->
91
 
92
+ <!-- [More Information Needed] -->
93
 
94
 
95
+ <!-- #### Training Hyperparameters -->
96
 
97
+ <!-- - **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision --> -->
98
 
99
+ <!-- #### Speeds, Sizes, Times [optional] -->
100
 
101
  <!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
102
 
103
+ <!-- [More Information Needed] -->
104
 
105
+ <!-- ## Evaluation -->
106
 
107
  <!-- This section describes the evaluation protocols and provides the results. -->
108
 
109
  ### Testing Data, Factors & Metrics
110
 
111
+ Code coverage and Robustness.
112
+
113
  #### Testing Data
114
 
115
  <!-- This should link to a Dataset Card if possible. -->
116
 
117
+ <!-- [More Information Needed] -->
118
 
119
+ <!-- #### Factors -->
120
 
121
  <!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
122
 
123
+ <!-- [More Information Needed] -->
124
 
125
+ <!-- #### Metrics -->
126
 
127
  <!-- These are the evaluation metrics being used, ideally with a description of why. -->
128
 
129
+ <!-- [More Information Needed] -->
130
 
131
  ### Results
132
 
133
+ <!-- [More Information Needed] -->
134
 
135
  #### Summary
136
 
137
 
138
 
139
+ <!-- ## Model Examination [optional] -->
140
 
141
  <!-- Relevant interpretability work for the model goes here -->
142
 
143
+ <!-- [More Information Needed] -->
144
 
145
+ <!-- ## Environmental Impact -->
146
 
147
  <!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
148
 
149
+ <!--
150
  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).
151
 
152
  - **Hardware Type:** [More Information Needed]
 
175
 
176
  ## Citation [optional]
177
 
178
+ If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section.
179
 
180
  **BibTeX:**
181
 
 
187
 
188
  ## Glossary [optional]
189
 
190
+ If relevant, include terms and calculations in this section that can help readers understand the model or model card.
191
 
192
  [More Information Needed]
193
 
 
201
 
202
  ## Model Card Contact
203
 
204
+ [More Information Needed] -->