Skip to content

Conversation

@mikemckiernan
Copy link
Collaborator

@mikemckiernan mikemckiernan commented May 16, 2025

Description

Update the reasoning traces section of the docs to add Nemotron models.

The model seems to just work, so I'm unsure if we need to say more.

Review HTML: https://nvidia.github.io/NeMo-Guardrails/review/pr-1200/user-guides/configuration-guide.html#using-llms-with-reasoning-traces

Related Issue(s)

Checklist

  • I've read the CONTRIBUTING guidelines.
  • I've updated the documentation if applicable.
  • I've added tests if applicable.
  • @mentions of the person or team responsible for reviewing proposed changes.

@mikemckiernan mikemckiernan self-assigned this May 16, 2025
@mikemckiernan mikemckiernan added the documentation Improvements or additions to documentation label May 16, 2025
@mikemckiernan mikemckiernan added this to the v0.14.0 milestone May 16, 2025
@github-actions
Copy link
Contributor

Documentation preview

https://nvidia.github.io/NeMo-Guardrails/review/pr-1200

@codecov-commenter
Copy link

codecov-commenter commented May 16, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 68.65%. Comparing base (07422c1) to head (a11c51c).

Additional details and impacted files
@@           Coverage Diff            @@
##           develop    #1200   +/-   ##
========================================
  Coverage    68.65%   68.65%           
========================================
  Files          161      161           
  Lines        15978    15978           
========================================
  Hits         10969    10969           
  Misses        5009     5009           
Flag Coverage Δ
python 68.65% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@Pouyanpi
Copy link
Collaborator

Pouyanpi commented May 16, 2025

@mikemckiernan

related PRs:

#1145
#1176

What is important?

  • apply_to_reasoning_traces defines wether we want to apply output rails on reasoning traces too or not
  • we always return reasoning traces to the user (even when remove_reasoning_traces is True
  • remove_reasoning_traces removes the traces from internal tasks
  • remove_thinking_traces is deprecated and we should use remove_reasoning_traces (backward compatible, users can still use remove_thinking_traces)

A key change is that reasoning traces are always returned to the use

        rails:
          output:
            apply_to_reasoning_traces: True

Signed-off-by: Mike McKiernan <mmckiernan@nvidia.com>
Signed-off-by: Mike McKiernan <mmckiernan@nvidia.com>
Signed-off-by: Mike McKiernan <mmckiernan@nvidia.com>
Signed-off-by: Mike McKiernan <mmckiernan@nvidia.com>
Copy link
Member

@trebedea trebedea left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, I only have the question about why we have an example with curl on the chat endpoint.

Signed-off-by: Mike McKiernan <mmckiernan@nvidia.com>
Signed-off-by: Mike McKiernan <mmckiernan@nvidia.com>
@Pouyanpi Pouyanpi merged commit 6e8a5d7 into NVIDIA-NeMo:develop May 28, 2025
9 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants