Skip to content

docs: documentation site content#84

Merged
lipikaramaswamy merged 30 commits into
mainfrom
lipikaramaswamy/docs/initial-docs
Apr 6, 2026
Merged

docs: documentation site content#84
lipikaramaswamy merged 30 commits into
mainfrom
lipikaramaswamy/docs/initial-docs

Conversation

@lipikaramaswamy
Copy link
Copy Markdown
Collaborator

@lipikaramaswamy lipikaramaswamy commented Apr 1, 2026

Summary

Complete documentation site for NeMo Anonymizer, built with MkDocs Material.

Content

  • Home page: Landing with tabbed strategy examples, install, quickstart code
  • Concepts: Models, Detect, Replace, Rewrite -- config tables, examples, admonitions
  • Tutorials: 5 notebooks with executed outputs (biographies + legal datasets)
  • API Reference: Auto-generated from docstrings, empty pages excluded

Code changes

  • Reorder Substitute first in replace_strategies.py (API ref priority)
  • Remove {text} from Redact/Hash allowed template fields (fixes fix: remove {text} from allowed template placeholders in Redact and Hash #80)
  • Reduce max_parallel_requests to 2 for rate limit safety
  • Add make convert-notebooks target
  • Move e2e script to tests_e2e/
  • Polished Tier 1 docstrings (result types, replace methods, logging)

Styling

  • NVIDIA green headers, incognito logo/favicon, card grid styling
  • Sidebar nav (no top tabs), collapsed sections, DD-consistent layout
  • Light mode code block backgrounds

Known follow-ups

Related Issues

Closes #80

@lipikaramaswamy lipikaramaswamy requested review from a team as code owners April 1, 2026 01:38
@lipikaramaswamy lipikaramaswamy force-pushed the lipikaramaswamy/docs/initial-docs branch from 8f2d6bc to 59bc473 Compare April 1, 2026 01:43
Copy link
Copy Markdown
Contributor

@nina-xu nina-xu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

awesome stuff. thanks!

saw that anonymizer replaced SpaceX with Blue Origin. Savage

Comment thread docs/notebook_source/01_your_first_anonymization.py Outdated
Comment thread docs/notebook_source/03_choosing_a_replacement_strategy.py Outdated
Comment thread docs/notebook_source/03_choosing_a_replacement_strategy.py Outdated
Comment thread docs/notebook_source/03_choosing_a_replacement_strategy.py Outdated
Comment thread docs/notebook_source/04_rewriting_biographies.py
Comment thread docs/notebook_source/01_your_first_anonymization.py
Comment thread docs/notebook_source/05_rewriting_legal_documents.py Outdated
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Apr 1, 2026

All contributors have signed the DCO ✍️ ✅
Posted by the DCO Assistant Lite bot.

Comment thread docs/concepts/detection.md Outdated
Comment thread docs/concepts/detection.md Outdated
Comment thread docs/concepts/detection.md Outdated
Comment thread docs/concepts/models.md Outdated
Comment thread docs/concepts/models.md
Comment thread tests_e2e/test_e2e.py
Comment thread docs/index.md Outdated
Comment thread docs/notebooks/04_rewriting_biographies.ipynb
Comment thread docs/notebook_source/01_your_first_anonymization.py
Comment thread docs/notebook_source/05_rewriting_legal_documents.py Outdated
Comment thread docs/notebook_source/02_inspecting_detected_entities.py
@mckornfield mckornfield force-pushed the lipikaramaswamy/docs/initial-docs branch from 9ee0c71 to 8c0e00d Compare April 1, 2026 17:31
Copy link
Copy Markdown
Contributor

@nina-xu nina-xu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

approving the notebooks 👍 i didn't read the rest

@alexahaushalter
Copy link
Copy Markdown
Contributor

I have read the DCO document and I hereby sign the DCO.

Comment thread docs/index.md Outdated
Comment thread docs/tutorials/index.md Outdated
Comment thread docs/notebooks/03_choosing_a_replacement_strategy.ipynb
Comment thread docs/notebook_source/01_your_first_anonymization.py Outdated
Comment thread docs/notebook_source/03_choosing_a_replacement_strategy.py Outdated
Comment thread docs/notebook_source/01_your_first_anonymization.py
Comment thread docs/notebook_source/04_rewriting_biographies.py Outdated
Comment thread docs/notebook_source/05_rewriting_legal_documents.py
Comment thread docs/notebook_source/05_rewriting_legal_documents.py
Comment thread docs/notebook_source/05_rewriting_legal_documents.py
Comment thread docs/notebook_source/04_rewriting_biographies.py
Comment thread docs/concepts/rewrite.md
Comment thread docs/concepts/rewrite.md
Copy link
Copy Markdown
Contributor

@memadi-nv memadi-nv left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks Lipika! Left some feedbacks mainly on the notebooks.
Not for this PR necessarily, but we can add something like the NSS style_guide in the future so all the docs follow the same pattern across the libraries.

Comment thread docs/notebook_source/04_rewriting_biographies.py Outdated
Comment thread docs/notebook_source/05_rewriting_legal_documents.py Outdated
Comment thread docs/notebook_source/04_rewriting_biographies.py
Comment thread docs/notebook_source/04_rewriting_biographies.py Outdated
Comment thread docs/notebook_source/05_rewriting_legal_documents.py Outdated
Comment thread docs/notebook_source/03_choosing_a_replacement_strategy.py Outdated
Comment thread docs/notebook_source/03_choosing_a_replacement_strategy.py Outdated
Comment thread docs/notebook_source/01_your_first_anonymization.py
@memadi-nv memadi-nv self-requested a review April 6, 2026 17:12
Copy link
Copy Markdown
Contributor

@memadi-nv memadi-nv left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

looking great, thanks Lipika!

@lipikaramaswamy lipikaramaswamy merged commit 2e3d40b into main Apr 6, 2026
11 checks passed
@lipikaramaswamy lipikaramaswamy deleted the lipikaramaswamy/docs/initial-docs branch April 6, 2026 17:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

fix: remove {text} from allowed template placeholders in Redact and Hash

6 participants