Add API docs for NeMo Megatron #6850
Merged
Conversation
This file contains 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
Signed-off-by: ericharper <[email protected]>
Signed-off-by: ericharper <[email protected]>
Signed-off-by: ericharper <[email protected]>
Signed-off-by: ericharper <[email protected]>
Signed-off-by: ericharper <[email protected]>
MaximumEntropy
suggested changes
Jun 12, 2023
docs/source/nlp/api.rst
Outdated
| .. autoclass:: nemo.collections.nlp.models.language_modeling.megatron_bart_model.MegatronBARTModel | ||
| :show-inheritance: | ||
| :no-members: | ||
| :members: training_step, validation_step, build_train_valid_test_datasets, build_LDDL_data, setup, on_save_checkpoint, on_load_checkpoint |
There was a problem hiding this comment.
Is this meant to show just the members of this class? If so, I don't think BART has any public methods. It just inherits everything from T5 and definitely does not have an LDDL data path.
There was a problem hiding this comment.
yeah good catch, LDDL showed up there from copy pasting. I was trying to show methods per class that would be useful
| .. autoclass:: nemo.collections.nlp.models.language_modeling.megatron_gpt_sft_model.MegatronGPTSFTModel | ||
| :show-inheritance: | ||
| :no-members: | ||
| :members: generate, training_step, validation_step, build_train_valid_test_datasets, setup |
There was a problem hiding this comment.
Should just include methods from parent classes? If not, training_step comes from the parent GPTModel class.
MaximumEntropy
approved these changes
Jun 13, 2023
github-actions bot
pushed a commit
that referenced
this pull request
Jun 13, 2023
* add model pretraining and customization classes Signed-off-by: ericharper <[email protected]> * fix Signed-off-by: ericharper <[email protected]> * test width Signed-off-by: ericharper <[email protected]> * increase middle pane width Signed-off-by: ericharper <[email protected]> * add modules and datasets Signed-off-by: ericharper <[email protected]> * remove global in t5 dataset s and fix formatting in megatron base model Signed-off-by: ericharper <[email protected]> --------- Signed-off-by: ericharper <[email protected]>
ericharper
added a commit
that referenced
this pull request
Jun 14, 2023
* add model pretraining and customization classes * fix * test width * increase middle pane width * add modules and datasets * remove global in t5 dataset s and fix formatting in megatron base model --------- Signed-off-by: ericharper <[email protected]> Co-authored-by: Eric Harper <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
What does this PR do ?
Adds API documentation.
Collection: NLP
Changelog
Usage
# Add a code snippet demonstrating how to use thisBefore your PR is "Ready for review"
Pre checks:
PR Type:
If you haven't finished some of the above items you can still open "Draft" PR.
Who can review?
Anyone in the community is free to review the PR once the checks have passed.
Contributor guidelines contains specific people who can review PRs to various areas.
Additional Information