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

GNNModular #3339

Merged
merged 26 commits into from
Apr 10, 2023
Merged

GNNModular #3339

merged 26 commits into from
Apr 10, 2023

Conversation

tonydavis629
Copy link
Collaborator

This PR adds GNNModular to torch_models. GNNModular allows users to define graph convolutional encoders, prediction heads, and specific tasks such as node prediction, edge prediction, regression, classification, etc. This PR implements edge prediction only, using the GINEConv layer from torch geometric. as the GCN

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

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.

Good start! Mostly requests for more documentation below

deepchem/models/torch_models/gnn.py Show resolved Hide resolved
deepchem/models/torch_models/gnn.py Outdated Show resolved Hide resolved
deepchem/models/torch_models/gnn.py Outdated Show resolved Hide resolved
deepchem/models/torch_models/gnn.py Show resolved Hide resolved
deepchem/models/torch_models/gnn.py Show resolved Hide resolved
The number of negative edges added is equal to half the number of edges in the original graph. This is useful for tasks like edge prediction, where the model needs to learn to differentiate between existing and non-existing edges.
"""

def __call__(self, data):
Copy link
Member

Choose a reason for hiding this comment

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

Can you add a docstring?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

done

deepchem/models/torch_models/gnn.py Show resolved Hide resolved
@@ -84,7 +84,7 @@ def __init__(self, model: nn.Module, components: dict, **kwargs):
super().__init__(self.model, self.loss_func, **kwargs)
self.model.to(self.device)
self.components = {
k: v.to(self.device) for k, v in self.components.items()
k: v.to(self.device) for k, v in self.components.items() if isinstance(v, nn.Module)
Copy link
Member

Choose a reason for hiding this comment

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

When would we expect to have a non nn.module in self.components?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

In this GNNModular class. The pooling components can be either a function or parameterized nn.module.

deepchem/models/torch_models/gnn.py Show resolved Hide resolved
deepchem/models/torch_models/gnn.py Show resolved Hide resolved
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.

One minor refactoring request below (self.JK -> self.jump_knowledge). Once that's done and a requested comment below is added this should be ready to merge in

deepchem/models/tests/test_gnn.py Show resolved Hide resolved
deepchem/models/torch_models/gnn.py Outdated Show resolved Hide resolved
deepchem/models/torch_models/gnn.py Show resolved Hide resolved
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, feel free to merge once CI is clear

@tonydavis629 tonydavis629 merged commit 6ab6bf5 into deepchem:master Apr 10, 2023
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.

None yet

2 participants