Add autogenerated API reference content to the documentation#190
Merged
hemildesai merged 4 commits intoNVIDIA-NeMo:mainfrom Apr 28, 2025
Merged
Add autogenerated API reference content to the documentation#190hemildesai merged 4 commits intoNVIDIA-NeMo:mainfrom
hemildesai merged 4 commits intoNVIDIA-NeMo:mainfrom
Conversation
Signed-off-by: Nathan McKimpson <nmckimpson@nvidia.com>
Signed-off-by: Nathan McKimpson <nmckimpson@nvidia.com>
Signed-off-by: Nathan McKimpson <nmckimpson@nvidia.com>
hemildesai
reviewed
Apr 21, 2025
nemo_run/__init__.py
Outdated
| # See the License for the specific language governing permissions and | ||
| # limitations under the License. | ||
|
|
||
| """The NeMO-Run API.""" |
Contributor
There was a problem hiding this comment.
Is this needed? If so can we rename to NeMo-Run?
Contributor
Author
There was a problem hiding this comment.
This docstring is used as an introduction to the generated API reference. A docstring is needed, but it can use any wording you'd like.
Here is an example of how it's used in the output: http://sw-mobile-docs/Nathan/nemo-run/api/nemo_run/index.html
There was a problem hiding this comment.
Suggested doc string: This module serves as the main entrypoint for the NeMo-Run Python library,
providing programmatic access to its core functionalities for configuring,
packaging, and launching experiments across various execution environments.
Signed-off-by: Hemil Desai <hemild@nvidia.com>
hemildesai
approved these changes
Apr 28, 2025
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
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.
This PR adds API reference content from project source files to the documentation build and cleans up some of the doc source files to remove build errors/warnings.