docs: add dp notebook#253
Conversation
nina-xu
force-pushed
the
nina/docs/102-dp-notebook
branch
from
e0ca899 to
77b5e3c
Compare
There was a problem hiding this comment.
Pull request overview
Adds a new differential privacy (DP) tutorial notebook and refines the existing “Safe Synthesizer 101” notebook to improve wording and execution flow.
Changes:
- Added a new DP tutorial notebook (
docs/tutorials/differential-privacy.ipynb). - Updated the 101 tutorial to fix wording/links and adjust the tutorial structure (
docs/tutorials/safe-synthesizer-101.ipynb). - Added explicit generator teardown calls after pipeline runs in both notebooks.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 8 comments.
| File | Description |
|---|---|
| docs/tutorials/safe-synthesizer-101.ipynb | Wording/structure updates; reordered sections; adds explicit resource teardown call. |
| docs/tutorials/differential-privacy.ipynb | New DP-focused tutorial notebook covering dataset loading, DP configuration, generation, and evaluation. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
You can also share your feedback on Copilot code review. Take the survey.
There was a problem hiding this comment.
Pull request overview
Adds a new Differential Privacy tutorial notebook and updates the existing “Safe Synthesizer 101” notebook wording/links to improve the docs tutorial set.
Changes:
- Added a new
differential-privacy.ipynbtutorial demonstrating DP configuration in the SDK builder workflow. - Updated
safe-synthesizer-101.ipynbheadings/text, fixed minor wording/link issues, and adjusted the builder example to explicitly callresolve().
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| docs/tutorials/safe-synthesizer-101.ipynb | Minor tutorial copy/link adjustments and builder example tweaks. |
| docs/tutorials/differential-privacy.ipynb | New DP tutorial notebook with install, dataset load, DP configuration, and report review steps. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
You can also share your feedback on Copilot code review. Take the survey.
There was a problem hiding this comment.
Pull request overview
Adds Jupyter notebook tutorials to the documentation site, including a new Differential Privacy walkthrough, and updates the existing “Safe Synthesizer 101” notebook for consistency and improved links.
Changes:
- Added two notebook tutorials to the MkDocs nav (Safe Synthesizer 101 and Differential Privacy).
- Updated the tutorials landing page to link to the new notebooks.
- Refined the Safe Synthesizer 101 notebook wording/links and adjusted result-saving/report-viewing cells.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 6 comments.
| File | Description |
|---|---|
| mkdocs.yml | Adds the two tutorial notebooks to the rendered documentation navigation. |
| docs/tutorials/index.md | Lists the available tutorials with links to the notebooks. |
| docs/tutorials/safe-synthesizer-101.ipynb | Polishes the baseline tutorial content and updates result/report handling. |
| docs/tutorials/differential-privacy.ipynb | Introduces a new DP-focused tutorial notebook. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
nina-xu
force-pushed
the
nina/docs/102-dp-notebook
branch
from
b9417ce to
26fef7a
Compare
nina-xu
force-pushed
the
nina/docs/102-dp-notebook
branch
from
26fef7a to
317a9ca
Compare
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 5 out of 5 changed files in this pull request and generated 4 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Add two interactive Jupyter notebook tutorials: - safe-synthesizer-101.ipynb: fundamentals of PII replacement, training, generation, and evaluation - differential-privacy.ipynb: configuring differential privacy with recommended delta and structured generation Display the HTML evaluation report in a sandboxed IFrame to prevent CSS/JS leakage into the notebook UI. Signed-off-by: nina-xu <19981858+nina-xu@users.noreply.github.com> Made-with: Cursor
Signed-off-by: nina-xu <19981858+nina-xu@users.noreply.github.com>
Signed-off-by: nina-xu <19981858+nina-xu@users.noreply.github.com>
nina-xu
force-pushed
the
nina/docs/102-dp-notebook
branch
from
516fedd to
92a39b6
Compare
Signed-off-by: nina-xu <19981858+nina-xu@users.noreply.github.com>
nina-xu
force-pushed
the
nina/docs/102-dp-notebook
branch
from
92a39b6 to
9437935
Compare
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Signed-off-by: nina-xu <19981858+nina-xu@users.noreply.github.com>
Signed-off-by: nina-xu <19981858+nina-xu@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 3 out of 3 changed files in this pull request and generated 4 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Signed-off-by: nina-xu <19981858+nina-xu@users.noreply.github.com>
<!-- SPDX-FileCopyrightText: Copyright (c) 2025-2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved. --> <!-- SPDX-License-Identifier: Apache-2.0 --> <!-- Thank you for contributing to Safe Synthesizer! --> # Summary <!-- Brief description of changes --> This PR extracts the Safe Synthesizer 101 notebook updates from PR #253. Changes include: - Adding 101 notebook related links in the documentation - Aligning the notebook with recent updates on how the generated SD and evaluation report are saved (follow-up to #272) ## Pre-Review Checklist <!-- These checks should be completed before a PR is reviewed, --> <!-- but you can submit a draft early to indicate that the issue is being worked on. --> Ensure that the following pass: - [x] `make format && make check` or via prek validation. - [ ] `make test` passes locally - [ ] `make test-e2e` passes locally - [ ] `make test-ci-container` passes locally (recommended) - [ ] GPU CI status check passes -- comment `/sync` on this PR to trigger a run (auto-triggers on ready-for-review) ## Pre-Merge Checklist <!-- These checks need to be completed before a PR is merged, --> <!-- but as PRs often change significantly during review, --> <!-- it's OK for them to be incomplete when review is first requested. --> - [ ] New or updated tests for any fix or new behavior - [ ] Updated documentation for new features and behaviors, including docstrings for API docs. ## Other Notes <!-- Please add the issue number that should be closed when this PR is merged. --> - Closes #<issue> --------- Signed-off-by: nina-xu <19981858+nina-xu@users.noreply.github.com> Signed-off-by: memadi <memadi@nvidia.com> Signed-off-by: Nina Xu <19981858+nina-xu@users.noreply.github.com> Co-authored-by: nina-xu <19981858+nina-xu@users.noreply.github.com>
kendrickb-nvidia
left a comment
kendrickb-nvidia
left a comment
There was a problem hiding this comment.
The installation command still references internal nvidia urls, but I'm okay to merge as is and fix that in a followup PR.
Signed-off-by: Nina Xu <19981858+nina-xu@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 3 out of 3 changed files in this pull request and generated no new comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Signed-off-by: nina-xu <19981858+nina-xu@users.noreply.github.com>
Summary
Add a 102 notebook for differential privacy. Fixed some links etc. in the 101 notebook as well.
Pre-Review Checklist
Ensure that the following pass:
make format && make checkor via prek validation.make testpasses locallymake test-e2epasses locallymake test-ci-containerpasses locally (recommended)/syncon this PR to trigger a run (auto-triggers on ready-for-review)Pre-Merge Checklist
Other Notes