Skip to content

docs: fix output rail doc #1159

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: develop
Choose a base branch
from

Conversation

andompesta
Copy link

@andompesta andompesta commented Apr 29, 2025

Description

Fix some issues on output streaming rails documentation.
Specifically the streaming.enabled field was missing

Related Issue(s)

I haven't opened a proper issue for that

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.

@andompesta andompesta changed the title Doc/fix output rail doc docs:fix output rail doc Apr 29, 2025
@andompesta andompesta changed the title docs:fix output rail doc docs: fix output rail doc Apr 29, 2025
Copy link
Member

@mikemckiernan mikemckiernan left a comment

Choose a reason for hiding this comment

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

Thanks very much for the contribution and corrections! If you don't have time for the requested changes, just let me know and I can add them to this PR and bring them in with your changes.

@mikemckiernan mikemckiernan added the documentation Improvements or additions to documentation label May 2, 2025
@mikemckiernan mikemckiernan requested a review from Pouyanpi May 2, 2025 18:04
@mikemckiernan mikemckiernan added this to the v0.14.0 milestone May 2, 2025
Copy link

github-actions bot commented May 2, 2025

Documentation preview

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

Signed-off-by: Mike McKiernan <[email protected]>
@codecov-commenter
Copy link

Codecov Report

All modified and coverable lines are covered by tests ✅

Please upload report for BASE (develop@46c02bd). Learn more about missing BASE report.

Additional details and impacted files
@@            Coverage Diff             @@
##             develop    #1159   +/-   ##
==========================================
  Coverage           ?   68.24%           
==========================================
  Files              ?      161           
  Lines              ?    15938           
  Branches           ?        0           
==========================================
  Hits               ?    10877           
  Misses             ?     5061           
  Partials           ?        0           
Flag Coverage Δ
python 68.24% <ø> (?)

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

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 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.

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