You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/README.md
+13-2Lines changed: 13 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -5,8 +5,9 @@ The documentation is divided into the following sections:
5
5
1.[Getting Started](#getting-started)
6
6
2.[Examples](#examples)
7
7
3.[User Guide](#user-guide)
8
-
4.[Architecture Guide](#architecture-guide)
9
-
5.[Security Guidelines](./security/guidelines.md)
8
+
4.[Evaluation Tools](#evaluation-tools)
9
+
5.[Architecture Guide](#architecture-guide)
10
+
6.[Security Guidelines](./security/guidelines.md)
10
11
11
12
## Getting Started
12
13
@@ -43,6 +44,16 @@ The following guides explain in more details various specific topics:
43
44
44
45
*[Extract User Provided Values](./user_guide/advanced/extract-user-provided-values.md): Learn how to extract user-provided values like a name, a date or a query.
45
46
47
+
## Evaluation Tools
48
+
49
+
We provide a set of CLI evaluation tools and experimental results for topical and execution rails.
50
+
There are also detailed guides on how to reproduce results and create datasets for the evaluation of each type of rail.
51
+
52
+
*[Evaluation Tools and Results](./../nemoguardrails/eval/README.md): General explanation for the CLI evaluation tools and experimental results.
53
+
*[Topical Rail Evaluation - Dataset Tools](./../nemoguardrails/eval/data/topical/README.md): Dataset tools and details to run experiments for topical rails.
54
+
*[Fact-checking Rail Evaluation - Dataset Tools](./../nemoguardrails/eval/data/factchecking/README.md): Dataset tools and details to run experiments for fact-checking execution rail.
55
+
*[Moderation Rail Evaluation - Dataset Tools](./../nemoguardrails/eval/data/moderation/README.md): Dataset tools and details to run experiments for moderation execution rail.
56
+
46
57
## Architecture Guide
47
58
48
59
This guide sheds more light on the infrastructure details and the execution flow for a query when the runtime is used:
0 commit comments