mirror of
https://github.com/NVIDIA/Model-Optimizer.git
synced 2026-10-02 03:14:52 +08:00
Keval MorabiaandClaude Opus 5
96b4aac90a
### What does this PR do? Type of change: documentation Trims the 0.46 and 0.47 changelog entries and adds the guidelines that keep future entries (and comments, docstrings, tests) from growing the same way. **`CHANGELOG.rst`** - 0.47: `**New Features**` split into `*Quantization*` / `*Megatron Framework (M-LM / M-Bridge)*` / `*Misc*`, matching 0.46's organization. - 0.46 bug fixes: all 14 entries condensed to symptom → cause → fix. - Removed internal `NVBug` IDs (0.45, 0.46) and root-cause forensics that only matter to maintainers — exact tensor shapes, upstream-bug analysis, internal helper names. - Trimmed the most verbose feature entries (dLLM, Torch-TensorRT ViT, `local_hessian` Triton, `module_search_spaces`, `constant_amax`, CP/DP, `day0-release`) and the Phi-4-multimodal breaking-change note. **`AGENTS.md`** - What earns a changelog entry, and that entries are one or two sentences written for external users, with features filed under the right `**New Features**` sub-section. - What belongs in a PR description, so detail redirected out of the changelog and docstrings has a defined home. **`CONTRIBUTING.md`** - *Comment cautiously*: comments and docstrings capped at one or two lines; rationale, benchmarks, and root cause go in the PR description. - *Test design principles*: new lead bullet preferring the highest-level test that runs the real code path, with GPU/framework behavior going to `tests/gpu*` instead of monkeypatched CPU approximations in `tests/unit`; one test per behavior, `@pytest.mark.parametrize` over near-duplicate test functions. **`.github/PULL_REQUEST_TEMPLATE.md`** - Changelog checklist item now asks for a very short summary. ### Usage N/A — documentation only. ### Testing `pre-commit run --files CHANGELOG.rst AGENTS.md CONTRIBUTING.md .github/PULL_REQUEST_TEMPLATE.md` passes, including the RST and markdownlint hooks. No code changes, so no test suite applies. ### Before your PR is "*Ready for review*" - Is this change backward compatible?: N/A - If you copied code from any other sources or added a new PIP dependency, did you follow guidance in `CONTRIBUTING.md`: N/A - Did you write any new necessary tests?: N/A - Did you update [Changelog](https://github.com/NVIDIA/Model-Optimizer/blob/main/CHANGELOG.rst)?: N/A <!-- this PR only edits existing entries --> - Did you get Claude approval on this PR?: ❌ ### Additional Information Only the wording of released 0.45/0.46 entries changed; no entry was added or removed. 🤖 Generated with [Claude Code](https://claude.com/claude-code) --------- Signed-off-by: Keval Morabia <28916987+kevalmorabia97@users.noreply.github.com> Co-authored-by: Claude Opus 5 (1M context) <noreply@anthropic.com>
30 lines
1.6 KiB
Markdown
30 lines
1.6 KiB
Markdown
### What does this PR do?
|
|
|
|
Type of change: ? <!-- Use one of the following: Bug fix, new feature, new example, new tests, documentation. -->
|
|
|
|
<!-- Details about the change. -->
|
|
|
|
### Usage
|
|
|
|
```python
|
|
# Add a code snippet demonstrating how to use this
|
|
```
|
|
|
|
### Testing
|
|
<!-- Mention how have you tested your change if applicable. -->
|
|
|
|
### Before your PR is "*Ready for review*"
|
|
|
|
Make sure you read and follow [Contributor guidelines](https://github.com/NVIDIA/Model-Optimizer/blob/main/CONTRIBUTING.md) and your commits are signed (`git commit -s -S`).
|
|
|
|
Make sure you read and follow the [Security Best Practices](https://github.com/NVIDIA/Model-Optimizer/blob/main/SECURITY.md#security-coding-practices-for-contributors) (e.g. avoiding hardcoded `trust_remote_code=True`, `torch.load(..., weights_only=False)`, `pickle`, etc.).
|
|
|
|
- Is this change backward compatible?: ✅ / ❌ / N/A <!--- If ❌, explain why. -->
|
|
- If you copied code from any other sources or added a new PIP dependency, did you follow guidance in `CONTRIBUTING.md`: ✅ / ❌ / N/A <!--- Mandatory -->
|
|
- Did you write any new necessary tests?: ✅ / ❌ / N/A <!--- Mandatory for new features or examples. -->
|
|
- Did you update [Changelog](https://github.com/NVIDIA/Model-Optimizer/blob/main/CHANGELOG.rst)?: ✅ / ❌ / N/A <!--- Very short summary of changes only for new features, backward breaking changes, deprecations, or fixes for critical bugs present in previous releases. -->
|
|
- Did you get Claude approval on this PR?: ✅ / ❌ / N/A <!--- Run `/claude review`. NVIDIA org members can self-trigger for complex changes; orthogonal to CodeRabbit. -->
|
|
|
|
### Additional Information
|
|
<!-- E.g. related issue. -->
|