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 documentation regarding neural type system. #370

Merged
merged 8 commits into from
Feb 20, 2020
Merged

Add documentation regarding neural type system. #370

merged 8 commits into from
Feb 20, 2020

Conversation

okuchaiev
Copy link
Member

@okuchaiev okuchaiev commented Feb 13, 2020 •
edited
Loading

Introduces "add_port_docs" which automatically generates docstrings for input and output ports.
Replaces old neural type tutorial with a new one.

@okuchaiev
add add_port_docs decorator
bcd26d2 
Signed-off-by: Oleksii Kuchaiev <okuchaiev@nvidia.com>
@lgtm-com
Copy link

lgtm-com bot commented Feb 13, 2020

This pull request introduces 3 alerts and fixes 3 when merging bcd26d2 into f072029 - view on LGTM.com

new alerts:

  • 1 for Unnecessary pass
  • 1 for Module imports itself
  • 1 for Except block handles 'BaseException'

fixed alerts:

  • 2 for Unused import
  • 1 for Wrong number of arguments in a class instantiation

@okuchaiev
Merge branch 'master' into type_docs_tests
d980b64 
Signed-off-by: Oleksii Kuchaiev <okuchaiev@nvidia.com>
@lgtm-com
Copy link

lgtm-com bot commented Feb 14, 2020

This pull request introduces 3 alerts and fixes 1 when merging d980b64 into 3e04e09 - view on LGTM.com

new alerts:

  • 1 for Unnecessary pass
  • 1 for Module imports itself
  • 1 for Except block handles 'BaseException'

fixed alerts:

  • 1 for Unused import

@lgtm-com
Copy link

lgtm-com bot commented Feb 18, 2020

This pull request introduces 3 alerts and fixes 1 when merging 2f20b70 into 142bed9 - view on LGTM.com

new alerts:

  • 1 for Unnecessary pass
  • 1 for Module imports itself
  • 1 for Except block handles 'BaseException'

fixed alerts:

  • 1 for Unused import

@okuchaiev
add new neural types docs
1ac0072 
Signed-off-by: Oleksii Kuchaiev <okuchaiev@nvidia.com>
@okuchaiev okuchaiev changed the title [WIP] Add documentation regarding neural type system. Add documentation regarding neural type system. Feb 18, 2020
@lgtm-com
Copy link

lgtm-com bot commented Feb 18, 2020

This pull request introduces 3 alerts and fixes 1 when merging 1ac0072 into 142bed9 - view on LGTM.com

new alerts:

  • 1 for Unnecessary pass
  • 1 for Module imports itself
  • 1 for Except block handles 'BaseException'

fixed alerts:

  • 1 for Unused import

@okuchaiev
fix style
34ce365 
Signed-off-by: Oleksii Kuchaiev <okuchaiev@nvidia.com>
@lgtm-com
Copy link

lgtm-com bot commented Feb 19, 2020

This pull request introduces 3 alerts and fixes 1 when merging 34ce365 into abaac1b - view on LGTM.com

new alerts:

  • 1 for Unnecessary pass
  • 1 for Module imports itself
  • 1 for Except block handles 'BaseException'

fixed alerts:

  • 1 for Unused import

blisc
blisc reviewed Feb 19, 2020
View reviewed changes
nemo/backends/pytorch/nm.py Outdated Show resolved Hide resolved
blisc
blisc reviewed Feb 19, 2020
View reviewed changes
Copy link
Collaborator

@blisc blisc left a comment

Choose a reason for hiding this comment

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

Can you either update changelog or the developer guide? Preferably both

@okuchaiev
Merge branch 'master' into type_docs_tests
e6f60dd
@okuchaiev
addressing reviews' comments
7d6c51c 
Signed-off-by: Oleksii Kuchaiev <okuchaiev@nvidia.com>
@okuchaiev
Copy link
Member Author

Can you either update changelog or the developer guide? Preferably both

updated both

@lgtm-com
Copy link

lgtm-com bot commented Feb 20, 2020

This pull request introduces 2 alerts and fixes 1 when merging 7d6c51c into d9be0af - view on LGTM.com

new alerts:

  • 1 for Module imports itself
  • 1 for Except block handles 'BaseException'

fixed alerts:

  • 1 for Unused import

blisc
blisc previously approved these changes Feb 20, 2020
View reviewed changes
@blisc
Copy link
Collaborator

blisc commented Feb 20, 2020

Please fix CI but otherwise looks good to me

@okuchaiev
fix style
07252b5 
Signed-off-by: Oleksii Kuchaiev <okuchaiev@nvidia.com>
@lgtm-com
Copy link

lgtm-com bot commented Feb 20, 2020

This pull request introduces 2 alerts and fixes 1 when merging 07252b5 into d9be0af - view on LGTM.com

new alerts:

  • 1 for Module imports itself
  • 1 for Except block handles 'BaseException'

fixed alerts:

  • 1 for Unused import

@okuchaiev okuchaiev merged commit 49bf035 into master Feb 20, 2020
@okuchaiev okuchaiev deleted the type_docs_tests branch July 27, 2020 20:20
dcurran90 pushed a commit to dcurran90/NeMo that referenced this pull request Oct 15, 2024
@xukai92
chore: add Kelly as doc owner (NVIDIA#370)
c772b9f 
Signed-off-by: Kai Xu <xuk@ibm.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@blisc blisc blisc approved these changes

@tkornuta-nvidia tkornuta-nvidia Awaiting requested review from tkornuta-nvidia

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@okuchaiev @blisc @tkornuta-nvidia