ngocminhta commited on
Commit
9089eca
1 Parent(s): 7d9646a

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +152 -0
README.md CHANGED
@@ -1,3 +1,155 @@
1
  ---
2
  license: apache-2.0
 
 
 
 
 
 
3
  ---
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
  ---
2
  license: apache-2.0
3
+ language:
4
+ - en
5
+ pipeline_tag: text-classification
6
+ tags:
7
+ - movie
8
+ - entertainment
9
  ---
10
+ # Model Card for Model ID
11
+
12
+ ## Model Details
13
+
14
+ ### Model Description
15
+
16
+ <!-- Provide a longer summary of what this model is. -->
17
+
18
+
19
+
20
+ - **Developed by:** [More Information Needed]
21
+ - **Funded by [optional]:** [More Information Needed]
22
+ - **Shared by [optional]:** [More Information Needed]
23
+ - **Model type:** [More Information Needed]
24
+ - **Language(s) (NLP):** [More Information Needed]
25
+ - **License:** [More Information Needed]
26
+ - **Finetuned from model [optional]:** [More Information Needed]
27
+
28
+ ### Model Sources [optional]
29
+
30
+ <!-- Provide the basic links for the model. -->
31
+
32
+ - **Repository:** [More Information Needed]
33
+
34
+ ## Uses
35
+
36
+ <!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
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
+ ### Out-of-Scope Use
45
+
46
+ <!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
47
+
48
+ [More Information Needed]
49
+
50
+ ## Bias, Risks, and Limitations
51
+
52
+ <!-- This section is meant to convey both technical and sociotechnical limitations. -->
53
+
54
+ [More Information Needed]
55
+
56
+ ### Recommendations
57
+
58
+ <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
59
+
60
+ Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
61
+
62
+ ## How to Get Started with the Model
63
+
64
+ Use the code below to get started with the model.
65
+
66
+ [More Information Needed]
67
+
68
+ ## Training Details
69
+
70
+ ### Training Data
71
+
72
+ <!-- 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. -->
73
+
74
+ [More Information Needed]
75
+
76
+ ### Training Procedure
77
+
78
+ <!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
79
+
80
+ #### Preprocessing [optional]
81
+
82
+ [More Information Needed]
83
+
84
+
85
+ #### Training Hyperparameters
86
+
87
+ - **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
88
+
89
+ [More Information Needed]
90
+
91
+ ## Evaluation
92
+
93
+ <!-- This section describes the evaluation protocols and provides the results. -->
94
+
95
+ ### Testing Data, Factors & Metrics
96
+
97
+ #### Testing Data
98
+
99
+ <!-- This should link to a Dataset Card if possible. -->
100
+
101
+ [More Information Needed]
102
+
103
+ #### Factors
104
+
105
+ <!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
106
+
107
+ [More Information Needed]
108
+
109
+ #### Metrics
110
+
111
+ <!-- These are the evaluation metrics being used, ideally with a description of why. -->
112
+
113
+ [More Information Needed]
114
+
115
+ ### Results
116
+
117
+ [More Information Needed]
118
+
119
+ #### Summary
120
+
121
+
122
+ ## Environmental Impact
123
+
124
+ 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).
125
+
126
+ - **Hardware Type:** [More Information Needed]
127
+ - **Hours used:** [More Information Needed]
128
+ - **Cloud Provider:** [More Information Needed]
129
+ - **Compute Region:** [More Information Needed]
130
+ - **Carbon Emitted:** [More Information Needed]
131
+
132
+ ## Technical Specifications [optional]
133
+
134
+ ### Model Architecture and Objective
135
+
136
+ [More Information Needed]
137
+
138
+ ### Compute Infrastructure
139
+
140
+ [More Information Needed]
141
+
142
+ #### Hardware
143
+
144
+ [More Information Needed]
145
+
146
+ #### Software
147
+
148
+ [More Information Needed]
149
+
150
+
151
+ ## Model Card Contact
152
+
153
+ [More Information Needed]
154
+
155
+