imvladikon commited on
Commit
56dbc75
1 Parent(s): c59a4e1

Create README.md

Browse files
Files changed (1) hide show
  1. README.md +177 -3
README.md CHANGED
@@ -1,3 +1,177 @@
1
- ---
2
- license: pddl
3
- ---
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ annotations_creators:
3
+ - no-annotation
4
+ language_creators:
5
+ - crowdsourced
6
+ languages:
7
+ - he
8
+ licenses:
9
+ - pddl
10
+ multilinguality:
11
+ - monolingual
12
+ pretty_name: Knesset Meetings Corpus
13
+ size_categories:
14
+ - n<1K
15
+ source_datasets:
16
+ - original
17
+ task_categories:
18
+ - language-modeling
19
+ task_ids:
20
+ - language-modeling
21
+ ---
22
+ # Dataset Card for "wikitext"
23
+ ## Table of Contents
24
+ - [Dataset Description](#dataset-description)
25
+ - [Dataset Summary](#dataset-summary)
26
+ - [Supported Tasks and Leaderboards](#supported-tasks-and-leaderboards)
27
+ - [Languages](#languages)
28
+ - [Dataset Structure](#dataset-structure)
29
+ - [Data Instances](#data-instances)
30
+ - [Data Fields](#data-fields)
31
+ - [Data Splits](#data-splits)
32
+ - [Dataset Creation](#dataset-creation)
33
+ - [Curation Rationale](#curation-rationale)
34
+ - [Source Data](#source-data)
35
+ - [Annotations](#annotations)
36
+ - [Personal and Sensitive Information](#personal-and-sensitive-information)
37
+ - [Considerations for Using the Data](#considerations-for-using-the-data)
38
+ - [Social Impact of Dataset](#social-impact-of-dataset)
39
+ - [Discussion of Biases](#discussion-of-biases)
40
+ - [Other Known Limitations](#other-known-limitations)
41
+ - [Additional Information](#additional-information)
42
+ - [Dataset Curators](#dataset-curators)
43
+ - [Licensing Information](#licensing-information)
44
+ - [Citation Information](#citation-information)
45
+ - [Contributions](#contributions)
46
+ ## Dataset Description
47
+ - **Homepage:** [https://zenodo.org/record/2707356](https://zenodo.org/record/2707356)
48
+ - **Repository:** [https://github.com/NLPH/knesset-2004-2005](https://github.com/NLPH/knesset-2004-2005)
49
+ - **Paper:**
50
+ - **Point of Contact:**
51
+ - **Size of downloaded dataset files:**
52
+ - **Size of the generated dataset:**
53
+ - **Total amount of disk used:**
54
+ ### Dataset Summary
55
+
56
+ The Knesset Meetings Corpus 2004-2005 is made up of two components:
57
+
58
+ * Raw texts - 282 files made up of 867,725 lines together. These can be downloaded in two formats:
59
+
60
+ * As ``doc`` files, encoded using ``windows-1255`` encoding:
61
+
62
+ * ``kneset16.zip`` - Contains 164 text files made up of 543,228 lines together. `[MILA host] <http://yeda.cs.technion.ac.il:8088/corpus/software/corpora/knesset/txt/docs/kneset16.zip>`_ `[Github Mirror] <https://github.com/NLPH/knesset-2004-2005/blob/master/kneset16.zip?raw=true>`_
63
+
64
+ * ``kneset17.zip`` - Contains 118 text files made up of 324,497 lines together. `[MILA host] <http://yeda.cs.technion.ac.il:8088/corpus/software/corpora/knesset/txt/docs/kneset17.zip>`_ `[Github Mirror] <https://github.com/NLPH/knesset-2004-2005/blob/master/kneset17.zip?raw=true>`_
65
+
66
+ * As ``txt`` files, encoded using ``utf8`` encoding:
67
+
68
+ * ``kneset.tar.gz`` - An archive of all the raw text files, divided into two folders: `[Github mirror] <https://github.com/NLPH/knesset-2004-2005/blob/master/kneset.tar.gz>`_
69
+
70
+ * ``16`` - Contains 164 text files made up of 543,228 lines together.
71
+
72
+ * ``17`` - Contains 118 text files made up of 324,497 lines together.
73
+
74
+ * ``knesset_txt_16.tar.gz``- Contains 164 text files made up of 543,228 lines together. `[MILA host] <http://yeda.cs.technion.ac.il:8088/corpus/software/corpora/knesset/txt/utf8/knesset_txt_16.tar.gz>`_ `[Github Mirror] <https://github.com/NLPH/knesset-2004-2005/blob/master/knesset_txt_16.tar.gz?raw=true>`_
75
+
76
+ * ``knesset_txt_17.zip`` - Contains 118 text files made up of 324,497 lines together. `[MILA host] <http://yeda.cs.technion.ac.il:8088/corpus/software/corpora/knesset/txt/utf8/knesset_txt_17.zip>`_ `[Github Mirror] <https://github.com/NLPH/knesset-2004-2005/blob/master/knesset_txt_17.zip?raw=true>`_
77
+
78
+ * Tokenized and morphologically tagged texts - Tagged versions exist only for the files in the ``16`` folder. The texts are encoded using `MILA's XML schema for corpora <http://www.mila.cs.technion.ac.il/eng/resources_standards.html>`_. These can be downloaded in two ways:
79
+
80
+ * ``knesset_tagged_16.tar.gz`` - An archive of all tokenized and tagged files. `[MILA host] <http://yeda.cs.technion.ac.il:8088/corpus/software/corpora/knesset/tagged/knesset_tagged_16.tar.gz>`_ `[Archive.org mirror] <https://archive.org/details/knesset_transcripts_2004_2005>`_
81
+
82
+ * By cloning this repository, as the unarchived version of these files can be found in this repository, under the ``knesset_tagged`` folder.
83
+
84
+
85
+ Use
86
+ ---
87
+
88
+ ``txt`` format
89
+ --------------
90
+
91
+ These can be processed like any simple text file.
92
+
93
+ ``doc`` format
94
+ --------------
95
+
96
+ Reading the ``doc``-formatted raw text files requires using a software supporting the ``windows-1255`` encoding.
97
+
98
+ For example, you can process these files using Python with the following code:
99
+
100
+ .. code-block:: python
101
+
102
+ fpath = "/data/knesset/16/00133504.txt"
103
+ with open(fpath, 'rt', encoding='windows-1255') as f:
104
+ line = f.readline()
105
+ # or with "for line in f", etc...
106
+
107
+ Mirrors
108
+ -------
109
+
110
+ This repository is a mirror of this dataset `found on MILA's website <http://www.mila.cs.technion.ac.il/eng/resources_corpora_haknesset.html>`_.
111
+
112
+ Zenodo mirror: `https://zenodo.org/record/2707356 <https://zenodo.org/record/2707356>`_
113
+
114
+
115
+ License
116
+ -------
117
+
118
+ All Knesset meeting protocols are in the `public domain <https://en.wikipedia.org/wiki/Public_domain>`_ (`רשות הציבור <https://he.wikipedia.org/wiki/%D7%A8%D7%A9%D7%95%D7%AA_%D7%94%D7%A6%D7%99%D7%91%D7%95%D7%A8>`_) by law. These files are thus in the public doamin and do not require any license or public domain dedication to set their status.
119
+
120
+ .. |DOI| image:: https://zenodo.org/badge/DOI/10.5281/zenodo.2707356.svg
121
+ :target: https://doi.org/10.5281/zenodo.2707356
122
+
123
+ .. |LICENCE| image:: https://github.com/NLPH/knesset-2004-2005/blob/master/public_domain_shield.svg
124
+ :target: https://en.wikipedia.org/wiki/Public_domain
125
+
126
+ .. |PUBDOM| image:: https://github.com/NLPH/knesset-2004-2005/blob/master/public_domain.png
127
+ :target: https://en.wikipedia.org/wiki/Public_domain
128
+ ### Supported Tasks and Leaderboards
129
+ [More Information Needed](https://github.com/huggingface/datasets/blob/master/CONTRIBUTING.md#how-to-contribute-to-the-dataset-cards)
130
+ ### Languages
131
+ [More Information Needed](https://github.com/huggingface/datasets/blob/master/CONTRIBUTING.md#how-to-contribute-to-the-dataset-cards)
132
+ ## Dataset Structure
133
+ Available "kneset16","kneset17","knesset_tagged" configurations
134
+ And only train set.
135
+ ```python
136
+ train_ds = load_dataset("imvladikon/knesset_meetings_corpus", "kneset16", split="train")
137
+ ```
138
+ ### Data Instances
139
+ An example of sample:
140
+ ```
141
+ {
142
+ "text": <text content of given document>,
143
+ "path": <file path to docx>
144
+ }
145
+ ```
146
+
147
+ ## Dataset Creation
148
+ ### Curation Rationale
149
+ [More Information Needed](https://github.com/huggingface/datasets/blob/master/CONTRIBUTING.md#how-to-contribute-to-the-dataset-cards)
150
+ ### Source Data
151
+ #### Initial Data Collection and Normalization
152
+ [More Information Needed](https://github.com/huggingface/datasets/blob/master/CONTRIBUTING.md#how-to-contribute-to-the-dataset-cards)
153
+ #### Who are the source language producers?
154
+ [More Information Needed](https://github.com/huggingface/datasets/blob/master/CONTRIBUTING.md#how-to-contribute-to-the-dataset-cards)
155
+ ### Annotations
156
+ #### Annotation process
157
+ [More Information Needed](https://github.com/huggingface/datasets/blob/master/CONTRIBUTING.md#how-to-contribute-to-the-dataset-cards)
158
+ #### Who are the annotators?
159
+ [More Information Needed](https://github.com/huggingface/datasets/blob/master/CONTRIBUTING.md#how-to-contribute-to-the-dataset-cards)
160
+ ### Personal and Sensitive Information
161
+ [More Information Needed](https://github.com/huggingface/datasets/blob/master/CONTRIBUTING.md#how-to-contribute-to-the-dataset-cards)
162
+ ## Considerations for Using the Data
163
+ ### Social Impact of Dataset
164
+ [More Information Needed](https://github.com/huggingface/datasets/blob/master/CONTRIBUTING.md#how-to-contribute-to-the-dataset-cards)
165
+ ### Discussion of Biases
166
+ [More Information Needed](https://github.com/huggingface/datasets/blob/master/CONTRIBUTING.md#how-to-contribute-to-the-dataset-cards)
167
+ ### Other Known Limitations
168
+ [More Information Needed](https://github.com/huggingface/datasets/blob/master/CONTRIBUTING.md#how-to-contribute-to-the-dataset-cards)
169
+ ## Additional Information
170
+ ### Dataset Curators
171
+ [More Information Needed](https://github.com/huggingface/datasets/blob/master/CONTRIBUTING.md#how-to-contribute-to-the-dataset-cards)
172
+ ### Licensing Information
173
+ The dataset is available under the [ Open Data Commons Public Domain Dedication & License 1.0](https://opendatacommons.org/licenses/pddl/).
174
+ ### Citation Information
175
+ [More Information Needed](https://github.com/huggingface/datasets/blob/master/CONTRIBUTING.md#how-to-contribute-to-the-dataset-cards)
176
+
177
+ ### Contributions