Skip to content

docs: add hospital readmissions tutorial #725

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
zywind wants to merge 6 commits into
base: main
Choose a base branch
from
Open

docs: add hospital readmissions tutorial #725

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
535caa1
docs: add hospital readmissions tutorial
zywind Aug 19, 2026
27741d2
docs: clear healthcare notebook outputs
zywind Aug 19, 2026
13f6650
ci: exclude simulated healthcare dataset from secret scan
zywind Aug 19, 2026
685ef80
docs: add healthcare tutorial conclusion
zywind Aug 20, 2026
b570d35
docs: refine healthcare tutorial guidance
zywind Aug 20, 2026
046c12e
docs: quiet tutorial dependency installation (#726)
zywind Aug 21, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions .github/workflows/config/.secrets.baseline
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -109,6 +109,12 @@
},
{
"path": "detect_secrets.filters.heuristic.is_templated_secret"
},
{
"path": "detect_secrets.filters.regex.should_exclude_file",
"pattern": [
"^docs/tutorials/datasets/hospital_readmissions_synthetic_2026_08_18\\.csv$"
]
}
],
"results": {}
Expand Down
10,214 changes: 10,214 additions & 0 deletions docs/tutorials/datasets/hospital_readmissions_synthetic_2026_08_18.csv
View file
Open in desktop

Large diffs are not rendered by default.

8 changes: 4 additions & 4 deletions docs/tutorials/differential-privacy.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,15 +44,15 @@
" --index https://flashinfer.ai/whl/ \\\n",
" --index https://download.pytorch.org/whl/cu129 \\\n",
" --index https://wheels.vllm.ai/0.26.0/cu129 \\\n",
" --index-strategy unsafe-best-match\n",
" uv pip install kagglehub\n",
" --index-strategy unsafe-best-match --quiet\n",
" uv pip install kagglehub --quiet\n",
"else\n",
" pip install \"nemo-safe-synthesizer[engine,cu129]\" \\\n",
" --extra-index-url https://flashinfer.ai/whl/cu129 \\\n",
" --extra-index-url https://flashinfer.ai/whl/ \\\n",
" --extra-index-url https://download.pytorch.org/whl/cu129 \\\n",
" --extra-index-url https://wheels.vllm.ai/0.26.0/cu129\n",
" pip install kagglehub\n",
" --extra-index-url https://wheels.vllm.ai/0.26.0/cu129 --quiet\n",
" pip install kagglehub --quiet\n",
"fi\n"
]
},
Expand Down
650 changes: 650 additions & 0 deletions docs/tutorials/healthcare-hospital-readmissions.ipynb
View file
Open in desktop

Large diffs are not rendered by default.

