Update README.md

README.md

@@ -1,3 +1,64 @@
 ---
 license: mit
+task_categories:
+- summarization
+language:
+- en
+size_categories:
+- 10K<n<100K
 ---
+
+# scientific_lay_summarisation - PLOS - normalized
+
+This dataset contains scientific lay summaries which have been preprocessed using the code provided in this repository. The preprocessing includes fixing punctuation and whitespace issues, and calculating the token length of each text sample using a tokenizer from the T5 model.
+## Data Cleaning
+
+The text in both the "article" and "summary" columns was processed to ensure that punctuation and whitespace were consistent. The `fix_punct_whitespace` function was applied to each text sample to:
+- Remove spaces before punctuation marks (except for parentheses)
+- Add a space after punctuation marks (except for parentheses) if missing
+- Handle spaces around parentheses
+- Add a space after a closing parenthesis if followed by a word or opening parenthesis
+- Handle spaces around quotation marks
+- Handle spaces around single quotes
+- Handle comma in numbers
+## Tokenization
+
+The length of each text sample was calculated in terms of tokens using the T5 tokenizer. The `calculate_token_length` function was used to encode each text sample using the tokenizer and return the number of resulting tokens. The resulting token lengths were added as new columns to the dataframes.
+## Data Format
+
+The resulting processed datasets are saved in separate directories as parquet files. The directories are named according to the dataset and split name, and each directory contains three parquet files for the train, test, and validation splits.
+
+The datasets can be loaded using the `pandas` library or using the `datasets` library from the Hugging Face transformers package. The column names and data types are as follows: 
+- `article`: the scientific article text (string) 
+- `summary`: the lay summary text (string) 
+- `article_length`: the length of the article in terms of tokens (int) 
+- `summary_length`: the length of the summary in terms of tokens (int)
+## Usage
+
+To use the processed datasets, load the desired parquet file(s) using `pandas` or `datasets`. Here is an example using `pandas`:
+
+```python
+
+import pandas as pd
+
+# Load a parquet file
+df = pd.read_parquet("scientific_lay_summarisation-plos-norm/train.parquet")
+
+# Print the first few rows
+print(df.head())
+```
+
+
+
+And here is an example using `datasets`:
+
+```python
+
+from datasets import load_dataset
+
+dataset = load_dataset("pszemraj/scientific_lay_summarisation-plos-norm")
+
+# Print the first few samples
+for i in range(5):
+    print(dataset[i])
+```