jnieus01 commited on
Commit
1b0845a
1 Parent(s): 246d6ad

Populate card.

Browse files

Using the HuggingFace datacard template, populated the following fields:
- YAML tags, Dataset Summary, Data Fields, & Source Data.
- All fields should be reviewed and updated prior to making the dataset public.
- For future reference, HuggingFace has a helpful guide on how to populate the fields: https://github.com/huggingface/datasets/blob/main/templates/README_guide.md#dataset-structure

Files changed (1) hide show
  1. README.md +146 -0
README.md CHANGED
@@ -1,3 +1,149 @@
1
  ---
2
  license: mit
3
  ---
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
  ---
2
  license: mit
3
  ---
4
+ ---
5
+ language_creators:
6
+ - other
7
+ license:
8
+ - mit
9
+ multilinguality:
10
+ - monolingual
11
+ pretty_name: narrative-arc
12
+ size_categories: []
13
+ source_datasets: []
14
+ tags: []
15
+ task_categories:
16
+ - text-classification
17
+ task_ids: []
18
+ ---
19
+
20
+ # Dataset Card for [narrative-arc]
21
+
22
+ ## Table of Contents
23
+ - [Table of Contents](#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
+
47
+ ## Dataset Description
48
+
49
+ - **Homepage:**
50
+ - **Repository:**
51
+ - **Paper:**
52
+ - **Leaderboard:**
53
+ - **Point of Contact:**
54
+
55
+ ### Dataset Summary
56
+
57
+ Dataset of stories used for Narrative Arc post-processing. An instance of a story in this dataset will include the original text and its metadata, the transformer model used to make the embeddings, the model's checkpoint, the window indices of the stored embeddings, and the embeddings.
58
+
59
+ ### Supported Tasks and Leaderboards
60
+
61
+ [More Information Needed]
62
+
63
+ ### Languages
64
+
65
+ [More Information Needed]
66
+
67
+ ## Dataset Structure
68
+
69
+ ### Data Instances
70
+
71
+ [More Information Needed]
72
+
73
+ ### Data Fields
74
+
75
+ An example story will look like the following:
76
+
77
+ {
78
+ "book name": "",
79
+ "book meta data": "",
80
+ "full text": "",
81
+ "model": {
82
+ "distilbert-base-cased": {
83
+ "window indices": (first_index, last_index),
84
+ "embeddings": [[]] },
85
+
86
+ "distilbert-base-uncased": {
87
+ "window indices": (first_index, last_index),
88
+ "embeddings": [[]]
89
+ }
90
+ },
91
+ }
92
+ ...
93
+ }
94
+
95
+ ### Data Splits
96
+
97
+ [More Information Needed]
98
+
99
+ ## Dataset Creation
100
+
101
+ ### Curation Rationale
102
+
103
+ The processed text needs to be stored somewhere that is both accessible and can accomodate the large amount of data generated.
104
+
105
+ ### Source Data
106
+
107
+ #### Initial Data Collection and Normalization
108
+
109
+ The data were sourced from the Project Gutenberg[https://www.gutenberg.org/] library.
110
+
111
+ #### Who are the source language producers?
112
+
113
+ Each instance in the dataset represents a text written by a human author. At present, data selected for processing are English-language short stories.
114
+
115
+ ### Personal and Sensitive Information
116
+
117
+ Not applicable.
118
+
119
+ ## Considerations for Using the Data
120
+
121
+ ### Social Impact of Dataset
122
+
123
+ [More Information Needed]
124
+
125
+ ### Discussion of Biases
126
+
127
+ [More Information Needed]
128
+
129
+ ### Other Known Limitations
130
+
131
+ [More Information Needed]
132
+
133
+ ## Additional Information
134
+
135
+ ### Dataset Curators
136
+
137
+ [More Information Needed]
138
+
139
+ ### Licensing Information
140
+
141
+ [More Information Needed]
142
+
143
+ ### Citation Information
144
+
145
+ [More Information Needed]
146
+
147
+ ### Contributions
148
+
149
+ Thanks to [@github-username](https://github.com/<github-username>) for adding this dataset.