LCORE-3394: Granite Guardian Shield Docs - #2637
Draft
jrobertboos wants to merge 1 commit into
Draft
Conversation
Contributor
|
Important Draft PR not reviewedDraft PRs are not automatically reviewed by default.
To automatically review draft PRs, update your CodeRabbit configuration: reviews:
auto_review:
drafts: trueThanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Adds user-facing documentation for the
granite_guardianshield type (IBM Granite Guardian moderation guardrail), which was previously only defined in the Pydantic config models (GraniteGuardianConfig,GraniteGuardianShieldConfiguration,RiskDefinition) without any corresponding docs.Changes:
docs/user_doc/shields_guide.md: Added agranite_guardiansection alongside the existingquestion_validityandredactionsections, following the sameConfig field | Required | Descriptiontable format. Includes a note that the runtime capability is not yet wired (config is validated at startup, but moderation is not yet invoked).docs/user_doc/config.md: Added schema tables forGraniteGuardianConfig,GraniteGuardianShieldConfiguration, andRiskDefinition, and updated the top-levelshieldsfield description to mention Granite Guardian.examples/lightspeed-stack-shields.yaml: Added aproduct-guardianshield example (provider_id: granite_guardian) with two sample risks (roleplay-jailbreakon input,harm-outputon output), demonstrating the required/optional config fields.docs/index.md: Added a "Safety shields" link to the docs landing page (was previously missing).This is a documentation-only change; no application code or config schema was modified — the
granite_guardianshield type already existed insrc/models/config.py.Type of change
Tools used to create PR
Related Tickets & Documents
Checklist before requesting a review
Testing
Manually reviewed the rendered Markdown (
shields_guide.md,config.md) and the example YAML for correctness, and checked that the newgranite_guardiansection/tables are consistent in structure and tone with the existingquestion_validityandredactionsections. No code paths changed, so no unit/integration tests were added or run.