docs: add devnote for evaluation rewrite - #241
Conversation
Signed-off-by: memadi <memadi@nvidia.com>
a586797 to
898c419
Compare
Greptile SummaryAdds a Rewrite-mode evaluation developer note and registers it in the documentation navigation.
Confidence Score: 4/5The PR appears safe to merge after considering a non-blocking documentation hardening note for the pickle reload example. The documented evaluation behavior matches the current implementation, navigation and links resolve, and the only accepted concern is the missing trusted-input warning around pickle deserialization. Files Needing Attention: docs/devnotes/posts/evaluation-anonymizer-rewrite.md
|
| Filename | Overview |
|---|---|
| docs/devnotes/posts/evaluation-anonymizer-rewrite.md | The evaluation semantics and examples match the implementation, but the pickle reload example needs an explicit trusted-files warning. |
| mkdocs.yml | Adds the new developer note to the existing Developer Notes navigation using the established structure. |
| docs/devnotes/posts/assets/evaluate-rewrite-display-record.png | Adds the report screenshot referenced by the new article. |
Reviews (1): Last reviewed commit: "nit" | Re-trigger Greptile
| saved_result = pickle.load(f) | ||
|
|
There was a problem hiding this comment.
Warn that pickle requires trust
If the saved result comes from or can be replaced through an untrusted location, pickle.load() can execute attacker-controlled code with the user's privileges. Add an explicit warning that this workflow must only load trusted files.
Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!
Summary
Adds a developer note explaining rewrite-mode evaluation, its strategy-specific scores, output columns, usage examples, and display_record() report. Includes a report screenshot.
Type of Change
Contributor Checklist
fix: handle empty entity listskills/anonymizer/SKILL.mdupdated if neededValidation
Documentation and Artifacts
make docs-buildpasses locallymake convert-notebooks