Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Add EMA Docs, fix common collection documentation #5757

Merged
merged 5 commits into from
Jan 17, 2023
Merged

Add EMA Docs, fix common collection documentation #5757

merged 5 commits into from
Jan 17, 2023

Conversation

SeanNaren
Copy link
Collaborator

@SeanNaren SeanNaren commented Jan 9, 2023 •
edited
Loading

What does this PR do ?

Adds simple documentation for EMA. Also fixes the docs on main due to an incorrect import in the EMA class.

Collection: Common

Changelog

  • Add EMA documentation

Before your PR is "Ready for review"

Pre checks:

  • Make sure you read and followed Contributor guidelines
  • Did you write any new necessary tests?
  • Did you add or update any necessary documentation?
  • Does the PR affect components that are optional to install? (Ex: Numba, Pynini, Apex etc)
    • Reviewer: Does the PR have correct import guards for all optional libraries?

PR Type:

  • New Feature
  • Bugfix
  • Documentation

@SeanNaren
Add EMA docs, fix docs due to incorrect import, fix doc format for co…
43c22b1 
…mmon collection

Signed-off-by: SeanNaren <snarenthiran@nvidia.com>
@SeanNaren SeanNaren added the documentation Improvements or additions to documentation label Jan 9, 2023
@SeanNaren SeanNaren self-assigned this Jan 9, 2023
@github-actions github-actions bot added the common label Jan 9, 2023
SeanNaren
SeanNaren commented Jan 9, 2023
View reviewed changes
requirements/requirements_docs.txt Outdated
@@ -1,3 +1,4 @@
Jinja2<3.1
Copy link
Collaborator Author

@SeanNaren SeanNaren Jan 9, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

When running bash update_docs_docker.sh in the docs folder, I was getting this error: readthedocs/readthedocs.org#9038

To fix this, I set the requirement for docs.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wow it's still an issue after all this time ?? I could run it last year without this ..

Copy link
Collaborator Author

@SeanNaren SeanNaren Jan 12, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Tried again but still required this requirement, as it's building in a docker image I'll assume that it would be the same for everyone else

titu1994
titu1994 reviewed Jan 9, 2023
View reviewed changes
Copy link
Collaborator

@titu1994 titu1994 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Minor changes

docs/source/common/callbacks.rst Show resolved Hide resolved
docs/source/common/callbacks.rst Outdated Show resolved Hide resolved
requirements/requirements_docs.txt Outdated
@@ -1,3 +1,4 @@
Jinja2<3.1
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wow it's still an issue after all this time ?? I could run it last year without this ..

@titu1994 titu1994 merged commit 41f6d71 into main Jan 17, 2023
@titu1994 titu1994 deleted the docs/ema branch January 17, 2023 21:39
Kipok pushed a commit to Kipok/NeMo that referenced this pull request Jan 31, 2023
@SeanNaren @Kipok
Add EMA Docs, fix common collection documentation (NVIDIA#5757)
3ed7f9c 
* Add EMA docs, fix docs due to incorrect import, fix doc format for common collection

Signed-off-by: SeanNaren <snarenthiran@nvidia.com>

* Address feedback

Signed-off-by: SeanNaren <snarenthiran@nvidia.com>

Signed-off-by: SeanNaren <snarenthiran@nvidia.com>
ericharper pushed a commit that referenced this pull request Jan 31, 2023
@SeanNaren @ericharper
Add EMA Docs, fix common collection documentation (#5757)
939f610 
* Add EMA docs, fix docs due to incorrect import, fix doc format for common collection

Signed-off-by: SeanNaren <snarenthiran@nvidia.com>

* Address feedback

Signed-off-by: SeanNaren <snarenthiran@nvidia.com>

Signed-off-by: SeanNaren <snarenthiran@nvidia.com>
ericharper pushed a commit that referenced this pull request Jan 31, 2023
@SeanNaren @ericharper
Add EMA Docs, fix common collection documentation (#5757)
548de6d 
* Add EMA docs, fix docs due to incorrect import, fix doc format for common collection

Signed-off-by: SeanNaren <snarenthiran@nvidia.com>

* Address feedback

Signed-off-by: SeanNaren <snarenthiran@nvidia.com>

Signed-off-by: SeanNaren <snarenthiran@nvidia.com>
Kipok pushed a commit to Kipok/NeMo that referenced this pull request Jan 31, 2023
@SeanNaren @Kipok
Add EMA Docs, fix common collection documentation (NVIDIA#5757)
e2efcb6 
* Add EMA docs, fix docs due to incorrect import, fix doc format for common collection

Signed-off-by: SeanNaren <snarenthiran@nvidia.com>

* Address feedback

Signed-off-by: SeanNaren <snarenthiran@nvidia.com>

Signed-off-by: SeanNaren <snarenthiran@nvidia.com>
titu1994 pushed a commit to titu1994/NeMo that referenced this pull request Mar 24, 2023
@SeanNaren @titu1994
Add EMA Docs, fix common collection documentation (NVIDIA#5757)
950ea09 
* Add EMA docs, fix docs due to incorrect import, fix doc format for common collection

Signed-off-by: SeanNaren <snarenthiran@nvidia.com>

* Address feedback

Signed-off-by: SeanNaren <snarenthiran@nvidia.com>

Signed-off-by: SeanNaren <snarenthiran@nvidia.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@titu1994 titu1994 titu1994 approved these changes

Assignees

@SeanNaren SeanNaren

Labels
common documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@SeanNaren @titu1994