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

Add docs on env vars #11991

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

Add docs on env vars #11991

wants to merge 3 commits into from

Conversation

erhoo82
Copy link
Collaborator

@erhoo82 erhoo82 commented Jan 29, 2025

What does this PR do ?

Add doc strings to env vars
Remove deprecated env var

Changelog

  • Add the description of the env vars on NVLS, NVVL buffer, and others
  • Remove amax reduction-related env vars

Usage

n/a

GitHub Actions CI

The Jenkins CI system has been replaced by GitHub Actions self-hosted runners.

The GitHub Actions CI will run automatically when the "Run CICD" label is added to the PR.
To re-run CI remove and add the label again.
To run CI on an untrusted fork, a NeMo user with write access must first click "Approve and run".

Before your PR is "Ready for review"

Pre checks:

  • Make sure you read and followed Contributor guidelines
  • Did you write any new necessary tests?
  • Did you add or update any necessary documentation?
  • Does the PR affect components that are optional to install? (Ex: Numba, Pynini, Apex etc)
    • Reviewer: Does the PR have correct import guards for all optional libraries?

PR Type:

  • New Feature
  • Bugfix
  • Documentation

If you haven't finished some of the above items you can still open "Draft" PR.

Who can review?

Anyone in the community is free to review the PR once the checks have passed.
Contributor guidelines contains specific people who can review PRs to various areas.

Additional Information

  • Related to # (issue)

Signed-off-by: Sangkug Lym <[email protected]>
ericharper
ericharper previously approved these changes Jan 29, 2025
Copy link
Collaborator

@ericharper ericharper left a comment

Choose a reason for hiding this comment

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

LGTM. Thanks!

@akoumpa
Copy link
Member

akoumpa commented Feb 5, 2025

@pablo-garay @ko3n1g can we force-merge? This is a docs change and force-merge would it get it off the CI queue.

@ko3n1g
Copy link
Collaborator

ko3n1g commented Feb 5, 2025

@pablo-garay @ko3n1g can we force-merge? This is a docs change and force-merge would it get it off the CI queue.

It also changes Python code by removing env vars

@codecov-commenter
Copy link

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 30.42%. Comparing base (09186c3) to head (46dd5bf).
Report is 16 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main   #11991      +/-   ##
==========================================
+ Coverage   30.30%   30.42%   +0.12%     
==========================================
  Files        1387     1395       +8     
  Lines      176283   177027     +744     
  Branches    27091    27142      +51     
==========================================
+ Hits        53423    53866     +443     
- Misses     118776   119072     +296     
- Partials     4084     4089       +5     

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

Comment on lines -27 to -28
"NVTE_DP_AMAX_REDUCE_INTERVAL": "0",
"NVTE_ASYNC_AMAX_REDUCTION": "1",
Copy link
Collaborator

Choose a reason for hiding this comment

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

n00b question: why can we drop setting these now?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants