GerritPot commited on
Commit
99dfcb3
·
verified ·
1 Parent(s): fd6378e

Update README.md

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