pytorch_geometric icon indicating copy to clipboard operation
pytorch_geometric copied to clipboard

MPNN special arguments documentation

Open BAlmeidaS opened this issue 1 year ago • 2 comments

📚 Describe the documentation issue

There is an inspector instance inside MPNN that removes any argument with the same name as the ones in special_args.

If I added them to the signatures of message, edge_update, aggregate, and so on, I understood that they brought some information; however, I could not find it anywhere in the documentation.

I'm sorry if it's in the documentation and I missed it, but I dug very deep before opening this issue.

Suggest a potential alternative/fix

Either moving to a better place, most probably to the MPNN documentation (in the case of already existing) or creating the documentation with what each one of those "special attributes" mean.

BAlmeidaS avatar Jul 01 '24 22:07 BAlmeidaS

I agree that we need better documentation around these special arguments that are available as function parameters in message and aggregate. Happy to answer any questions in the meantime.

rusty1s avatar Jul 08 '24 08:07 rusty1s

I would like to contribute to this.

rajveer43 avatar Jul 21 '24 09:07 rajveer43