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

Updated docstring for shape info #3697

Merged
merged 10 commits into from Dec 15, 2021
Merged

Updated docstring for shape info #3697

merged 10 commits into from Dec 15, 2021

Conversation

saiden89
Copy link
Contributor

As proposed in #3573, here is my take on the first chunk of convolutional layers in PyG. More will follow soon.

@codecov-commenter
Copy link

codecov-commenter commented Dec 14, 2021

Codecov Report

Merging #3697 (b542068) into master (ba468cd) will increase coverage by 0.00%.
The diff coverage is 100.00%.

Impacted file tree graph

@@           Coverage Diff           @@
##           master    #3697   +/-   ##
=======================================
  Coverage   81.68%   81.68%           
=======================================
  Files         295      295           
  Lines       14893    14898    +5     
=======================================
+ Hits        12165    12170    +5     
  Misses       2728     2728           
Impacted Files Coverage Δ
torch_geometric/nn/conv/agnn_conv.py 100.00% <ø> (ø)
torch_geometric/nn/conv/appnp.py 78.33% <ø> (ø)
torch_geometric/nn/conv/arma_conv.py 100.00% <ø> (ø)
torch_geometric/nn/conv/cheb_conv.py 100.00% <ø> (ø)
torch_geometric/nn/conv/dna_conv.py 98.54% <ø> (ø)
torch_geometric/nn/conv/edge_conv.py 100.00% <ø> (ø)
torch_geometric/nn/conv/eg_conv.py 90.51% <ø> (ø)
torch_geometric/nn/conv/fa_conv.py 89.47% <ø> (ø)
torch_geometric/nn/conv/feast_conv.py 100.00% <ø> (ø)
torch_geometric/nn/conv/film_conv.py 96.92% <ø> (ø)
... and 5 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update ba468cd...b542068. Read the comment docs.

@saiden89
Copy link
Contributor Author

Thanks for the corrections. Indeed, I was also wondering how to solve some inconsistencies in notation. So I guess now all features are F instead of H. How about the attention heads? Some papers refer to them as K (like GAT) some others to H. Do you think it would be better to follow the original article of to use a universal notation in PyG?

Copy link
Member

@rusty1s rusty1s left a comment

Choose a reason for hiding this comment

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

This is great, thank you :)
I further changed the CSS layout and made some style changes.

@rusty1s
Copy link
Member

rusty1s commented Dec 15, 2021

I think it's better to have a universal notation, and I like the following:

  • |V|: number of nodes
  • |E|: number of edges
  • F: node feature size
  • D: edge feature size
  • H: number of heads
  • L: number of layers

@rusty1s rusty1s merged commit fa4b2b2 into pyg-team:master Dec 15, 2021
@saiden89
Copy link
Contributor Author

I have another batch of the updated docstring. Is it possible to reopen this pull request or do I make a new one?

@rusty1s
Copy link
Member

rusty1s commented Dec 20, 2021

Please send a new one if possible :)

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

3 participants