-
Notifications
You must be signed in to change notification settings - Fork 416
Enhance README with badges, installation, instructions, and a roadmap #654
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.
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
Merged
Changes from 8 commits
Commits
Show all changes
9 commits
Select commit
Hold shift + click to select a range
de44c5e
Enhance README with badges and installation instructions
mdemoret-nv 4ee25d5
Update README with additional badges, installation instructions, and …
mdemoret-nv d01b6a0
Update README with emoji and migration guide link; fix GitHub casing
willkill07 8abf677
Add `all` metapackage
willkill07 c446b59
Switch badge format; fix branch_checker
willkill07 2b02940
Merge branch 'release/1.2' into mdd_update-readme
willkill07 77a7815
Add roadmap
willkill07 e296a8c
Add streamable to vale
willkill07 7f25995
Add reason for vale off; order badges
willkill07 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
Large diffs are not rendered by default.
Oops, something went wrong.
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,71 @@ | ||
| [build-system] | ||
| build-backend = "setuptools.build_meta" | ||
| requires = ["setuptools >= 64", "setuptools-scm>=8"] | ||
|
|
||
|
|
||
| [tool.setuptools.packages.find] | ||
| where = ["src"] | ||
| include = ["nat.*"] | ||
|
|
||
|
|
||
| [tool.setuptools_scm] | ||
| root = "../.." | ||
|
|
||
|
|
||
| [project] | ||
| name = "nvidia-nat-all" | ||
| dynamic = ["version"] | ||
| dependencies = [ | ||
| # Keep package version constraints as open as possible to avoid conflicts with other packages. Always define a minimum | ||
| # version when adding a new package. If unsure, default to using `~=` instead of `==`. Does not apply to nvidia-nat packages. | ||
| # Keep sorted!!! | ||
| "nvidia-nat~=1.2", | ||
| "nvidia-nat-agno", | ||
| "nvidia-nat-crewai", | ||
| "nvidia-nat-langchain", | ||
| "nvidia-nat-llama-index", | ||
| "nvidia-nat-mem0ai", | ||
| "nvidia-nat-mysql", | ||
| "nvidia-nat-opentelemetry", | ||
| "nvidia-nat-phoenix", | ||
| "nvidia-nat-profiling", | ||
| "nvidia-nat-ragaai", | ||
| "nvidia-nat-redis", | ||
| "nvidia-nat-s3", | ||
| "nvidia-nat-semantic-kernel", | ||
| "nvidia-nat-weave", | ||
| "nvidia-nat-zep-cloud", | ||
| "nvidia-nat-ingestion", | ||
| "gunicorn~=23.0", | ||
| ] | ||
| requires-python = ">=3.11,<3.13" | ||
| description = "Meta-package that installs the full NVIDIA NeMo Agent Toolkit plugin and optional dependency set" | ||
| readme = "src/nat/meta/pypi.md" | ||
| keywords = ["ai", "rag", "agents"] | ||
| classifiers = ["Programming Language :: Python"] | ||
|
|
||
|
|
||
| [tool.uv] | ||
| config-settings = { editable_mode = "compat" } | ||
|
|
||
|
|
||
| [tool.uv.sources] | ||
| nvidia-nat = { workspace = true } | ||
| nvidia-nat-agno = { workspace = true } | ||
| nvidia-nat-crewai = { workspace = true } | ||
| nvidia-nat-langchain = { workspace = true } | ||
| nvidia-nat-llama-index = { workspace = true } | ||
| nvidia-nat-mem0ai = { workspace = true } | ||
| nvidia-nat-mysql = { workspace = true } | ||
| nvidia-nat-opentelemetry = { workspace = true } | ||
| nvidia-nat-phoenix = { workspace = true } | ||
| nvidia-nat-profiling = { workspace = true } | ||
| nvidia-nat-ragaai = { workspace = true } | ||
| nvidia-nat-redis = { workspace = true } | ||
| nvidia-nat-s3 = { workspace = true } | ||
| nvidia-nat-semantic-kernel = { workspace = true } | ||
| nvidia-nat-weave = { workspace = true } | ||
| nvidia-nat-zep-cloud = { workspace = true } | ||
| nvidia-nat-ingestion = { workspace = true } | ||
|
|
||
|
|
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,23 @@ | ||
| <!-- | ||
| SPDX-FileCopyrightText: Copyright (c) 2025, NVIDIA CORPORATION & AFFILIATES. All rights reserved. | ||
| SPDX-License-Identifier: Apache-2.0 | ||
|
|
||
| Licensed under the Apache License, Version 2.0 (the "License"); | ||
| you may not use this file except in compliance with the License. | ||
| You may obtain a copy of the License at | ||
|
|
||
| http://www.apache.org/licenses/LICENSE-2.0 | ||
|
|
||
| Unless required by applicable law or agreed to in writing, software | ||
| distributed under the License is distributed on an "AS IS" BASIS, | ||
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| See the License for the specific language governing permissions and | ||
| limitations under the License. | ||
| --> | ||
|
|
||
|  | ||
|
|
||
| # NVIDIA NAT All Meta-Package | ||
| This is a meta-package that installs all NVIDIA NeMo Agent Toolkit plugins and optional dependencies. | ||
|
|
||
| For more information about the NVIDIA NeMo Agent toolkit, please visit the [NeMo Agent toolkit GitHub Repo](https://github.com/NVIDIA/NeMo-Agent-Toolkit). |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,39 @@ | ||
| [build-system] | ||
| build-backend = "setuptools.build_meta" | ||
| requires = ["setuptools >= 64", "setuptools-scm>=8"] | ||
|
|
||
|
|
||
| [tool.setuptools.packages.find] | ||
| where = ["src"] | ||
| include = ["nat.*"] | ||
|
|
||
|
|
||
| [tool.setuptools_scm] | ||
| root = "../.." | ||
|
|
||
|
|
||
| [project] | ||
| name = "nvidia-nat-ingestion" | ||
| dynamic = ["version"] | ||
| dependencies = [ | ||
| # Keep package version constraints as open as possible to avoid conflicts with other packages. Always define a minimum | ||
| # version when adding a new package. If unsure, default to using `~=` instead of `==`. Does not apply to nvidia-nat packages. | ||
| # Keep sorted!!! | ||
| "lxml~=5.4", | ||
| "nvidia-nat~=1.2", | ||
| ] | ||
| requires-python = ">=3.11,<3.13" | ||
| description = "Meta-package providing ingestion dependencies for NVIDIA NeMo Agent Toolkit" | ||
| readme = "src/nat/meta/pypi.md" | ||
| keywords = ["ai", "rag", "agents"] | ||
| classifiers = ["Programming Language :: Python"] | ||
|
|
||
|
|
||
| [tool.uv] | ||
| config-settings = { editable_mode = "compat" } | ||
|
|
||
|
|
||
| [tool.uv.sources] | ||
| nvidia-nat = { workspace = true } | ||
|
|
||
|
|
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,23 @@ | ||
| <!-- | ||
| SPDX-FileCopyrightText: Copyright (c) 2025, NVIDIA CORPORATION & AFFILIATES. All rights reserved. | ||
| SPDX-License-Identifier: Apache-2.0 | ||
|
|
||
| Licensed under the Apache License, Version 2.0 (the "License"); | ||
| you may not use this file except in compliance with the License. | ||
| You may obtain a copy of the License at | ||
|
|
||
| http://www.apache.org/licenses/LICENSE-2.0 | ||
|
|
||
| Unless required by applicable law or agreed to in writing, software | ||
| distributed under the License is distributed on an "AS IS" BASIS, | ||
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| See the License for the specific language governing permissions and | ||
| limitations under the License. | ||
| --> | ||
|
|
||
|  | ||
|
|
||
| # NVIDIA NAT Ingestion Meta-Package | ||
| This is a meta-package that installs ingestion dependencies for the NVIDIA NeMo Agent Toolkit. | ||
|
|
||
| For more information about the NVIDIA NeMo Agent toolkit, please visit the [NeMo Agent toolkit GitHub Repo](https://github.com/NVIDIA/NeMo-Agent-Toolkit). |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,41 @@ | ||
| [build-system] | ||
| build-backend = "setuptools.build_meta" | ||
| requires = ["setuptools >= 64", "setuptools-scm>=8"] | ||
|
|
||
|
|
||
| [tool.setuptools.packages.find] | ||
| where = ["src"] | ||
| include = ["nat.*"] | ||
|
|
||
|
|
||
| [tool.setuptools_scm] | ||
| root = "../.." | ||
|
|
||
|
|
||
| [project] | ||
| name = "nvidia-nat-profiling" | ||
| dynamic = ["version"] | ||
| dependencies = [ | ||
| # Keep package version constraints as open as possible to avoid conflicts with other packages. Always define a minimum | ||
| # version when adding a new package. If unsure, default to using `~=` instead of `==`. Does not apply to nvidia-nat packages. | ||
| # Keep sorted!!! | ||
| "matplotlib~=3.9", | ||
| "nvidia-nat~=1.2", | ||
| "prefixspan~=0.5.2", | ||
| "scikit-learn~=1.6", | ||
| ] | ||
| requires-python = ">=3.11,<3.13" | ||
| description = "Meta-package providing profiling dependencies for NVIDIA NeMo Agent Toolkit" | ||
| readme = "src/nat/meta/pypi.md" | ||
| keywords = ["ai", "rag", "agents"] | ||
| classifiers = ["Programming Language :: Python"] | ||
|
|
||
|
|
||
| [tool.uv] | ||
| config-settings = { editable_mode = "compat" } | ||
|
|
||
|
|
||
| [tool.uv.sources] | ||
| nvidia-nat = { workspace = true } | ||
|
|
||
|
|
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,23 @@ | ||
| <!-- | ||
| SPDX-FileCopyrightText: Copyright (c) 2025, NVIDIA CORPORATION & AFFILIATES. All rights reserved. | ||
| SPDX-License-Identifier: Apache-2.0 | ||
|
|
||
| Licensed under the Apache License, Version 2.0 (the "License"); | ||
| you may not use this file except in compliance with the License. | ||
| You may obtain a copy of the License at | ||
|
|
||
| http://www.apache.org/licenses/LICENSE-2.0 | ||
|
|
||
| Unless required by applicable law or agreed to in writing, software | ||
| distributed under the License is distributed on an "AS IS" BASIS, | ||
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| See the License for the specific language governing permissions and | ||
| limitations under the License. | ||
| --> | ||
|
|
||
|  | ||
|
|
||
| # NVIDIA NAT Profiling Meta-Package | ||
| This is a meta-package that installs profiling dependencies for the NVIDIA NeMo Agent Toolkit. | ||
|
|
||
| For more information about the NVIDIA NeMo Agent toolkit, please visit the [NeMo Agent toolkit GitHub Repo](https://github.com/NVIDIA/NeMo-Agent-Toolkit). |
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
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.