Enhance README with badges, installation, instructions, and a roadmap #654
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
mdemoret-nv
added
doc
willkill07
force-pushed
the
mdd_update-readme
branch
from
e48d5d5 to
6bc33fb
Compare
- Added various badges for license, version, issues, pull requests, GitHub stars, forks, and PyPI downloads to improve visibility and engagement. - Updated the installation section to include specific instructions for installing NeMo Agent Toolkit from PyPI, including optional dependencies. - Reintroduced the Component Overview section with a diagram to provide a high-level view of the toolkit's architecture. Signed-off-by: Michael Demoret <[email protected]>
…content restructuring - Added a GitHub release badge for better visibility of the latest version. - Streamlined the installation section with clearer instructions for installing optional dependencies. - Enhanced the content structure by consolidating sections and adding a roadmap. - Updated the compatibility note to include a placeholder for a link to the compatibility guide. Also, disabled the branch checker in the ops-bot configuration for improved workflow management. Signed-off-by: Michael Demoret <[email protected]>
willkill07
force-pushed
the
mdd_update-readme
branch
from
6bc33fb to
caecbfe
Compare
Signed-off-by: Will Killian <[email protected]>
willkill07
force-pushed
the
mdd_update-readme
branch
from
caecbfe to
5398f92
Compare
Signed-off-by: Will Killian <[email protected]>
willkill07
force-pushed
the
mdd_update-readme
branch
from
5398f92 to
8abf677
Compare
mdemoret-nv
commented
Aug 15, 2025
Collaborator
Author
mdemoret-nv
left a comment
mdemoret-nv
left a comment
There was a problem hiding this comment.
Lets not create extra packages unless they have source files.
dagardner-nv
approved these changes
Aug 15, 2025
Signed-off-by: Will Killian <[email protected]>
willkill07
force-pushed
the
mdd_update-readme
branch
from
d3e4b6f to
c446b59
Compare
willkill07
approved these changes
Aug 15, 2025
Signed-off-by: Will Killian <[email protected]>
Signed-off-by: Will Killian <[email protected]>
dagardner-nv
approved these changes
Aug 18, 2025
Signed-off-by: Will Killian <[email protected]>
Member
|
/merge |
AnuradhaKaruppiah
pushed a commit
to AnuradhaKaruppiah/oss-agentiq
that referenced
this pull request
Aug 19, 2025
…NVIDIA#654) - Added various badges for license, version, issues, pull requests, GitHub stars, forks, and PyPI downloads to improve visibility and engagement. - Updated the installation section to include specific instructions for installing NeMo Agent Toolkit from PyPI, including optional dependencies. - Reintroduced the Component Overview section with a diagram to provide a high-level view of the toolkit's architecture. - Added a roadmap Closes NVIDIA#624 Remaining Items: - [x] Add link to compatibility document after NVIDIA#653 is merged - [x] Complete the roadmap items - [x] Add an `all` package to `pyproject.toml` - This was accomplished through the creation of three metapackages: `ingestion`, `profiling`, and `all`. This resulted in the fewest duplications of dependencies while adding minimal overhead. ## By Submitting this PR I confirm: - I am familiar with the [Contributing Guidelines](https://github.com/NVIDIA/NeMo-Agent-Toolkit/blob/develop/docs/source/resources/contributing.md). - 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. - When the PR is ready for review, new or existing tests cover these changes. - When the PR is ready for review, the documentation is up to date with these changes. Authors: - Michael Demoret (https://github.com/mdemoret-nv) - Will Killian (https://github.com/willkill07) Approvers: - David Gardner (https://github.com/dagardner-nv) - Will Killian (https://github.com/willkill07) URL: NVIDIA#654
saglave
pushed a commit
to snps-scm13/SNPS-NeMo-Agent-Toolkit
that referenced
this pull request
Sep 2, 2025
…NVIDIA#654) - Added various badges for license, version, issues, pull requests, GitHub stars, forks, and PyPI downloads to improve visibility and engagement. - Updated the installation section to include specific instructions for installing NeMo Agent Toolkit from PyPI, including optional dependencies. - Reintroduced the Component Overview section with a diagram to provide a high-level view of the toolkit's architecture. - Added a roadmap Closes NVIDIA#624 Remaining Items: - [x] Add link to compatibility document after NVIDIA#653 is merged - [x] Complete the roadmap items - [x] Add an `all` package to `pyproject.toml` - This was accomplished through the creation of three metapackages: `ingestion`, `profiling`, and `all`. This resulted in the fewest duplications of dependencies while adding minimal overhead. - I am familiar with the [Contributing Guidelines](https://github.com/NVIDIA/NeMo-Agent-Toolkit/blob/develop/docs/source/resources/contributing.md). - 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. - When the PR is ready for review, new or existing tests cover these changes. - When the PR is ready for review, the documentation is up to date with these changes. Authors: - Michael Demoret (https://github.com/mdemoret-nv) - Will Killian (https://github.com/willkill07) Approvers: - David Gardner (https://github.com/dagardner-nv) - Will Killian (https://github.com/willkill07) URL: NVIDIA#654 Signed-off-by: Sangharsh Aglave <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Closes #624
Remaining Items:
allpackage topyproject.tomlingestion,profiling, andall. This resulted in the fewest duplications of dependencies while adding minimal overhead.By Submitting this PR I confirm: