beki commited on
Commit
632088e
1 Parent(s): 8d285d2

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +19 -3
README.md CHANGED
@@ -55,14 +55,30 @@ train-eval-index:
55
  - **Size of the generated dataset:** 146.4 MB
56
 
57
  ### Dataset Summary
58
- A synthetic dataset generated using [Privy](https://github.com/pixie-io/pixie/tree/main/src/datagen/pii/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.
59
 
60
  This labelled PII dataset consists of protocol traces (JSON, SQL (PostgreSQL, MySQL), HTML, and XML) generated from OpenAPI specifications and includes 60+ PII types.
61
 
62
- An IOB tagged version of this dataset is available under `iob/`.
63
-
64
  ### Supported Tasks and Leaderboards
65
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
66
  [More Information Needed](https://github.com/huggingface/datasets/blob/master/CONTRIBUTING.md#how-to-contribute-to-the-dataset-cards)
67
 
68
  ### Languages
 
55
  - **Size of the generated dataset:** 146.4 MB
56
 
57
  ### Dataset Summary
58
+ A synthetic PII dataset generated using [Privy](https://github.com/pixie-io/pixie/tree/main/src/datagen/pii/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.
59
 
60
  This labelled PII dataset consists of protocol traces (JSON, SQL (PostgreSQL, MySQL), HTML, and XML) generated from OpenAPI specifications and includes 60+ PII types.
61
 
 
 
62
  ### Supported Tasks and Leaderboards
63
 
64
+ Named Entity Recognition (NER) and PII classification.
65
+
66
+ ### Label Scheme
67
+
68
+ <details>
69
+
70
+ <summary>View label scheme (26 labels for 60 PII data providers)</summary>
71
+
72
+ | Component | Labels |
73
+ | --- | --- |
74
+ | **`ner`** | `PERSON`, `LOCATION`, `NRP`, `DATE_TIME`, `CREDIT_CARD`, `URL`, `IBAN_CODE`, `US_BANK_NUMBER`, `PHONE_NUMBER`, `US_SSN`, `US_PASSPORT`, `US_DRIVER_LICENSE`, `IP_ADDRESS`, `US_ITIN`, `EMAIL_ADDRESS`, `ORGANIZATION`, `TITLE`, `COORDINATE`, `IMEI`, `PASSWORD`, `LICENSE_PLATE`, `CURRENCY`, `ROUTING_NUMBER`, `SWIFT_CODE`, `MAC_ADDRESS`, `AGE` |
75
+
76
+ Conversion diagram:
77
+
78
+ ![Label Conversion Diagram](./label_conversions.png)
79
+
80
+ </details>
81
+
82
  [More Information Needed](https://github.com/huggingface/datasets/blob/master/CONTRIBUTING.md#how-to-contribute-to-the-dataset-cards)
83
 
84
  ### Languages