Datasets:
Upload README.md with huggingface_hub
Browse files
README.md
CHANGED
|
@@ -24,7 +24,7 @@ configs:
|
|
| 24 |
default_config_name: sample_notes
|
| 25 |
---
|
| 26 |
|
| 27 |
-
> **This is a public sample of the SHIELD dataset.** It contains a small subset of the data for exploring the schema and building your pipeline. For the **full dataset**, see [
|
| 28 |
|
| 29 |
# SHIELD
|
| 30 |
|
|
@@ -33,7 +33,7 @@ SHIELD is a dataset of clinical text with PHI (Protected Health Information) spa
|
|
| 33 |
## Quickstart
|
| 34 |
|
| 35 |
1. This **public sample** is available without access approval — use it to explore the schema and build your pipeline
|
| 36 |
-
2. To access the **full dataset**, complete the [access request process](#access-requirements) at [
|
| 37 |
|
| 38 |
## Dataset Structure
|
| 39 |
|
|
@@ -77,8 +77,8 @@ SHIELD is a dataset of clinical text with PHI (Protected Health Information) spa
|
|
| 77 |
from datasets import load_dataset
|
| 78 |
|
| 79 |
# Public sample (no access request needed)
|
| 80 |
-
sample_notes = load_dataset("
|
| 81 |
-
sample_spans = load_dataset("
|
| 82 |
```
|
| 83 |
|
| 84 |
### Loading the full dataset (requires access)
|
|
@@ -87,8 +87,8 @@ sample_spans = load_dataset("shc-research-tech/shield-sample", "sample_spans")
|
|
| 87 |
from datasets import load_dataset
|
| 88 |
|
| 89 |
# Full dataset (requires approved access)
|
| 90 |
-
full_notes = load_dataset("
|
| 91 |
-
full_spans = load_dataset("
|
| 92 |
```
|
| 93 |
|
| 94 |
---
|
|
@@ -105,7 +105,7 @@ Before applying, make sure you have the following:
|
|
| 105 |
|
| 106 |
The access request process has six steps:
|
| 107 |
|
| 108 |
-
1. **Request Access on Hugging Face** — Go to [
|
| 109 |
2. **Complete CITI Training** — If you haven't already, complete the [CITI "Data or Specimens Only Research" course](https://physionet.org/about/citi-course/) and download your completion certificate.
|
| 110 |
3. **Submit Access Request on REDCap** — Complete our [REDCap verification form](https://redcap.stanford.edu/surveys/?s=LJ77HAA3HXRLTFEP). Provide your name, institution, role, Hugging Face username, intended use, and upload your CITI completion certificate.
|
| 111 |
4. **Sign the Data Use Agreement** — Read and electronically sign the DUA. You will be automatically redirected after step 3.
|
|
|
|
| 24 |
default_config_name: sample_notes
|
| 25 |
---
|
| 26 |
|
| 27 |
+
> **This is a public sample of the SHIELD dataset.** It contains a small subset of the data for exploring the schema and building your pipeline. For the **full dataset**, see [tds-research-tech/shield](https://huggingface.co/datasets/tds-research-tech/shield) (requires access approval).
|
| 28 |
|
| 29 |
# SHIELD
|
| 30 |
|
|
|
|
| 33 |
## Quickstart
|
| 34 |
|
| 35 |
1. This **public sample** is available without access approval — use it to explore the schema and build your pipeline
|
| 36 |
+
2. To access the **full dataset**, complete the [access request process](#access-requirements) at [tds-research-tech/shield](https://huggingface.co/datasets/tds-research-tech/shield)
|
| 37 |
|
| 38 |
## Dataset Structure
|
| 39 |
|
|
|
|
| 77 |
from datasets import load_dataset
|
| 78 |
|
| 79 |
# Public sample (no access request needed)
|
| 80 |
+
sample_notes = load_dataset("tds-research-tech/shield-sample", "sample_notes")
|
| 81 |
+
sample_spans = load_dataset("tds-research-tech/shield-sample", "sample_spans")
|
| 82 |
```
|
| 83 |
|
| 84 |
### Loading the full dataset (requires access)
|
|
|
|
| 87 |
from datasets import load_dataset
|
| 88 |
|
| 89 |
# Full dataset (requires approved access)
|
| 90 |
+
full_notes = load_dataset("tds-research-tech/shield", "full_notes")
|
| 91 |
+
full_spans = load_dataset("tds-research-tech/shield", "full_spans")
|
| 92 |
```
|
| 93 |
|
| 94 |
---
|
|
|
|
| 105 |
|
| 106 |
The access request process has six steps:
|
| 107 |
|
| 108 |
+
1. **Request Access on Hugging Face** — Go to [tds-research-tech/shield](https://huggingface.co/datasets/tds-research-tech/shield) and click "Request Access" to register your Hugging Face account.
|
| 109 |
2. **Complete CITI Training** — If you haven't already, complete the [CITI "Data or Specimens Only Research" course](https://physionet.org/about/citi-course/) and download your completion certificate.
|
| 110 |
3. **Submit Access Request on REDCap** — Complete our [REDCap verification form](https://redcap.stanford.edu/surveys/?s=LJ77HAA3HXRLTFEP). Provide your name, institution, role, Hugging Face username, intended use, and upload your CITI completion certificate.
|
| 111 |
4. **Sign the Data Use Agreement** — Read and electronically sign the DUA. You will be automatically redirected after step 3.
|