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.

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

Discrepancy in DTNNGather class of layers.py. #3855

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

oleeviyababu
Copy link

The default value for layer_sizes is [1000] in the parameter description, while in the method signature, it is [100].This inconsistency could potentially confuse users who rely on the documentation to understand the default behavior of the DTNNGather class.

Description

Fix #3854

Please include a summary of the change and which issue is fixed.
The default value for layer_sizes is [1000] in the parameter description, while in the method signature, it is [100].This inconsistency could potentially confuse users who rely on the documentation to understand the default behavior of the DTNNGather class.To resolve this discrepancy, we need to ensure that both the parameter description and the method signature reflect the same default value for layer_sizes.

List any dependencies that are required for this change. -->

Type of change

Please check the option that is related to your PR.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
    • In this case, we recommend to discuss your modification on GitHub issues before creating the PR
  • [ x] Documentations (modification for documents)

Checklist

  • My code follows the style guidelines of this project
    • Run yapf -i <modified file> and check no errors (yapf version must be 0.32.0)
    • Run mypy -p deepchem and check no errors
    • Run flake8 <modified file> --count and check no errors
    • Run python -m doctest <modified file> and check no errors
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • I have added tests that prove my fix is effective or that my feature works
  • New unit tests pass locally with my changes
  • I have checked my code and corrected any misspellings

The default value for layer_sizes is [1000] in the parameter description, while in the method signature, it is [100].This inconsistency could potentially confuse users who rely on the documentation to understand the default behavior of the DTNNGather class.
Copy link
Member

@shreyasvinaya shreyasvinaya left a comment

Choose a reason for hiding this comment

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

LGTM, can merge in once CI passes
cc @rbharath

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Discrepancy in both the parameter description and the method signature in class DTNNGather.
2 participants