cjk-aarhus commited on
Commit
12d9770
·
verified ·
1 Parent(s): 46ee88a

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +22 -61
README.md CHANGED
@@ -35,66 +35,61 @@ configs:
35
 
36
  ## Dataset Description
37
 
38
- - **Point of Contact:** [Claus Juhl Knudsen](mailto:[email protected])
39
-
40
  ### Dataset Summary
41
 
42
- The Danish handwriting dataset is a Danish-language dataset containing around 3200 pages of proof-read handwritten text.
43
 
44
- ...its intended use and the supported tasks. Give an overview of how and why the dataset was created.
45
- ...The summary shoul describe the domain, topic, or genre covered.
46
 
47
  ### Languages
48
 
49
  All the text is in Danish. The BCP-47 code for Danish is da.
50
 
 
51
  ## Dataset Structure
52
 
53
  ### Data Instances
54
 
55
- Each data instance describes and represents a single scanned and transcribed physical page with handwritten text.
56
-
57
- contains a scanned image of the of original page, it's date and sequence within a given book or protocol,
58
 
59
- Provide any additional information that is not covered in the other sections about the data here. In particular describe any relationships between data points and if these relationships are made explicit.
60
 
61
  ### Data Fields
62
 
63
  List and describe the fields present in the dataset. Mention their data type, and whether they are used as input or output in any of the tasks the dataset currently supports. If the data has span indices, describe their attributes, such as whether they are at the character level or word level, whether they are contiguous or not, etc. If the datasets contains example IDs, state whether they have an inherent meaning, such as a mapping to other datasets or pointing to relationships between data points.
64
 
