Skip to content

Conversation

@mikemckiernan
Copy link
Collaborator

Description

Clarify the purpose of the models.model.parameters field.

Related Issue(s)

Fixes #1124

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.

Fixes NVIDIA-NeMo#1124

Signed-off-by: Mike McKiernan <mmckiernan@nvidia.com>
@mikemckiernan mikemckiernan requested review from Pouyanpi and trebedea May 8, 2025 15:39
@mikemckiernan mikemckiernan self-assigned this May 8, 2025
@mikemckiernan mikemckiernan added the documentation Improvements or additions to documentation label May 8, 2025
@mikemckiernan mikemckiernan added this to the v0.14.0 milestone May 8, 2025
@github-actions
Copy link
Contributor

github-actions bot commented May 8, 2025

Documentation preview

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

@codecov-commenter
Copy link

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 68.24%. Comparing base (b65cf0e) to head (a5c42fc).

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

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.

Copy link
Collaborator

@Pouyanpi Pouyanpi left a comment

Choose a reason for hiding this comment

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

Thank you Mike for adding this! Looks good 👍🏻

@Pouyanpi Pouyanpi changed the title docs: Clarify purpose of model parameters docs: clarify purpose of model parameters field in configuration guide May 9, 2025
@Pouyanpi Pouyanpi merged commit d1e5558 into NVIDIA-NeMo:develop May 9, 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.

doc: explain expected values of the parameters field in ModelConfig

4 participants