Update README.md

README.md

@@ -28,7 +28,7 @@ train-eval-index:
       name: seqeval
 ---
 
-# Dataset Card for "debug-small-en"
+# Dataset Card for "privy-small-en"
 
 ## Table of Contents
 - [Dataset Description](#dataset-description)
@@ -56,13 +56,8 @@ train-eval-index:
 
 ## Dataset Description
 
-- **Homepage:** [https://www.aclweb.org/anthology/W03-0419/](https://www.aclweb.org/anthology/W03-0419/)
-- **Repository:** [More Information Needed](https://github.com/huggingface/datasets/blob/master/CONTRIBUTING.md#how-to-contribute-to-the-dataset-cards)
-- **Paper:** [More Information Needed](https://github.com/huggingface/datasets/blob/master/CONTRIBUTING.md#how-to-contribute-to-the-dataset-cards)
-- **Point of Contact:** [More Information Needed](https://github.com/huggingface/datasets/blob/master/CONTRIBUTING.md#how-to-contribute-to-the-dataset-cards)
-- **Size of downloaded dataset files:** 4.63 MB
-- **Size of the generated dataset:** 9.78 MB
-- **Total amount of disk used:** 14.41 MB
+- **Homepage:** [https://github.com/pixie-io/pixie/tree/main/src/datagen/pii/privy](https://www.aclweb.org/anthology/W03-0419/)
+- **Size of the generated dataset:** 146.4 MB
 
 ### Dataset Summary
 A synthetic dataset generated using Privy, a tool which parses OpenAPI specifications and generates synthetic request payloads, searching for keywords in API schema definitions to select appropriate data providers. Generated API payloads are converted to various protocol trace formats like JSON and SQL to approximate the data developers might encounter while debugging applications. 
@@ -71,70 +66,38 @@ This labelled PII dataset consists of protocol traces (JSON, SQL (PostgreSQL, My
 
 The uploading dataset using ___(IOB?)__ tagging scheme
 
+An IOB tagged version of this dataset is available [](here)
+
 ### Supported Tasks and Leaderboards
 
 [More Information Needed](https://github.com/huggingface/datasets/blob/master/CONTRIBUTING.md#how-to-contribute-to-the-dataset-cards)
 
 ### Languages
 
-[More Information Needed](https://github.com/huggingface/datasets/blob/master/CONTRIBUTING.md#how-to-contribute-to-the-dataset-cards)
+English
 
 ## Dataset Structure
 
 ### Data Instances
 
-#### conll2003
-
-- **Size of downloaded dataset files:** 4.63 MB
-- **Size of the generated dataset:** 9.78 MB
-- **Total amount of disk used:** 14.41 MB
-
-An example of 'train' looks as follows.
-
+A sample looks like this:
 ```
 {
-    "chunk_tags": [11, 12, 12, 21, 13, 11, 11, 21, 13, 11, 12, 13, 11, 21, 22, 11, 12, 17, 11, 21, 17, 11, 12, 12, 21, 22, 22, 13, 11, 0],
-    "id": "0",
-    "ner_tags": [0, 3, 4, 0, 0, 0, 0, 0, 0, 7, 0, 0, 0, 0, 0, 7, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
-    "pos_tags": [12, 22, 22, 38, 15, 22, 28, 38, 15, 16, 21, 35, 24, 35, 37, 16, 21, 15, 24, 41, 15, 16, 21, 21, 20, 37, 40, 35, 21, 7],
-    "tokens": ["The", "European", "Commission", "said", "on", "Thursday", "it", "disagreed", "with", "German", "advice", "to", "consumers", "to", "shun", "British", "lamb", "until", "scientists", "determine", "whether", "mad", "cow", "disease", "can", "be", "transmitted", "to", "sheep", "."]
+    "full_text": "{\"full_name_female\": \"Bethany Williams\", \"NewServerCertificateName\": \"\", \"NewPath\": \"\", \"ServerCertificateName\": \"dCwMNqR\", \"Action\": \"\", \"Version\": \"u zNS zNS\"}",
+        "masked": "{\"full_name_female\": \"{{name_female}}\", \"NewServerCertificateName\": \"{{string}}\", \"NewPath\": \"{{string}}\", \"ServerCertificateName\": \"{{string}}\", \"Action\": \"{{string}}\", \"Version\": \"{{string}}\"}",
+        "spans": [
+            {
+                "entity_type": "PERSON",
+                "entity_value": "Bethany Williams",
+                "start_position": 22,
+                "end_position": 38
+            }
+        ],
+        "template_id": 51889,
+        "metadata": null
 }
 ```
 
-The original data files have `-DOCSTART-` lines used to separate documents, but these lines are removed here.
-Indeed `-DOCSTART-` is a special line that acts as a boundary between two different documents, and it is filtered out in this implementation.
-
-### Data Fields
-
-The data fields are the same among all splits.
-
-#### conll2003
-- `id`: a `string` feature.
-- `tokens`: a `list` of `string` features.
-- `pos_tags`: a `list` of classification labels (`int`). Full tagset with indices:
-
-```python
-{'"': 0, "''": 1, '#': 2, '$': 3, '(': 4, ')': 5, ',': 6, '.': 7, ':': 8, '``': 9, 'CC': 10, 'CD': 11, 'DT': 12,
- 'EX': 13, 'FW': 14, 'IN': 15, 'JJ': 16, 'JJR': 17, 'JJS': 18, 'LS': 19, 'MD': 20, 'NN': 21, 'NNP': 22, 'NNPS': 23,
- 'NNS': 24, 'NN|SYM': 25, 'PDT': 26, 'POS': 27, 'PRP': 28, 'PRP$': 29, 'RB': 30, 'RBR': 31, 'RBS': 32, 'RP': 33,
- 'SYM': 34, 'TO': 35, 'UH': 36, 'VB': 37, 'VBD': 38, 'VBG': 39, 'VBN': 40, 'VBP': 41, 'VBZ': 42, 'WDT': 43,
- 'WP': 44, 'WP$': 45, 'WRB': 46}
-```
-
-- `chunk_tags`: a `list` of classification labels (`int`). Full tagset with indices:
-
-```python
-{'O': 0, 'B-ADJP': 1, 'I-ADJP': 2, 'B-ADVP': 3, 'I-ADVP': 4, 'B-CONJP': 5, 'I-CONJP': 6, 'B-INTJ': 7, 'I-INTJ': 8,
- 'B-LST': 9, 'I-LST': 10, 'B-NP': 11, 'I-NP': 12, 'B-PP': 13, 'I-PP': 14, 'B-PRT': 15, 'I-PRT': 16, 'B-SBAR': 17,
- 'I-SBAR': 18, 'B-UCP': 19, 'I-UCP': 20, 'B-VP': 21, 'I-VP': 22}
-```
-
-- `ner_tags`: a `list` of classification labels (`int`). Full tagset with indices:
-
-```python
-{'O': 0, 'B-PER': 1, 'I-PER': 2, 'B-ORG': 3, 'I-ORG': 4, 'B-LOC': 5, 'I-LOC': 6, 'B-MISC': 7, 'I-MISC': 8}
-```
-
 ### Data Splits
 
 |  name   |train|validation|test|