Commit 7a11fb2
authored
docs: add deprecation policy to README (#1428)
### What does this PR do?
Type of change: documentation
Adds a **Deprecation Policy** section to `README.md`, modeled after
[TensorRT-LLM's
policy](https://github.com/NVIDIA/TensorRT-LLM#deprecation-policy).
Since Model Optimizer is still pre-1.0 (vs. TRT-LLM being past 1.0), the
migration period is shortened from 3 months to 1 release (~1 month), and
removals may land in minor version bumps while we remain in 0.x.
### Usage
N/A — documentation-only change.
### Testing
N/A — markdownlint passes via pre-commit.
### 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?: ✅
- 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
- Did you get Claude approval on this PR?: ❌
### Additional Information
Reference: https://github.com/NVIDIA/TensorRT-LLM#deprecation-policy
<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit
* **Documentation**
* Added a Deprecation Policy section to the README documenting how
deprecated features are communicated, the approximate 1-month migration
period, the scope of deprecations covered, and the timeline for feature
removal relative to semantic versioning.
[](https://app.coderabbit.ai/change-stack/NVIDIA/Model-Optimizer/pull/1428)
<!-- end of auto-generated comment: release notes by coderabbit.ai -->
Signed-off-by: Keval Morabia <28916987+kevalmorabia97@users.noreply.github.com>1 parent d30ebbd commit 7a11fb2
1 file changed
Lines changed: 9 additions & 0 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
137 | 137 | | |
138 | 138 | | |
139 | 139 | | |
| 140 | + | |
| 141 | + | |
| 142 | + | |
| 143 | + | |
| 144 | + | |
| 145 | + | |
| 146 | + | |
| 147 | + | |
| 148 | + | |
140 | 149 | | |
141 | 150 | | |
142 | 151 | | |
| |||
0 commit comments