Skip to content

docs: add devnote for evaluation replace - #239

Open
memadi-nv wants to merge 11 commits into
mainfrom
memadi/docs/evaluation-anonymizer-replace-devnote
Open

docs: add devnote for evaluation replace#239
memadi-nv wants to merge 11 commits into
mainfrom
memadi/docs/evaluation-anonymizer-replace-devnote

Conversation

@memadi-nv

Copy link
Copy Markdown
Contributor

Summary

Adds a developer note explaining Replace-mode evaluation, its strategy-specific scores, output columns, usage examples, and display_record() report. Includes a report screenshot.

Type of Change

  • Bug fix
  • New feature
  • Breaking change
  • Documentation update
  • Refactoring
  • CI, release, or contributor workflow update

Contributor Checklist

  • PR title follows Conventional Commits, for example fix: handle empty entity list
  • Related issue is linked, or a maintainer-owned no-issue reason is documented above
  • For non-trivial changes, a plan document is linked above, or the no-plan reason is documented above
  • Public API impact checked; skills/anonymizer/SKILL.md updated if needed
  • No real PII added to tests, docs, notebooks, fixtures, or artifacts
  • No API keys, service tokens, private keys, credentials, or real endpoint secrets added

Validation

  • Commands run:
  • Skipped checks or known failures:

Documentation and Artifacts

  • Docs updated, or not needed
  • If docs changed: make docs-build passes locally
  • If tutorial sources changed: notebooks regenerated with make convert-notebooks
  • If e2e, benchmark, or model-provider behavior changed: relevant validation is listed above

Signed-off-by: memadi <memadi@nvidia.com>
Signed-off-by: memadi <memadi@nvidia.com>
Signed-off-by: memadi <memadi@nvidia.com>
Signed-off-by: memadi <memadi@nvidia.com>
@memadi-nv
memadi-nv requested review from a team as code owners August 7, 2026 00:12
@memadi-nv memadi-nv changed the title Memadi/docs/evaluation anonymizer replace devnote docs: add devnote for evaluation replace Aug 7, 2026
@greptile-apps

greptile-apps Bot commented Aug 7, 2026

Copy link
Copy Markdown
Contributor

Greptile Summary

Adds a developer note explaining Replace-mode evaluation and connects it to the documentation navigation.

  • Documents reusable evaluation results, entity coverage, optional detection validity, and Substitute-specific quality scores.
  • Provides evaluation, report-display, and judge-model configuration examples.
  • Adds report and hero images plus the author metadata for the post.

Confidence Score: 5/5

The PR appears safe to merge.

No blocking failure remains.

Important Files Changed

Filename Overview
docs/devnotes/posts/evaluation-anonymizer-replace.md Adds an accurate guide to Replace-mode evaluation, supported outputs, report rendering, and model configuration.
mkdocs.yml Adds the new developer note to the documentation navigation.
docs/devnotes/.authors.yml Adds author metadata referenced by the new post.

Reviews (6): Last reviewed commit: "remove duplicate diagrams/flowcharts" | Re-trigger Greptile

Comment thread docs/devnotes/posts/evaluation-anonymizer-replace.md
Comment thread docs/devnotes/posts/evaluation-anonymizer-replace.md
Comment thread docs/devnotes/posts/evaluation-anonymizer-replace.md Outdated
Comment thread docs/devnotes/posts/evaluation-anonymizer-replace.md Outdated
Comment thread docs/devnotes/posts/evaluation-anonymizer-replace.md Outdated
Comment thread docs/devnotes/posts/evaluation-anonymizer-replace.md Outdated
Comment thread docs/devnotes/posts/evaluation-anonymizer-replace.md Outdated
Comment thread docs/devnotes/posts/evaluation-anonymizer-replace.md
Signed-off-by: memadi <memadi@nvidia.com>
Signed-off-by: memadi <memadi@nvidia.com>
Signed-off-by: memadi <memadi@nvidia.com>

@lipikaramaswamy lipikaramaswamy left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Looks good! I assume the image and page render correctly when you run the docs locally with make docs-serve or make docs-build?

Comment thread docs/devnotes/posts/evaluation-anonymizer-replace.md
Signed-off-by: memadi <memadi@nvidia.com>
Signed-off-by: memadi <memadi@nvidia.com>
@memadi-nv

Copy link
Copy Markdown
Contributor Author

Looks good! I assume the image and page render correctly when you run the docs locally with make docs-serve or make docs-build?

confirmed. This has been reviewed locally with make docs-serve.

Signed-off-by: memadi <memadi@nvidia.com>
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.

2 participants