horychtom commited on
Commit
198f56b
1 Parent(s): 6af1563

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +13 -32
README.md CHANGED
@@ -1,3 +1,13 @@
 
 
 
 
 
 
 
 
 
 
1
  Here’s a template for a `README.md` file that you can reuse for each of your models on Hugging Face. It is designed to provide a comprehensive overview of the model, its usage, links to relevant papers, datasets, and results:
2
 
3
  ---
@@ -13,21 +23,6 @@ Here’s a template for a `README.md` file that you can reuse for each of your m
13
 
14
  ---
15
 
16
- ## Table of Contents
17
-
18
- 1. [Model Overview](#model-overview)
19
- 2. [Model Architecture](#model-architecture)
20
- 3. [Training Data](#training-data)
21
- 4. [Evaluation Results](#evaluation-results)
22
- 5. [Usage](#usage)
23
- 6. [Example Code](#example-code)
24
- 7. [Related Papers](#related-papers)
25
- 8. [Datasets](#datasets)
26
- 9. [Limitations](#limitations)
27
- 10. [Citation](#citation)
28
-
29
- ---
30
-
31
  ## Model Overview
32
 
33
  This model is a [token-level/sentence-level/paragraph-level] classifier that was trained for [specific task, e.g., sentiment analysis, named entity recognition, etc.]. The model is based on [model architecture, e.g., BERT, RoBERTa, etc.] and has been fine-tuned on [mention the dataset] for [number of epochs or other training details].
@@ -36,17 +31,13 @@ It achieves state-of-the-art performance on [mention dataset or task] and is spe
36
 
37
  ---
38
 
39
- ## Model Architecture
40
 
41
  - **Base Model:** [mention architecture, e.g., BERT-base, RoBERTa-large, etc.]
42
  - **Number of Parameters:** [number of parameters]
43
- - **Layers:** [number of layers, if applicable]
44
- - **Attention Heads:** [number of attention heads, if applicable]
45
- - **Max Sequence Length:** [max input length, if relevant]
46
 
47
- ---
48
-
49
- ## Training Data
50
 
51
  The model was fine-tuned on the [name of dataset] dataset. This dataset consists of [short description of dataset, e.g., number of instances, labels, any important data characteristics].
52
 
@@ -132,16 +123,6 @@ Please cite this paper if you use the model.
132
 
133
  ---
134
 
135
- ## Datasets
136
-
137
- The model was trained on the following dataset(s):
138
-
139
- - **Dataset Name:** [Dataset Name](dataset_url)
140
- **Size:** [Dataset size]
141
- **Number of Labels:** [Number of labels or classes]
142
- **Availability:** [Open-source or proprietary]
143
-
144
- ---
145
 
146
  ## Limitations
147
 
 
1
+ ---
2
+ license: cc-by-nc-4.0
3
+ datasets:
4
+ - mediabiasgroup/BABE
5
+ language:
6
+ - en
7
+ base_model:
8
+ - FacebookAI/roberta-base
9
+ pipeline_tag: text-classification
10
+ ---
11
  Here’s a template for a `README.md` file that you can reuse for each of your models on Hugging Face. It is designed to provide a comprehensive overview of the model, its usage, links to relevant papers, datasets, and results:
12
 
13
  ---
 
23
 
24
  ---
25
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
26
  ## Model Overview
27
 
28
  This model is a [token-level/sentence-level/paragraph-level] classifier that was trained for [specific task, e.g., sentiment analysis, named entity recognition, etc.]. The model is based on [model architecture, e.g., BERT, RoBERTa, etc.] and has been fine-tuned on [mention the dataset] for [number of epochs or other training details].
 
31
 
32
  ---
33
 
34
+ ## Training details
35
 
36
  - **Base Model:** [mention architecture, e.g., BERT-base, RoBERTa-large, etc.]
37
  - **Number of Parameters:** [number of parameters]
38
+ - **Max Sequence Length:** [max input length, if relevant]
 
 
39
 
40
+ ### Training Data
 
 
41
 
42
  The model was fine-tuned on the [name of dataset] dataset. This dataset consists of [short description of dataset, e.g., number of instances, labels, any important data characteristics].
43
 
 
123
 
124
  ---
125
 
 
 
 
 
 
 
 
 
 
 
126
 
127
  ## Limitations
128