maier-s commited on
Commit
ade7110
1 Parent(s): 2c39317

Update README.md

Browse files

Added first dataset card template

Files changed (1) hide show
  1. README.md +90 -1
README.md CHANGED
@@ -4,4 +4,93 @@ task_categories:
4
  - token-classification
5
  language:
6
  - en
7
- ---
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
4
  - token-classification
5
  language:
6
  - en
7
+ ---
8
+ # Dataset Card for SETH Dataset
9
+
10
+ <!-- Provide a quick summary of the dataset. -->
11
+
12
+ This is a dataset used to apply the DistilBert for NER Task in the Advanced Machine Learing and XAI course of the DHBW CAS in Heilbronn
13
+
14
+ ## Dataset Details
15
+
16
+ ### Dataset Description
17
+
18
+ <!-- Provide a longer summary of what this dataset is. -->
19
+ The Dataset is based on the Data that is Provided by the [Github Repositoriy](https://github.com/Erechtheus/mutationCorpora)
20
+
21
+
22
+ ### Dataset Sources [optional]
23
+
24
+ <!-- Provide the basic links for the dataset. -->
25
+
26
+ - **Repository:** [Source of the Dataset](https://github.com/Erechtheus/mutationCorpora/tree/master/corpora/IOB)
27
+ - **Information about Dataset:** [Datset Information](https://rockt.github.io/SETH/)
28
+
29
+ ## Uses
30
+
31
+ <!-- Address questions around how the dataset is intended to be used. -->
32
+ Used for the Advanced Machine Learining and XAI course of DHBW CAS in Heilbronn
33
+
34
+ ### Direct Use
35
+
36
+ <!-- This section describes suitable use cases for the dataset. -->
37
+ tbd
38
+ [More Information Needed]
39
+
40
+ ### Out-of-Scope Use
41
+
42
+ <!-- This section addresses misuse, malicious use, and uses that the dataset will not work well for. -->
43
+ tbd
44
+ [More Information Needed]
45
+
46
+ ## Dataset Structure
47
+
48
+ <!-- This section provides a description of the dataset fields, and additional information about the dataset structure such as criteria used to create the splits, relationships between data points, etc. -->
49
+ tbd
50
+ [More Information Needed]
51
+
52
+ ## Dataset Creation
53
+
54
+ ### Curation Rationale
55
+
56
+ <!-- Motivation for the creation of this dataset. -->
57
+ Easy Loading for further uses when executing the training
58
+
59
+ [More Information Needed]
60
+
61
+ ### Source Data
62
+
63
+ <!-- This section describes the source data (e.g. news text and headlines, social media posts, translated sentences, ...). -->
64
+ tbd
65
+ #### Data Collection and Processing
66
+
67
+ <!-- This section describes the data collection and processing process such as data selection criteria, filtering and normalization methods, tools and libraries used, etc. -->
68
+ tbd
69
+ [More Information Needed]
70
+
71
+ #### Who are the source data producers?
72
+
73
+ <!-- This section describes the people or systems who originally created the data. It should also include self-reported demographic or identity information for the source data creators if this information is available. -->
74
+ Source Data is produced by [Github Repositoriy](https://github.com/Erechtheus/mutationCorpora) as described in the Github Repository
75
+ [More Information Needed]
76
+
77
+
78
+ ## Bias, Risks, and Limitations
79
+
80
+ <!-- This section is meant to convey both technical and sociotechnical limitations. -->
81
+
82
+ tbd
83
+
84
+ ### Recommendations
85
+
86
+ <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
87
+
88
+ Users should be made aware of the risks, biases and limitations of the dataset. More information needed for further recommendations.
89
+
90
+ ## Citation [optional]
91
+
92
+ <!-- If there is a paper or blog post introducing the dataset, the APA and Bibtex information for that should go in this section. -->
93
+ tbd
94
+
95
+ **BibTeX:**
96
+