Skip to content

Commit 24f948d

Browse files
Informational ATIF mapping docs and sample output colocation (no functional changes) (#1844)
This PR consolidates ATIF/IntermediateStep documentation and sample artifacts to make trajectory analysis easier to understand and reproduce. It is educational/documentation-focused and introduces no functional/runtime behavior changes. **What this PR includes** - Moves and clarifies ATIF contract guidance: - Relocates/maintains the Step.extra contract guide under ATIF ownership (nvidia_nat_atif) and updates related references. - Adds generic mapping documentation: - Introduces a generic IntermediateStep -> ATIF mapping guide under nvidia_nat_eval, including ID/name/timing mapping semantics. - Adds per-sample comparison docs with concrete IDs: - Creates concise intermediate_step-vs-atif.md files in sample output folders (nested, branching, trajectory) with concrete mapping checks and flagged oddities. - Adds ATA sample outputs and related informational markdowns: - Captures and documents ATA output samples for side-by-side comparison. - Co-locates observability assets with outputs: - Copies Phoenix trace screenshots into corresponding output_samples/* directories and updates path references for easier joint inspection with workflow outputs. - Adds an ATIF-oriented ATA eval config ## By Submitting this PR I confirm: - I am familiar with the [Contributing Guidelines](https://github.com/NVIDIA/NeMo-Agent-Toolkit/blob/develop/docs/source/resources/contributing/index.md). - We require that all contributors "sign-off" on their commits. This certifies that the contribution is your original work, or you have rights to submit it under the same license, or a compatible license. - Any contribution which contains commits that are not Signed-Off will not be accepted. - When the PR is ready for review, new or existing tests cover these changes. - When the PR is ready for review, the documentation is up to date with these changes. ## Summary by CodeRabbit * **Documentation** * Enhanced ATIF step guidance with publisher ID requirements and alignment specifications. * Added comprehensive mapping documentation for converting intermediate steps to ATIF trajectories. * Updated asset paths and references in evaluation guides. * **New Features** * Added offline ATIF evaluation configuration for alert triage workflows. * **Chores** * Updated evaluation and profiling example output samples with new data artifacts. Authors: - Anuradha Karuppiah (https://github.com/AnuradhaKaruppiah) Approvers: - Yuchen Zhang (https://github.com/yczhang-nv) - https://github.com/Salonijain27 URL: #1844
1 parent 5816918 commit 24f948d

21 files changed

Lines changed: 324 additions & 12 deletions
Lines changed: 146 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,146 @@
1+
# SPDX-FileCopyrightText: Copyright (c) 2025-2026, NVIDIA CORPORATION & AFFILIATES. All rights reserved.
2+
# SPDX-License-Identifier: Apache-2.0
3+
#
4+
# Licensed under the Apache License, Version 2.0 (the "License");
5+
# you may not use this file except in compliance with the License.
6+
# You may obtain a copy of the License at
7+
#
8+
# http://www.apache.org/licenses/LICENSE-2.0
9+
#
10+
# Unless required by applicable law or agreed to in writing, software
11+
# distributed under the License is distributed on an "AS IS" BASIS,
12+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
# See the License for the specific language governing permissions and
14+
# limitations under the License.
15+
16+
17+
general:
18+
telemetry:
19+
tracing:
20+
phoenix:
21+
_type: phoenix
22+
endpoint: http://localhost:6006/v1/traces
23+
project: alert_triage_agent_offline_atif
24+
25+
functions:
26+
hardware_check:
27+
_type: hardware_check
28+
llm_name: tool_reasoning_llm
29+
offline_mode: true
30+
host_performance_check:
31+
_type: host_performance_check
32+
llm_name: tool_reasoning_llm
33+
offline_mode: true
34+
monitoring_process_check:
35+
_type: monitoring_process_check
36+
llm_name: tool_reasoning_llm
37+
offline_mode: true
38+
network_connectivity_check:
39+
_type: network_connectivity_check
40+
llm_name: tool_reasoning_llm
41+
offline_mode: true
42+
telemetry_metrics_host_heartbeat_check:
43+
_type: telemetry_metrics_host_heartbeat_check
44+
llm_name: tool_reasoning_llm
45+
offline_mode: true
46+
metrics_url: http://your-monitoring-server:9090 # Replace with your monitoring system URL if running in live mode
47+
telemetry_metrics_host_performance_check:
48+
_type: telemetry_metrics_host_performance_check
49+
llm_name: tool_reasoning_llm
50+
offline_mode: true
51+
metrics_url: http://your-monitoring-server:9090 # Replace with your monitoring system URL if running in live mode
52+
telemetry_metrics_analysis_agent:
53+
_type: telemetry_metrics_analysis_agent
54+
tool_names:
55+
- telemetry_metrics_host_heartbeat_check
56+
- telemetry_metrics_host_performance_check
57+
llm_name: telemetry_metrics_analysis_agent_llm
58+
maintenance_check:
59+
_type: maintenance_check
60+
llm_name: maintenance_check_llm
61+
static_data_path: examples/advanced_agents/alert_triage_agent/data/maintenance_static_dataset.csv
62+
categorizer:
63+
_type: categorizer
64+
llm_name: categorizer_llm
65+
66+
workflow:
67+
_type: alert_triage_agent
68+
tool_names:
69+
- hardware_check
70+
- host_performance_check
71+
- monitoring_process_check
72+
- network_connectivity_check
73+
- telemetry_metrics_analysis_agent
74+
llm_name: ata_agent_llm
75+
offline_mode: true
76+
# The below paths are only used if offline_mode is true
77+
offline_data_path: examples/advanced_agents/alert_triage_agent/data/offline_data.csv
78+
benign_fallback_data_path: examples/advanced_agents/alert_triage_agent/data/benign_fallback_offline_data.json
79+
80+
llms:
81+
ata_agent_llm:
82+
_type: nim
83+
model_name: nvidia/nemotron-3-nano-30b-a3b
84+
temperature: 0
85+
max_tokens: 16384
86+
87+
tool_reasoning_llm:
88+
_type: nim
89+
model_name: nvidia/nemotron-3-nano-30b-a3b
90+
temperature: 0
91+
max_tokens: 16384
92+
93+
telemetry_metrics_analysis_agent_llm:
94+
_type: nim
95+
model_name: nvidia/nemotron-3-nano-30b-a3b
96+
temperature: 0
97+
max_tokens: 16384
98+
99+
maintenance_check_llm:
100+
_type: nim
101+
model_name: nvidia/nemotron-3-nano-30b-a3b
102+
temperature: 0
103+
max_tokens: 16384
104+
105+
categorizer_llm:
106+
_type: nim
107+
model_name: nvidia/nemotron-3-nano-30b-a3b
108+
temperature: 0
109+
max_tokens: 16384
110+
111+
nim_rag_eval_llm:
112+
_type: nim
113+
model_name: nvidia/nemotron-3-nano-30b-a3b
114+
max_tokens: 8
115+
116+
nim_trajectory_eval_llm:
117+
_type: nim
118+
model_name: nvidia/nemotron-3-nano-30b-a3b
119+
max_tokens: 1024
120+
121+
eval:
122+
general:
123+
output:
124+
dir: .tmp/nat/examples/advanced_agents/alert_triage_agent/output/offline_atif/
125+
write_atif_workflow_output: true
126+
workflow_output_step_filter: []
127+
workflow_alias: alert_triage_agent_offline_atif
128+
dataset:
129+
_type: json
130+
# JSON representation of the offline CSV data (including just the alerts, the expected output, and the label)
131+
file_path: examples/advanced_agents/alert_triage_agent/data/offline_data.json
132+
filter:
133+
allowlist:
134+
field:
135+
id: ["0"]
136+
profiler:
137+
base_metrics: true
138+
139+
evaluators:
140+
accuracy:
141+
_type: ragas
142+
enable_atif_evaluator: true
143+
metric: AnswerAccuracy
144+
llm_name: nim_rag_eval_llm
145+
classification_accuracy:
146+
_type: classification_accuracy
Lines changed: 3 additions & 0 deletions
Loading
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
version https://git-lfs.github.com/spec/v1
2+
oid sha256:832a5311fb051c545b3b0d3862bf432ef6345f93a6c030250f9b98436cc33145
3+
size 993205
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
version https://git-lfs.github.com/spec/v1
2+
oid sha256:7c615d3d082705efd85e01e1a89e9294cb98b1723dfba658faaeb8f9ae2588fe
3+
size 104469

examples/evaluation_and_profiling/simple_calculator_eval/src/nat_simple_calculator_eval/configs/config-branching-nested-trajectory-eval.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,7 @@ eval:
6666
general:
6767
max_concurrency: 1
6868
output:
69+
workflow_output_step_filter: []
6970
dir: .tmp/nat/examples/simple_calculator/branching-nested-eval
7071
write_atif_workflow_output: true
7172
cleanup: true

examples/evaluation_and_profiling/simple_calculator_eval/src/nat_simple_calculator_eval/configs/config-nested-trajectory-eval.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -61,9 +61,11 @@ eval:
6161
general:
6262
max_concurrency: 1
6363
output:
64+
workflow_output_step_filter: []
6465
dir: .tmp/nat/examples/simple_calculator/nested-eval
6566
write_atif_workflow_output: true
6667
cleanup: true
68+
6769
dataset:
6870
_type: json
6971
file_path: examples/evaluation_and_profiling/simple_calculator_eval/data/simple_calculator_power_of_two.json

examples/evaluation_and_profiling/simple_calculator_eval/src/nat_simple_calculator_eval/configs/config-trajectory-eval.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,7 @@ eval:
6060
general:
6161
max_concurrency: 1
6262
output:
63+
workflow_output_step_filter: []
6364
dir: .tmp/nat/examples/simple_calculator/trajectory-eval
6465
write_atif_workflow_output: true
6566
cleanup: true
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
version https://git-lfs.github.com/spec/v1
2+
oid sha256:cd88c9facac84eb2ac78f6285591f5219cfda8dada95d1ce694da559cdca26d3
3+
size 3807

docs/source/_static/simple_calculator_branching_phoenix_trace.png renamed to examples/evaluation_and_profiling/simple_calculator_eval/src/nat_simple_calculator_eval/data/output_samples/branching_nested_trajectory_eval/simple_calculator_branching_phoenix_trace.png

File renamed without changes.
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
version https://git-lfs.github.com/spec/v1
2+
oid sha256:59aecb3bf7bdb0f0d82e76d49b20ce22f820335a659c578f99388f7ec97262f4
3+
size 121904

0 commit comments

Comments
 (0)