Add flow documentation generation scripts#40
Conversation
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
| except Exception: | ||
| # Skip files that can't be parsed (yaml errors, etc) |
| except Exception: | ||
| continue |
|
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## develop #40 +/- ##
==========================================
Coverage ? 76.88%
==========================================
Files ? 200
Lines ? 20412
Branches ? 0
==========================================
Hits ? 15693
Misses ? 4719
Partials ? 0
Flags with carried forward coverage won't be shown. Click here to find out more. 🚀 New features to boost your workflow:
|
| if any(action_name.lower().startswith(ba) for ba in builtin_actions): | ||
| return True, False | ||
| # Unknown action - assume external to be safe | ||
| return True, False |
There was a problem hiding this comment.
# Unknown action - assume external to be safe
return True, False
should that say False, False based on the comment?
| # Patterns indicating network calls (compiled for efficiency) | ||
| NETWORK_CALL_PATTERNS = [ | ||
| re.compile(r"\.post\s*\("), | ||
| re.compile(r"\.get\s*\("), |
There was a problem hiding this comment.
NETWORK_CALL_PATTERNS = [
re.compile(r"\.post\s*\("),
re.compile(r"\.get\s*\("),
could the .get() lead to false positives?
There was a problem hiding this comment.
looking at the generated docs/reference/library-flows.adoc, it might be prudent to update closed source guardrail list as there have been some new guardrail additions since the last time this list was manually updated
Signed-off-by: Rob Geada <rob@geada.net>
RobGeada
force-pushed
the
FlowDocumentation
branch
from
a253c37 to
0a3dfd1
Compare
RobGeada
merged commit 6a3cfd1
into
trustyai-explainability:develop
4 participants
Description
Adds
scripts/document_flows.pywhich generates documentation on the available flows within the NeMo Guardrails server, including:Related Issue(s)
Checklist