Update README.md

README.md

@@ -33,3 +33,29 @@ configs:
   - split: val
     path: data/val-*
 ---
+
+# Dataset Card for {{ pretty_name | default("Dataset Name", true) }}
+
+<!-- Provide a quick summary of the dataset. -->
+
+This data set contains VAERS `SYMPTOM_TEXT` records paired with a list of potential outcomes.
+
+
+### Source Data
+
+Data originates from [VAERS](https://vaers.hhs.gov).
+
+### Encoding
+
+The `label` column comprises a 7-length binary array that comprises the following values:
+
+| Name | Meaning | VAERS originating field |
+| ---- | --- | --- | --- |
+| `DIED` | Whether the patient died | `DIED` |
+| `ER_VISIT` | Whether the patient has presented at an ER/ED | `ER_VISIT` and `ER_ED_VISIT` (depending on version) |
+| `HOSPITAL` | True if the patient was admitted to hospital | `HOSPITAL` |
+| `OFC_VISIT` | Whether the patient presented at a doctor's office | `OFC_VISIT` |
+| `X_STAY` | True if the patient's existing hospital admission was prolonged in a manner attributed by the reporter to the report event | `X_STAY` |
+| `DISABLE` | True if the patient continued, at the time of report, to experience a disability attributed by the reporter to the report event | `DISABLE` |
+| `D_PRESENTED` | A derived field, `D_PRESENTED` is true if the patient presented at ER, a doctor's office or hospital. Automatically true if `X_STAY` is true. | None (derived field) |
+