Update README.md

README.md

@@ -622,3 +622,62 @@ configs:
   - split: val
     path: youtubesubtitles/val-*
 ---
+
+# LLM Dataset Inference
+
+This repository contains various subsets of the PILE dataset, divided into train and validation sets. The data is used to facilitate privacy research in language models, where perturbed data can be used as a reference to detect the presence of a particular dataset in the training data of a language model.
+
+## Data Used
+
+The data is in the form of JSONL files, with each entry containing the raw text, as well as various kinds of perturbations applied to it. 
+
+## Quick Links
+
+- [**arXiv Paper**](): Detailed information about the Dataset Inference V2 project, including the dataset, results, and additional resources.
+- [**GitHub Repository**](): Access the source code, evaluation scripts, and additional resources for Dataset Inference.
+- [**Dataset on Hugging Face**](https://huggingface.co/datasets/pratyushmaini/llm_dataset_inference): Direct link to download the various versions of the PILE dataset.
+- [**Summary on Twitter**](): A concise summary and key takeaways from the project.
+
+## Applicability 🚀
+
+The dataset is in text format and can be loaded using the Hugging Face `datasets` library. It can be used to evaluate any causal or masked language model for the presence of specific datasets in its training pool. The dataset is *not* intended for direct use in training models, but rather for evaluating the privacy of language models. Please keep the validation sets, and the perturbed train sets private, and do not use them for training models.
+
+## Loading the Dataset
+
+To load the dataset, use the following code:
+
+```python
+from datasets import load_dataset
+
+dataset = load_dataset("pratyushmaini/llm_dataset_inference", subset="wikipedia", split="train")
+```
+
+Note: When loading the dataset, you must specify a subset. If you don't, you'll encounter the following error:
+
+```
+ValueError: Config name is missing.
+Please pick one among the available configs: ['arxiv', 'bookcorpus2', 'books3', 'cc', 'enron', 'europarl', 'freelaw', 'github', 'gutenberg', 'hackernews', 'math', 'nih', 'opensubtitles', 'openwebtext2', 'philpapers', 'stackexchange', 'ubuntu', 'uspto', 'wikipedia', 'youtubesubtitles']
+Example of usage:
+    `load_dataset('llm_dataset_inference', 'arxiv')`
+```
+
+Correct usage example:
+```python
+ds = load_dataset("pratyushmaini/llm_dataset_inference", "arxiv")
+```
+
+## Available Perturbations
+
+We use the NL-Augmenter library to apply the following perturbations to the data:
+
+- `synonym_substitution`: Synonym substitution of words in the sentence.
+- `butter_fingers`: Randomly changing characters from the sentence.
+- `random_deletion`: Randomly deleting words from the sentence.
+- `change_char_case`: Randomly changing the case of characters in the sentence.
+- `whitespace_perturbation`: Randomly adding or removing whitespace from the sentence.
+- `underscore_trick`: Adding underscores to the sentence.
+
+
+## Contact
+
+Please email `[email protected]` in case of any queries regarding the dataset