search

pyg-team / pytorch_geometric

Graph Neural Network Library for PyTorch
https://pyg.org
MIT License
21.08k stars 3.63k forks source link

MPNN special arguments documentation #9476

Open BAlmeidaS opened 3 months ago

BAlmeidaS commented 3 months ago

📚 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.

rusty1s commented 2 months ago

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.

rajveer43 commented 2 months ago

I would like to contribute to this.