Update documentation and variable names in models #23
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Fixes #11 Add numpy doc style docstrings and uniform variable names in models. * **graphmuse/loader/neighbor_loader.py** - Change `in_dim` to `input_channels` in `MuseNeighborLoader` class. - Add numpy doc style docstrings to `MuseNeighborLoader` class methods. - Add examples to docstrings where needed in `MuseNeighborLoader` class. * **graphmuse/nn/conv/gat.py** - Change `in_dim` to `input_channels` in `GraphAttentionLayer` class. - Add numpy doc style docstrings to `GraphAttentionLayer` class methods. - Add examples to docstrings where needed in `GraphAttentionLayer` class. * **graphmuse/nn/conv/gcn.py** - Change `in_dim` to `input_channels` in `GraphConv` class. - Add numpy doc style docstrings to `GraphConv` class methods. - Add examples to docstrings where needed in `GraphConv` class. * **graphmuse/nn/conv/ggru.py** - Change `in_features` to `input_channels` in `GGRU` class. - Add numpy doc style docstrings to `GGRU` class methods. - Add examples to docstrings where needed in `GGRU` class. * **graphmuse/nn/conv/metrical_conv.py** - Change `in_dim` to `input_channels` in `MetricalConvLayer` class. - Add numpy doc style docstrings to `MetricalConvLayer` class methods. - Add examples to docstrings where needed in `MetricalConvLayer` class. * **graphmuse/nn/conv/musgconv.py** - Change `in_channels` to `input_channels` in `MusGConv` class. - Add numpy doc style docstrings to `MusGConv` class methods. - Add examples to docstrings where needed in `MusGConv` class. --- For more details, open the [Copilot Workspace session](https://copilot-workspace.githubnext.com/manoskary/graphmuse/issues/11?shareId=XXXX-XXXX-XXXX-XXXX).
BaptisteHi
reviewed
Dec 3, 2024
| ------- | ||
| data_out : HeteroData | ||
| The sampled subgraph. | ||
| target_nodes : int |
There was a problem hiding this comment.
Maybe it is just me but I would name it differently since there is a parameter with the same name, but another type in the sample_hetero_graph function.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #11
Add numpy doc style docstrings and uniform variable names in models.
graphmuse/loader/neighbor_loader.py
in_dimtoinput_channelsinMuseNeighborLoaderclass.MuseNeighborLoaderclass methods.MuseNeighborLoaderclass.graphmuse/nn/conv/gat.py
in_dimtoinput_channelsinGraphAttentionLayerclass.GraphAttentionLayerclass methods.GraphAttentionLayerclass.graphmuse/nn/conv/gcn.py
in_dimtoinput_channelsinGraphConvclass.GraphConvclass methods.GraphConvclass.graphmuse/nn/conv/ggru.py
in_featurestoinput_channelsinGGRUclass.GGRUclass methods.GGRUclass.graphmuse/nn/conv/metrical_conv.py
in_dimtoinput_channelsinMetricalConvLayerclass.MetricalConvLayerclass methods.MetricalConvLayerclass.graphmuse/nn/conv/musgconv.py
in_channelstoinput_channelsinMusGConvclass.MusGConvclass methods.MusGConvclass.