add datacard

README.md

@@ -37,8 +37,8 @@ This dataset was curated for the task of Science Journalism, a text-to-text task
 However, this release also include additional information of the press release and of the scientific article, such as
 press release article body, title, authors' names and affiliations.
 
+The science juornalism leaderboard is found [here]().
 
-- `task-category-tag`: The dataset can be used to train a model for [TASK NAME], which consists in [TASK DESCRIPTION]. Success on this task is typically measured by achieving a *high/low* [metric name](https://huggingface.co/metrics/metric_name). The ([model name](https://huggingface.co/model_name) or [model class](https://huggingface.co/transformers/model_doc/model_class.html)) model currently achieves the following score. *[IF A LEADERBOARD IS AVAILABLE]:* This task has an active leaderboard which can be found at [leaderboard url]() and ranks models based on [metric name](https://huggingface.co/metrics/metric_name) while also reporting [other metric name](https://huggingface.co/metrics/other_metric_name).
 
 ### Languages
 
@@ -49,21 +49,24 @@ English
 
 ### Data Fields
 
-- `id`: unique identifier
-- `pr-title`: Title of press release snippet
-- `pr-summary`: Press release summary
-- `pr-article`: Body of press release article
-- `sc-title`: Title of scientific article
-- `sc-abstract`: Abstract of scientific article
-- `sc-article`: Concatenated sections of the scientific article
-- `sc-sections`: List of sections in the scientific article
-- `sc-section-names`: List of sections names in the scientific article
-- `sc-authors`: list of authors' name and affiliations, in the format '<name> | <affil>'
-
+```
+{
+	"id": String,          			 # unique ID
+	"pr-title": String,    		 	 # Title as found in the ACMTECHNEWS website
+	"pr-article": String,  			 # Press release article
+	"pr-summary": String,  		 	 # Press release summary
+	"sc-title": String,    		 	 # Title of scientific article
+	"sc-abstract": String, 		 	 # Abstract of scientific article
+	"sc-article": String,  			 # Concatenated abstract and sections of the scientific article
+	"sc-sections": List[String], 	 # List of sections in the scientific article
+	"sc-section_names": List[String] # List of section names
+	"sc-authors": List[String] 		 # list of authors' name and affiliations, in the format '<name> | <affil>'
+}
+```
 
 Paragraphs in the press release articles (`pr-article`) and sections of the scientific article (`sc-sections`)
 are separated by `\n`. Data is not sentence or word tokenized.<br>
-
+Note that field `sc-article` includes the article's abstract as well as its sections.
 
 
 ### Example Instance
@@ -76,7 +79,8 @@ are separated by `\n`. Data is not sentence or word tokenized.<br>
   "pr-article": "In one of the most memorable speeches from William Shakespeare's play, Romeo and Juliet , Juliet ponders, \" What's in a name? That which...",
   "pr-summary": ""Researchers at the University of Waterloo's Cheriton School of Computer Science in Canada found a software developer's perceived race and ethnicity,...",
   "sc-title": On the Relationship Between the Developer's Perceptible Race and Ethnicity and the Evaluation of Contributions in OSS",
-  "sc-abstract": "Context: Open Source Software (OSS) projects are typically the result of collective efforts performed by developers with different backgrounds..."
+  "sc-abstract": "Context: Open Source Software (OSS) projects are typically the result of collective efforts performed by developers with different backgrounds...",
+  "sc-articles": "Context: Open Source Software (OSS) projects are typically the result of .... In any line of work, diversity regarding race, gender, personality...",
   "sc-sections": ["In any line of work, diversity regarding race, gender, personality...","To what extent is the submitter's perceptible race and ethnicity related to...",...],
   "sc-section_names": ["INTRODUCTION", "RQ1:", "RQ2:", "RELATED WORK",...],
   "sc-authors": ["Reza Nadri | Cheriton School of Computer Science, University of Waterloo", "Gema Rodriguez Perez | Cheriton School of ...",...]
@@ -84,19 +88,12 @@ are separated by `\n`. Data is not sentence or word tokenized.<br>
 ```
 
 
-
 ### Data Splits
 
-Describe and name the splits in the dataset if there are more than one.
-
-Describe any criteria for splitting the data, if used. If there are differences between the splits (e.g. if the training annotations are machine-generated and the dev and test ones are created by humans, or if different numbers of annotators contributed to each example), describe them here.
-
-Provide the sizes of each split. As appropriate, provide any descriptive statistics for the features, such as average length.  For example:
+Number of instances in train/valid/test are 26,368/1432/1000.<br>
+Note that the training set has only press release data (`pr-*`), however
+splits validation and test do have all fields.
 
-|                         | train | validation | test |
-|-------------------------|------:|-----------:|-----:|
-| Input Sentences         |       |            |      |
-| Average Sentence Length |       |            |      |
 
 ## Dataset Creation
 
@@ -122,7 +119,6 @@ Finally, the scientific articles are retrieved in PDF format and processed using
 Following collection strategies of previous scientific summarization datasets, section heading names are retrieved, and the article text is divided into sections. We also extract the title and all author names and affiliations.
 
 
-
 #### Who are the source language producers?
 
 All texts in this dataset (titles, summaries, and article bodies) were produced by humans.
@@ -161,6 +157,3 @@ Provide the [BibTex](http://www.bibtex.org/)-formatted reference for the dataset
   year      = {2525}
 }
 ```
-
-If the dataset has a [DOI](https://www.doi.org/), please provide it here.
-