65
- - `image`: a scanned image of the physical page
66
- - `docId`: an integer representing the unique id of each page
67
- - `docTitle`: a string containing the title of the book/protocol that the page belongs to
68
- - `sequence`: description of `example_field`
69
  - `alto`: an xml-encoded string containing layout and content information of the physical page, stored in [ALTO XML, version 4.2](https://www.loc.gov/standards/alto/v4/alto-4-2.xsd)
70
  - `page`: an xml-encoded string containing layout and content information of the physical page, stored in [PAGE XML, version 2013-07-15](https://www.primaresearch.org/schema/PAGE/gts/pagecontent/2013-07-15/pagecontent.xsd)
71
 
72
- Note that the descriptions can be initialized with the **Show Markdown Data Fields** output of the [Datasets Tagging app](https://huggingface.co/spaces/huggingface/datasets-tagging), you will then only need to refine the generated descriptions.
73
-
74
 
75
  ### Data Splits
76
 
77
  [N/A]
78
 
 
79
  ## Dataset Creation
80
 
81
  ### Curation Rationale
82
 
83
  The dataset originates from a need to make physical public protocols discoverable via fulltext search and filtering.
84
 
 
85
  ### Source Data
86
 
87
- The source data consists of written minutes from different Parish Council meetings, dating from 1879 to 1933.
 
88
 
89
  #### Initial Data Collection and Normalization
90
 
91
  The original physical minutes where collected and curated as part of the judiciary demands of the city archives in Denmark.
92
 
93
- If the data was modified or normalized after being collected (e.g. if the data is word-tokenized), describe the process and the tools used.
94
 
95
  #### Who are the source language producers?
96
 
97
- The digitized and transcribed minutes were originally written by the secretaries of the individual Parish Councils.
98
 
99
  The layout segmentation and transcription of the digitized minutes is primarily done by volenteers and employees at the participating Danish city archives.
100
 
@@ -103,73 +98,39 @@ All layout segmentation and transcription is done using the Transkribus platform
103
 
104
  ### Annotations
105
 
106
- If the dataset contains annotations which are not part of the initial data collection, describe them in the following paragraphs.
107
-
108
-
109
  #### Annotation process
110
 
111
  When using the Transkribus clients to segment and transcribe the scanned pages, it is possible to add TEI-tags to single words or whole paragraphs.
112
 
113
- -- Describe or reference annotation guidelines provided to the annotators. If available, provide interannotator statistics. Describe any annotation validation processes.
114
 
115
- #### Who are the annotators?
116
 
117
- If annotations were collected for the source data (such as class labels or syntactic parses), state whether the annotations were produced by humans or machine generated.
118
 
119
- Describe the people or systems who originally created the annotations and their selection criteria if applicable.
120
 
121
- Describe the conditions under which the data was annotated (for example, if the annotators were crowdworkers, state what platform was used, or if the data was found, what website the data was found on). If compensation was provided, include that information here.
122
 
123
  ### Personal and Sensitive Information
124
 
125
  No efforts were made to anonymize the data.
126
 
127
- The dataset contains data that might be considered sensitive (e.g., data that reveals racial or ethnic origins, sexual orientations, religious beliefs, political opinions or union memberships, or locations; financial or health data; biometric or genetic data; forms of government identification, such as social security numbers; criminal history).
128
-
129
 
130
- ## Considerations for Using the Data
131
 
132
- ### Social Impact of Dataset
133
-
134
- The purpose of this dataset is to help develop models that can recognize Danish handwriting.
135
-
136
- The statement should include both positive outlooks, such as outlining how technologies developed through its use may improve people's lives, and discuss the accompanying risks. These risks may range from making important decisions more opaque to people who are affected by the technology, to reinforcing existing harmful biases (whose specifics should be discussed in the next section), among other considerations.
137
-
138
- Also describe in this section if the proposed dataset contains a low-resource or under-represented language. If this is the case or if this task has any impact on underserved communities, please elaborate here.
139
-
140
- ### Discussion of Biases
141
-
142
- Provide descriptions of specific biases that are likely to be reflected in the data, and state whether any steps were taken to reduce their impact.
143
-
144
- If analyses have been run quantifying these biases, please add brief summaries and links to the studies here.
145
-
146
- ### Other Known Limitations
147
-
148
- [N/A]
149
 
150
  ## Additional Information
151
 
152
  ### Dataset Curators
153
 
154
- The Danish htr dataset is curated by Aarhus City Archives, Denmark.
155
-
156
- ### Licensing Information
157
 
158
- The Danish htr dataset version 1.0.0 is released under the [Creative Commons Attribution 4.0 International](https://creativecommons.org/licenses/by/4.0/)
159
 
160
- ### Citation Information
161
 
162
- Provide the [BibTex](http://www.bibtex.org/)-formatted reference for the dataset. For example:
163
- ```
164
- @article{article_id,
165
- author = {Author List},
166
- title = {Dataset Paper Title},
167
- journal = {Publication Venue},
168
- year = {2525}
169
- }
170
- ```
171
 
172
 
173
  ### Contributions
 
174
 
175
- Thanks to [@github-username](https://github.com/<github-username>) for adding this dataset.
 
35
 
36
  ## Dataset Description
37
 
 
 
38
  ### Dataset Summary
39
 
40
+ The Danish handwriting dataset is a Danish-language dataset containing around 3200 pages of proofread handwritten text.
41
 
 
 
42
 
43
  ### Languages
44
 
45
  All the text is in Danish. The BCP-47 code for Danish is da.
46
 
47
+
48
  ## Dataset Structure
49
 
50
  ### Data Instances
51
 
52
+ Each data instance describes and represents a single scanned, segmented and transcribed physical page with handwritten text.
53
+ The handwriting originates in
 
54
 
 
55
 
56
  ### Data Fields
57
 
58
  List and describe the fields present in the dataset. Mention their data type, and whether they are used as input or output in any of the tasks the dataset currently supports. If the data has span indices, describe their attributes, such as whether they are at the character level or word level, whether they are contiguous or not, etc. If the datasets contains example IDs, state whether they have an inherent meaning, such as a mapping to other datasets or pointing to relationships between data points.
59
 
60
+ - `id`: an integer representing the unique id of each page
61
+ - `image`: a jpeg image containing a scan of the original physical page
62
+ - `title`: a string containing both the title of the book/protocol to which the page belongs, plus an optional page-range, indicating which document-chunk the page belongs to
63
+ - `sequence`: an integer representing the specific pagenumber of the page within the current page chunk
64
  - `alto`: an xml-encoded string containing layout and content information of the physical page, stored in [ALTO XML, version 4.2](https://www.loc.gov/standards/alto/v4/alto-4-2.xsd)
65
  - `page`: an xml-encoded string containing layout and content information of the physical page, stored in [PAGE XML, version 2013-07-15](https://www.primaresearch.org/schema/PAGE/gts/pagecontent/2013-07-15/pagecontent.xsd)
66
 
 
 
67
 
68
  ### Data Splits
69
 
70
  [N/A]
71
 
72
+
73
  ## Dataset Creation
74
 
75
  ### Curation Rationale
76
 
77
  The dataset originates from a need to make physical public protocols discoverable via fulltext search and filtering.
78
 
79
+
80
  ### Source Data
81
 
82
+ The source data consists of written minutes from different City and Parish Council meetings, dating from 1841 to 1939.
83
+
84
 
85
  #### Initial Data Collection and Normalization
86
 
87
  The original physical minutes where collected and curated as part of the judiciary demands of the city archives in Denmark.
88
 
 
89
 
90
  #### Who are the source language producers?
91
 
92
+ The digitized and transcribed minutes were originally written by the secretaries of the individual City and Parish Councils.
93
 
94
  The layout segmentation and transcription of the digitized minutes is primarily done by volenteers and employees at the participating Danish city archives.
95
 
 
98
 
99
  ### Annotations
100
 
 
 
 
101
  #### Annotation process
102
 
103
  When using the Transkribus clients to segment and transcribe the scanned pages, it is possible to add TEI-tags to single words or whole paragraphs.
104
 
105
+ These annotations have not been applied in any consistent manner, and should be ignored.
106
 
 
107
 
108
+ #### Who are the annotators?
109
 
110
+ The annotations are produced inside Transkribus by the volunteers and employees transcribing and proofreading the documents.
111
 
 
112
 
113
  ### Personal and Sensitive Information
114
 
115
  No efforts were made to anonymize the data.
116
 
117
+ The dataset might contain data that can be considered sensitive (e.g., data that reveals racial or ethnic origins, sexual orientations, religious beliefs, political opinions or union memberships, or locations; financial or health data; biometric or genetic data; forms of government identification, such as social security numbers; criminal history).
 
118
 
 
119
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
120
 
121
  ## Additional Information
122
 
123
  ### Dataset Curators
124
 
125
+ The Danish handwriting dataset is curated by Aarhus City Archives, Denmark.
 
 
126
 
 
127
 
128
+ ### Licensing Information
129
 
130
+ The Danish handwriting dataset version 1.0.0 is released under the [Creative Commons Attribution 4.0 International](https://creativecommons.org/licenses/by/4.0/)
 
 
 
 
 
 
 
 
131
 
132
 
133
  ### Contributions
134
+ Many thanks to the many volunteers that have participated in the segmentation, trancription and proof reading of the archives!
135
 
136
+ - **Point of Contact:** [Claus Juhl Knudsen](mailto:cjk@aarhus.dk)