D1V1DE commited on
Commit
4c64a26
1 Parent(s): 882a99f

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +102 -0
README.md CHANGED
@@ -1,3 +1,105 @@
1
  ---
2
  license: apache-2.0
3
  ---
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
  ---
2
  license: apache-2.0
3
  ---
4
+
5
+ # Model Card for Model ID
6
+
7
+ <!-- Provide a quick summary of what the model is/does. -->
8
+
9
+ The model is fine-tuned from valurank/distilroberta-bias model for research purpose.
10
+ ## Model Details
11
+
12
+ ### Model Description
13
+
14
+ <!-- Provide a longer summary of what this model is. -->
15
+ The data used for fine-tuning is MBIC dataset, which contains texts with bias labels.
16
+
17
+ The model is capable of classifying any text into Biased or Non_biased. Max length set for the tokenizer is 512.
18
+
19
+
20
+
21
+
22
+ - **Developed by:** [More Information Needed]
23
+ - **Model type:** DistillRoBERTa transformer
24
+ - **Language(s) (NLP):** English
25
+ - **License:** Apache 2.0
26
+ - **Finetuned from model [optional]:** valurank/distilroberta-bias
27
+
28
+ ### Model Sources [optional]
29
+
30
+ <!-- Provide the basic links for the model. -->
31
+
32
+ - **Repository:** To be uploaded
33
+
34
+ ### The following sections are under construction...
35
+
36
+
37
+ ### Recommendations
38
+
39
+ <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
40
+
41
+ Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
42
+
43
+ ## How to Get Started with the Model
44
+
45
+ Use the code below to get started with the model.
46
+
47
+ [More Information Needed]
48
+
49
+ ## Training Details
50
+
51
+ ### Training Data
52
+
53
+ <!-- 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. -->
54
+
55
+ [More Information Needed]
56
+
57
+ ### Training Procedure
58
+
59
+ <!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
60
+
61
+ #### Preprocessing [optional]
62
+
63
+ [More Information Needed]
64
+
65
+
66
+ #### Training Hyperparameters
67
+
68
+ - **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
69
+
70
+ #### Speeds, Sizes, Times [optional]
71
+
72
+ <!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
73
+
74
+ [More Information Needed]
75
+
76
+ ## Evaluation
77
+
78
+ <!-- This section describes the evaluation protocols and provides the results. -->
79
+
80
+ ### Testing Data, Factors & Metrics
81
+
82
+ #### Testing Data
83
+
84
+ <!-- This should link to a Dataset Card if possible. -->
85
+
86
+ [More Information Needed]
87
+
88
+ #### Factors
89
+
90
+ <!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
91
+
92
+ [More Information Needed]
93
+
94
+ #### Metrics
95
+
96
+ <!-- These are the evaluation metrics being used, ideally with a description of why. -->
97
+
98
+ [More Information Needed]
99
+
100
+ ### Results
101
+
102
+ [More Information Needed]
103
+
104
+ #### Summary
105
+