Skip to content
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

docs: output rails streaming #976

Merged

Conversation

mikemckiernan
Copy link
Member

@mikemckiernan mikemckiernan commented Feb 4, 2025

Description

Document the streaming output feature.

  • Update to Output Rails page because I think that's where readers will find the feature.
  • Update to Output Rails section, adding a "Streaming Output Configuration" heading that's reference for the fields (if you squint a little).

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.

Copy link

github-actions bot commented Feb 4, 2025

Documentation preview

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

@Pouyanpi Pouyanpi mentioned this pull request Feb 4, 2025
6 tasks
@mikemckiernan
Copy link
Member Author

mikemckiernan commented Feb 6, 2025

@Pouyanpi, if you can TAL, LMK if it's OK or I poisoned it:

  • On the likely-to-be-read output rails page, show a sample config with the revised field names and default values.
  • On the linked to, but otherwise impossible to find, configuration page:
    • state the reqs for enabling output streaming
    • provide reference info for the fields
    • (new) If a rail blocks a chunk of tokens, the toolkit returns JSON-looking str "{"event": "ABORT"..."
    • (new) table of sample # tokens, chunk size, context size, and # rails invocations. (This is useful info!)

@mikemckiernan mikemckiernan self-assigned this Feb 6, 2025
@mikemckiernan mikemckiernan added the documentation Improvements or additions to documentation label Feb 6, 2025
@Pouyanpi
Copy link
Collaborator

Pouyanpi commented Feb 6, 2025

Thank you @mikemckiernan , it looks great.

And I suppose the user already know how to activate it with chat-cli

https://nvidia.github.io/NeMo-Guardrails/review/pr-976/user-guides/advanced/streaming.html#chat-cli

Documents NVIDIA#966

Signed-off-by: Mike McKiernan <[email protected]>
@mikemckiernan mikemckiernan force-pushed the mmck-output-rails-streaming branch from 86f62fe to eeb801d Compare February 7, 2025 13:36
@mikemckiernan mikemckiernan merged commit 5ba7c57 into NVIDIA:develop Feb 7, 2025
2 checks passed
mikemckiernan added a commit to mikemckiernan/NeMo-Guardrails that referenced this pull request Feb 7, 2025
Documents NVIDIA#966

Signed-off-by: Mike McKiernan <[email protected]>
Pouyanpi pushed a commit that referenced this pull request Feb 7, 2025
Documents #966

Signed-off-by: Mike McKiernan <[email protected]>
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.

2 participants