Skip to content

contributing.md

Latest commit

 

History

History
229 lines (167 loc) · 10.5 KB

contributing.md

File metadata and controls

229 lines (167 loc) · 10.5 KB

Contributing to NVIDIA NeMo Agent toolkit

Contributions to NeMo Agent toolkit fall into the following three categories.

  • To report a bug, request a new feature, or report a problem with documentation, file a bug describing in detail the problem or new feature. The NeMo Agent toolkit team evaluates and triages bugs and schedules them for a release. If you believe the bug needs priority attention, comment on the bug to notify the team.
  • To propose and implement a new Feature, file a new feature request issue. Describe the intended feature and discuss the design and implementation with the team and community. Once the team agrees that the plan is good, go ahead and implement it, using the code contributions guide below.
  • To implement a feature or bug-fix for an existing outstanding issue, follow the code contributions guide below. If you need more context on a particular issue, ask in a comment.

As contributors and maintainers of NeMo Agent toolkit, you are expected to abide by the NeMo Agent toolkit code of conduct. More information can be found at: Contributor Code of Conduct.

Set Up Your Development Environment

Prerequisites

NeMo Agent toolkit is a Python library that doesn’t require a GPU to run the workflow by default. You can deploy the core workflows using one of the following:

  • Ubuntu or other Linux distributions, including WSL, in a Python virtual environment.

Creating the Environment

  1. Fork the NeMo Agent toolkit repository choosing Fork on the NeMo Agent toolkit repository page.

  2. Clone your personal fork of the NeMo Agent toolkit repository to your local machine.

    git clone <your fork url> aiqtoolkit
cd aiqtoolkit

    Then, set the upstream to the main repository and fetch the latest changes:

    git remote add upstream git@github.com:NVIDIA/NeMo-Agent-Toolkit.git
git fetch --all

  3. Initialize, fetch, and update submodules in the Git repository.

    git submodule update --init --recursive

  4. Fetch the data sets by downloading the LFS files.

    git lfs install
git lfs fetch
git lfs pull

  5. Create a Python environment.

    uv venv --seed .venv
source .venv/bin/activate
uv sync --all-groups --all-extras

  6. Install and configure pre-commit hooks.

    pre-commit install

    NOTE: Running pre-commit for the first time will take longer than normal.

  7. Open the NeMo Agent toolkit Workspace in Visual Studio Code.

    code ./aiq.code-workspace

Install the NeMo Agent toolkit Library

  1. Install the NeMo Agent toolkit Examples by doing the following.

    • Install NeMo Agent toolkit examples.

      uv sync --extra examples

    • Install a single example by running uv pip install -e ./examples/<example_name>. For example, install the Simple Calculator example with the following command.

      uv pip install -e ./examples/basic/functions/simple_calculator

  2. Verify that you've installed the NeMo Agent toolkit library.

    aiq --help
aiq --version

    If the installation succeeded, the aiq command will log the help message and its current version.

Code contributions

Your first issue

  1. Find an issue to work on. The best way is to search for issues with the good first issue label.
  2. Make sure that you can contribute your work to open source (no license and/or patent conflict is introduced by your code). You will need to sign your commit.
  3. Comment on the issue stating that you are going to work on it.
  4. Fork the NeMo Agent toolkit repository
  5. Code!
  6. Verify your changes by running CI locally with the ./ci/scripts/run_ci_local.sh all command.
  7. When done, create your pull request. Select develop as the Target branch of your pull request.
    • Ensure the body of the pull request references the issue you are working on in the form of Closes #<issue number>.
  8. Wait for other developers to review your code and update code as needed.
  9. Once reviewed and approved, an NeMo Agent toolkit developer will merge your pull request.

Remember, if you are unsure about anything, don't hesitate to comment on issues and ask for clarifications!

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 is available at Developer Certificate of Origin

    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.

Seasoned developers

Once you have gotten your feet wet and are more comfortable with the code, you can review the prioritized issues for our next release in our project boards.

Pro Tip: Always review the release board with the highest number for issues to work on. This is where NeMo Agent toolkit developers also focus their efforts.

Review the unassigned issues and choose an issue that you are comfortable contributing. Ensure you comment on the issue before you begin to inform others that you are working on it. If you have questions about implementing the issue, comment your questions in the issue instead of the PR.

Developing with NeMo Agent toolkit

Refer to the Get Started guide to quickly begin development.

Documentation

All NeMo Agent toolkit documentation should be written in Markdown format. The documentation located under the docs/source directory is included in the documentation builds, refer to docs/README.md for information on how to build the documentation. In addition to this, each example should contain a README.md file that describes the example.

Checks

All documentation is checked using Vale. In documentation the name of a command, variable, class, or function should be surrounded by backticks. For example referring aiq should always be surrounded by backticks. Vale will not perform a check against anything surrounded by backticks or by a code block.

The spelling of a project name should use the casing of the project, for example PyPI should always be spelled as PyPI and not pypi or PYPI. If needed new words can be added to the ci/vale/styles/config/vocabularies/aiq/accept.txt and ci/vale/styles/config/vocabularies/aiq/reject.txt files.

NVIDIA NeMo Agent toolkit Name Guidelines

  • Full Name: NVIDIA NeMo Agent toolkit - Use for document titles, webpage headers, any public descriptions

    • In situations where all words are capitalized (ex: document titles and headings), 'Toolkit' should be capitalized, in all other situations 'toolkit' should not be.

  • Short Name: NeMo Agent toolkit

    • Use after NVIDIA NeMo Agent toolkit has been referenced in blogs, documents, and other public locations
    • Note that the 't' is lowercase in toolkit unless used in a title or heading

  • Uppercase No Space: NeMo-Agent-Toolkit

    • Use for situations where capitalization will be preserved like the GitHub URL, directories, etc.
    • Do not use dashes or underscores
    • Note that the 't' is lowercase in toolkit unless used in a title or heading