Contributing To NeMo-Automodel

Building a NeMo-Automodel container

Run the following command to build your container:

# Set build arguments
export AUTOMODEL_INSTALL=dev #[all, dev, deepep, fa, moe, vlm]
export BASE_IMAGE=cuda #[cuda, pytorch]
export INSTALL_DEEPEP=False #[True, False]

docker build -f docker/Dockerfile \
--build-arg AUTOMODEL_INSTALL=$AUTOMODEL_INSTALL \
--build-arg BASE_IMAGE=$BASE_IMAGE \
--build-arg INSTALL_DEEPEP=$INSTALL_DEEPEP \
-t automodel --target=automodel_final .

Run the following command to start your container:

docker run --rm -it --entrypoint bash --runtime nvidia --gpus all automodel

Development Dependencies

We use uv for managing dependencies.

New required dependencies can be added by uv add $DEPENDENCY.

Adding a new dependency will update UV's lock-file. Please check this into your branch:

git add uv.lock pyproject.toml
git commit -s -m "build: Adding dependencies"
git push

Linting and Formatting

We use ruff for linting and formatting.

Installation:

pip install ruff

Format:

ruff check --fix .
ruff format .

Adding Documentation

If your contribution involves documentation changes, please refer to the Documentation Development guide for detailed instructions on building and serving the documentation.

Signing Your Work

We require that all contributors "sign-off" on their commits. This certifies that the contribution is your original work, or you have rights to submit it under the same license, or a compatible license.
- Any contribution which contains commits that are not Signed-Off will not be accepted.
To sign off on a commit you simply use the --signoff (or -s) option when committing your changes:
```
git commit -s -m "Add cool feature."
```
This will append the following to your commit message:
```
Signed-off-by: Your Name <your@email.com>
```

Full text of the DCO:

Developer Certificate of Origin
Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.

Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.


Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
    have the right to submit it under the open source license
    indicated in the file; or

(b) The contribution is based upon previous work that, to the best
    of my knowledge, is covered under an appropriate open source
    license and I have the right under that license to submit that
    work with modifications, whether created in whole or in part
    by me, under the same open source license (unless I am
    permitted to submit under a different license), as indicated
    in the file; or

(c) The contribution was provided directly to me by some other
    person who certified (a), (b) or (c) and I have not modified
    it.

(d) I understand and agree that this project and the contribution
    are public and that a record of the contribution (including all
    personal information I submit with it, including my sign-off) is
    maintained indefinitely and may be redistributed consistent with
    this project or the open source license(s) involved.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!