3 changes: 2 additions & 1 deletion docs/tutorials/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Interactive Jupyter notebook tutorials for NeMo Safe Synthesizer.
[![Launch on Brev](https://brev-assets.s3.us-west-1.amazonaws.com/nv-lb-light.svg#only-dark)](https://brev.nvidia.com/launchable/deploy/now?launchableID=env-3HBtA2NKQaBukL2TyDphWUcvQ17)

These notebooks need a Linux machine with an NVIDIA GPU. The launchable above provides
one with Safe Synthesizer and all three notebooks already installed.
one with Safe Synthesizer and all four notebooks already installed.

!!! warning "The instance bills continuously"
Most GPU providers on Brev do not support stopping an instance. Billing runs from
Expand All @@ -21,6 +21,7 @@ one with Safe Synthesizer and all three notebooks already installed.
- [Safe Synthesizer 101](safe-synthesizer-101.ipynb) -- learn the fundamentals
- [Differential Privacy](differential-privacy.ipynb) -- enable differential privacy guarantees
- [Time-Series Financial Transactions](time-series-financial-transactions.ipynb) -- synthesize grouped transaction histories
- [Healthcare Hospital Readmissions](healthcare-hospital-readmissions.ipynb) -- explore privacy-aware healthcare utilization analytics

## Adding a Tutorial

Expand Down
8 changes: 4 additions & 4 deletions docs/tutorials/safe-synthesizer-101.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,15 +50,15 @@
" --index https://flashinfer.ai/whl/ \\\n",
" --index https://download.pytorch.org/whl/cu129 \\\n",
" --index https://wheels.vllm.ai/0.26.0/cu129 \\\n",
" --index-strategy unsafe-best-match\n",
" uv pip install datasets\n",
" --index-strategy unsafe-best-match --quiet\n",
" uv pip install datasets --quiet\n",
"else\n",
" pip install \"nemo-safe-synthesizer[engine,cu129]\" \\\n",
" --extra-index-url https://flashinfer.ai/whl/cu129 \\\n",
" --extra-index-url https://flashinfer.ai/whl/ \\\n",
" --extra-index-url https://download.pytorch.org/whl/cu129 \\\n",
" --extra-index-url https://wheels.vllm.ai/0.26.0/cu129\n",
" pip install datasets\n",
" --extra-index-url https://wheels.vllm.ai/0.26.0/cu129 --quiet\n",
" pip install datasets --quiet\n",
"fi\n"
]
},
Expand Down
4 changes: 2 additions & 2 deletions docs/tutorials/time-series-financial-transactions.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,13 +58,13 @@
" --index https://flashinfer.ai/whl/\\\n",
" --index https://download.pytorch.org/whl/cu129 \\\n",
" --index https://wheels.vllm.ai/0.26.0/cu129 \\\n",
" --index-strategy unsafe-best-match\n",
" --index-strategy unsafe-best-match --quiet\n",
"else\n",
" pip install \"nemo-safe-synthesizer[engine,cu129]\" \\\n",
" --extra-index-url https://flashinfer.ai/whl/cu129 \\\n",
" --extra-index-url https://flashinfer.ai/whl/ \\\n",
" --extra-index-url https://download.pytorch.org/whl/cu129 \\\n",
" --extra-index-url https://wheels.vllm.ai/0.26.0/cu129\n",
" --extra-index-url https://wheels.vllm.ai/0.26.0/cu129 --quiet\n",
"fi"
],
"execution_count": null,
Expand Down
1 change: 1 addition & 0 deletions mkdocs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -177,6 +177,7 @@ nav:
- Safe Synthesizer 101: tutorials/safe-synthesizer-101.ipynb
- Differential Privacy: tutorials/differential-privacy.ipynb
- Time-Series Financial Transactions: tutorials/time-series-financial-transactions.ipynb
- Healthcare Hospital Readmissions: tutorials/healthcare-hospital-readmissions.ipynb
- User Guide:
- Getting Started: user-guide/getting-started.md
- Running Safe Synthesizer: user-guide/running.md
Expand Down
2 changes: 1 addition & 1 deletion script/brev/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ there. Everything operational is a dotfile, which the browser hides by default.

```text
$HOME/
tutorials/ the three tutorial notebooks and their datasets
tutorials/ the four tutorial notebooks and their datasets
welcome.md where to start, rendered on double-click
SETUP-IN-PROGRESS.md present only while setup is running or after failure

Expand Down
3 changes: 2 additions & 1 deletion script/brev/welcome.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,11 @@ Open `tutorials/safe-synthesizer-101.ipynb` and run the cells top to bottom.
It takes about 15 minutes and walks through the full pipeline on a sample
dataset.

The other two notebooks go deeper:
The other three notebooks go deeper:

- `tutorials/differential-privacy.ipynb` -- formal privacy guarantees (~1 hour)
- `tutorials/time-series-financial-transactions.ipynb` -- sequential data (~20 minutes)
- `tutorials/healthcare-hospital-readmissions.ipynb` -- privacy-aware healthcare analytics (~1 hour)

## Using your own data

Expand Down
Loading