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

Improved documentation to help people check their understanding #3780

Merged
merged 6 commits into from
Jan 8, 2022

Conversation

PabloAMC
Copy link
Contributor

Initial commit of reading group syllabus.

@codecov-commenter
Copy link

codecov-commenter commented Dec 30, 2021

Codecov Report

Merging #3780 (4a0e2a1) into master (4fcf8ae) will decrease coverage by 0.09%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master    #3780      +/-   ##
==========================================
- Coverage   81.86%   81.77%   -0.10%     
==========================================
  Files         299      299              
  Lines       15113    15157      +44     
==========================================
+ Hits        12373    12395      +22     
- Misses       2740     2762      +22     
Impacted Files Coverage Δ
torch_geometric/utils/geodesic.py 11.76% <0.00%> (-79.42%) ⬇️
torch_geometric/io/npz.py 35.00% <0.00%> (-3.89%) ⬇️
torch_geometric/graphgym/config.py 94.87% <0.00%> (-0.45%) ⬇️
torch_geometric/nn/conv/le_conv.py 100.00% <0.00%> (ø)
torch_geometric/nn/conv/nn_conv.py 100.00% <0.00%> (ø)
torch_geometric/nn/conv/gcn_conv.py 97.82% <0.00%> (ø)
torch_geometric/nn/conv/gin_conv.py 98.61% <0.00%> (ø)
torch_geometric/nn/conv/gmm_conv.py 100.00% <0.00%> (ø)
torch_geometric/nn/conv/pan_conv.py 98.18% <0.00%> (ø)
torch_geometric/nn/conv/pdn_conv.py 100.00% <0.00%> (ø)
... and 17 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 4fcf8ae...4a0e2a1. Read the comment docs.

@rusty1s
Copy link
Member

rusty1s commented Dec 31, 2021

This is absolutely great :)
I would love to integrate that directly into our documentation (rather than Jupyter notebooks in the code base). This should increase visibility and ease reviewing. WDYT?

@PabloAMC
Copy link
Contributor Author

This is absolutely great :) I would love to integrate that directly into our documentation (rather than Jupyter notebooks in the code base). This should increase visibility and ease reviewing. WDYT?

Sure, I can do it. I guess we can add the questions I had added in the Jupyter notebook to the documentation, (to check their understanding).

What about the reading group itself, how can we organize it? If there is interest I could coordinate. I can create a Google form on this. What do you think @rusty1s? Also, feel free to change the possible readings, if you have something better. I have also thought of explaining how to read csv data and work with heterogeneous graphs, but I am not sure where to put it.

Perhaps we should maintain somewhere a list of things we would like to see added too.

@rusty1s
Copy link
Member

rusty1s commented Jan 5, 2022

Sure, I can do it. I guess we can add the questions I had added in the Jupyter notebook to the documentation, (to check their understanding).

Yes, sounds good :)

What about the reading group itself, how can we organize it?

I have no particular preference. Please feel free to go ahead with whatever you feel is best. Nonetheless, let's try to first merge this PR and create an issue with things we would like to add. WDYT?

@PabloAMC PabloAMC changed the title Learning syllabus for reading group Improved documentation to help people check their understanding Jan 7, 2022
@PabloAMC
Copy link
Contributor Author

PabloAMC commented Jan 7, 2022

I've included the questions in the main documentation. A possible syllabus for reading group might rather be found on https://docs.google.com/document/d/1OWiVCteFLBQ1c7r9EwprB74OQSp7ku_SytBoC84gB00/edit?usp=sharing

@rusty1s
Copy link
Member

rusty1s commented Jan 8, 2022

This is great. Thanks a lot. I further fixed some styling issues and typos :)

@rusty1s rusty1s merged commit 5042a0d into pyg-team:master Jan 8, 2022
@PabloAMC PabloAMC deleted the learn_reading_group branch January 22, 2022 00:09
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.

3 participants