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

Editable module #3618

Merged
merged 14 commits into from
Oct 28, 2023
Merged

Editable module #3618

merged 14 commits into from
Oct 28, 2023

Conversation

GreatRSingh
Copy link
Contributor

@GreatRSingh GreatRSingh commented Oct 17, 2023 •
edited

Description

Fix #(issue)

Tasks:

  • EditableModule
  • Example
  • Docs

Tests:

  • getparams
  • setparams
  • cachedparamnames
  • getparamnames
  • getuniqueparams
  • setuniqueparams
  • _get_unique_params_idxs
  • assertparams
  • __assert_method_preserve - [checked with assertparams]
  • __assert_get_correct_params - [checked with asserparams]
  • __list_operating_params - [checked with assertparams]
  • _traverse_obj
  • _get_tensors
  • _set_tensors

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
  • 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

@GreatRSingh GreatRSingh marked this pull request as ready for review October 17, 2023 21:11
rbharath
rbharath reviewed Oct 18, 2023
View reviewed changes
deepchem/utils/differentiation_utils/editable_module.py Outdated


# traversing functions
def _traverse_obj(obj, prefix, action, crit, max_depth=20, exception_ids=None):
Copy link
Member

Choose a reason for hiding this comment

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

Add type annotations and full docstring

Copy link
Member

Choose a reason for hiding this comment

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

Add a usage example

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done

rbharath
rbharath reviewed Oct 18, 2023
View reviewed changes
deepchem/utils/differentiation_utils/editable_module.py Outdated
raise RecursionError("Maximum number of recursion reached")


def _get_tensors(obj, prefix="", max_depth=20):
Copy link
Member

Choose a reason for hiding this comment

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

Add type annotations

Copy link
Member

Choose a reason for hiding this comment

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

Add a usage example

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done

rbharath
rbharath reviewed Oct 18, 2023
View reviewed changes
deepchem/utils/differentiation_utils/editable_module.py Outdated
return res, names


def _set_tensors(obj, all_params, max_depth=20):
Copy link
Member

Choose a reason for hiding this comment

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

Type annotations

Copy link
Member

Choose a reason for hiding this comment

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

Add a usage example

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done

rbharath
rbharath reviewed Oct 18, 2023
View reviewed changes
Copy link
Member

@rbharath rbharath left a comment

Choose a reason for hiding this comment

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

Requests for improvements to docs and more tests

rbharath
rbharath reviewed Oct 20, 2023
View reviewed changes
Copy link
Member

@rbharath rbharath left a comment

Choose a reason for hiding this comment

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

@GreatRSingh Every method in the new class should have an associated unit test. Please go through and add tests accordingly. Let's do the same for the private methods as well since some of them are complicated

@rbharath
Copy link
Member

@GreatRSingh Also unit tests are failing. Please fix failing unit tests

@GreatRSingh
Copy link
Contributor Author

@GreatRSingh Every method in the new class should have an associated unit test. Please go through and add tests accordingly. Let's do the same for the private methods as well since some of them are complicated

I was unable to add tests for private methods directly (as they are private) but they were used in assertparams so they are kind of checked in that.

rbharath
rbharath reviewed Oct 25, 2023
View reviewed changes
Copy link
Member

@rbharath rbharath left a comment

Choose a reason for hiding this comment

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

@GreatRSingh Once you fix mypy, should be good to merge

rbharath
rbharath approved these changes Oct 28, 2023
View reviewed changes
Copy link
Member

@rbharath rbharath left a comment

Choose a reason for hiding this comment

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

LGTM

@rbharath rbharath merged commit 7c16e56 into deepchem:master Oct 28, 2023
23 of 33 checks passed
@GreatRSingh GreatRSingh deleted the Editable-Module branch October 28, 2023 16:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@rbharath rbharath rbharath approved these changes

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

Successfully merging this pull request may close these issues.

None yet
2 participants
@GreatRSingh @rbharath