Skip to content

docs: update installation pages with legal-approved license notices #1322

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.

Sign up for GitHub

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

Merged
kevalmorabia97 merged 2 commits into from
Apr 22, 2026
Merged

docs: update installation pages with legal-approved license notices #1322

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
176de97
docs: update installation pages with legal-approved license notices
kevalmorabia97 Apr 22, 2026
78b6fe2
Update License header copyright year
kevalmorabia97 Apr 22, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion LICENSE_HEADER
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
SPDX-FileCopyrightText: Copyright (c) 2024 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
SPDX-FileCopyrightText: Copyright (c) 2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.

@shengliangxu shengliangxu Apr 22, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

if we want to use the current year, there is a flag

--use-current-year

that may automate it.

@shengliangxu shengliangxu Apr 22, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

but not a big deal

SPDX-License-Identifier: Apache-2.0

Licensed under the Apache License, Version 2.0 (the "License");
Expand Down
12 changes: 10 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,8 @@ To install stable release packages for Model Optimizer with `pip` from [PyPI](ht
pip install -U nvidia-modelopt[all]
```

Model Optimizer will download and install additional third-party open source software projects. Review the license terms of these open source projects before use.

@coderabbitai coderabbitai Bot Apr 22, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

Hyphenate “open-source” in the legal notice.

Use “third-party open-source software projects” for correct compound-modifier style.

🧰 Tools
🪛 LanguageTool

[grammar] ~72-~72: Use a hyphen to join words.
Context: ... and install additional third-party open source software projects. Review the lic...

(QB_NEW_EN_HYPHEN)

[grammar] ~72-~72: Use a hyphen to join words.
Context: .... Review the license terms of these open source projects before use. To install ...

(QB_NEW_EN_HYPHEN)

🤖 Prompt for AI Agents 
Verify each finding against the current code and only fix it if needed.

In `@README.md` at line 72, Update the legal notice sentence in README.md by
hyphenating "open-source": change the phrase "third-party open source software
projects" to "third-party open-source software projects" so the compound
modifier is correct; locate the sentence "Model Optimizer will download and
install additional third-party open source software projects. Review the license
terms of these open source projects before use." and apply the hyphen
consistently in both occurrences.


To install from source in editable mode with all development dependencies or to use the latest features, run:

```bash
Expand All @@ -79,8 +81,14 @@ cd Model-Optimizer
pip install -e .[dev]
```

You can also directly use the [TensorRT-LLM docker images](https://catalog.ngc.nvidia.com/orgs/nvidia/teams/tensorrt-llm/containers/release/tags)
(e.g., `nvcr.io/nvidia/tensorrt-llm/release:<version>`), which have Model Optimizer pre-installed.
You can also directly use NVIDIA container images, which have Model Optimizer pre-installed:

- `nvcr.io/nvidia/pytorch:<version>-py3`
- `nvcr.io/nvidia/nemo:<version>`
- `nvcr.io/nvidia/tensorrt-llm/release:<version>`
- `nvcr.io/nvidia/tensorrt:<version>-py3`

Before pulling and using the container images, please review their respective license terms.
Make sure to upgrade Model Optimizer to the latest version as described above.
Visit our [installation guide](https://nvidia.github.io/Model-Optimizer/getting_started/2_installation.html) for
more fine-grained control on installed dependencies or for alternative docker images and environment variables to setup.
Expand Down
19 changes: 12 additions & 7 deletions docs/source/getting_started/_installation_for_Linux.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,11 +32,11 @@ Environment setup

To use Model Optimizer with full dependencies (e.g. TensorRT/TensorRT-LLM deployment), we recommend using the
`TensorRT-LLM docker image <https://catalog.ngc.nvidia.com/orgs/nvidia/teams/tensorrt-llm/containers/release/tags>`_,
e.g., ``nvcr.io/nvidia/tensorrt-llm/release:<version>``.
e.g., ``nvcr.io/nvidia/tensorrt-llm/release:<version>`` (Model Optimizer pre-installed).

Make sure to upgrade Model Optimizer to the latest version using ``pip`` as described in the next section.

You would also need to setup appropriate environment variables for the TensorRT binaries as follows:
If relevant, you would also need to setup appropriate environment variables for the TensorRT binaries as follows:

@coderabbitai coderabbitai Bot Apr 22, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

Use “set up” (verb) instead of “setup”.

Wording nit: “need to setup” should be “need to set up” for grammatical correctness.

🤖 Prompt for AI Agents 
Verify each finding against the current code and only fix it if needed.

In `@docs/source/getting_started/_installation_for_Linux.rst` at line 39, Change
the phrasing "need to setup" to the correct verb form "need to set up" in the
sentence that reads "If relevant, you would also need to setup appropriate
environment variables for the TensorRT binaries as follows:" so it becomes "If
relevant, you would also need to set up appropriate environment variables for
the TensorRT binaries as follows:"; update that exact sentence in
docs/source/getting_started/_installation_for_Linux.rst.


.. code-block:: shell

Expand All @@ -48,11 +48,16 @@ Environment setup
**Alternative NVIDIA docker images**

For PyTorch, you can also use `NVIDIA NGC PyTorch container <https://catalog.ngc.nvidia.com/orgs/nvidia/containers/pytorch/tags>`_
and for NVIDIA Megatron-Bridge or Megatron-LM framework, you can use the `NeMo container <https://catalog.ngc.nvidia.com/orgs/nvidia/containers/nemo/tags>`_.
Both of these containers come with Model Optimizer pre-installed. Make sure to update the Model Optimizer to the latest version if not already.
(``nvcr.io/nvidia/pytorch:<version>-py3``, Model Optimizer pre-installed)
and for NVIDIA Megatron-Bridge or Megatron-LM framework, you can use the `NeMo container <https://catalog.ngc.nvidia.com/orgs/nvidia/containers/nemo/tags>`_
(``nvcr.io/nvidia/nemo:<version>``, Model Optimizer pre-installed).
Make sure to update the Model Optimizer to the latest version if not already.

For ONNX / TensorRT use cases, you can also use the `TensorRT container <https://catalog.ngc.nvidia.com/orgs/nvidia/containers/tensorrt/tags>`_
which provides superior performance to the PyTorch container.
(``nvcr.io/nvidia/tensorrt:<version>-py3``), which provides superior performance to the PyTorch container.

.. note::
Before pulling and using the container images, please review their respective license terms.

.. tab:: Local environment (PIP / Conda)

Expand Down Expand Up @@ -82,8 +87,8 @@ Environment setup
Install Model Optimizer
=======================

ModelOpt including its dependencies can be installed via ``pip``. Please review the license terms of ModelOpt and any
dependencies before use.
Model Optimizer will download and install additional third-party open source software projects. Review the license
terms of these open source projects before use.

If you build and use ModelOpt's docker image, you can skip this step as the image already contains ModelOpt and all
optional dependencies pre-installed.
Expand Down
4 changes: 4 additions & 0 deletions docs/source/getting_started/windows/_installation_for_Windows.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,10 @@ The following system requirements are necessary to install and use Model Optimiz

The Model Optimizer - Windows can be used in following ways:

.. note::
Model Optimizer will download and install additional third-party open source software projects.
Review the license terms of these open source projects before use.

.. toctree::
:glob:
:maxdepth: 1
Expand Down
Loading