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

Add torch_geometric.sampler package to docs #5563

Merged
merged 7 commits into from
Sep 29, 2022

Conversation

seemanne
Copy link
Contributor

@seemanne seemanne commented Sep 29, 2022

This PR adds the code in torch_geometric/sampler to the docs.
The section should be added, as the NodeLoader class takes a BaseSampler object in its input but that object is currently not documented in the documentation. This also fixes the currently black link in the NodeLoader documentation.

@seemanne seemanne marked this pull request as draft September 29, 2022 08:52
@codecov
Copy link

codecov bot commented Sep 29, 2022

Codecov Report

Merging #5563 (1b4d14a) into master (845ebbf) will increase coverage by 0.00%.
The diff coverage is 100.00%.

❗ Current head 1b4d14a differs from pull request most recent head 6c2bc85. Consider uploading reports for the commit 6c2bc85 to get more accurate results

@@           Coverage Diff           @@
##           master    #5563   +/-   ##
=======================================
  Coverage   83.68%   83.69%           
=======================================
  Files         346      346           
  Lines       19000    18998    -2     
=======================================
- Hits        15901    15900    -1     
+ Misses       3099     3098    -1     
Impacted Files Coverage Δ
torch_geometric/sampler/__init__.py 100.00% <100.00%> (ø)
torch_geometric/nn/dense/linear.py 83.96% <0.00%> (+0.51%) ⬆️

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

@seemanne seemanne marked this pull request as ready for review September 29, 2022 09:06
@rusty1s rusty1s changed the title Add /sampler to docs Add torch_geometric.sampler package to docs Sep 29, 2022
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.

Thank you!

@rusty1s rusty1s enabled auto-merge (squash) September 29, 2022 18:26
@rusty1s rusty1s merged commit 9b4b854 into pyg-team:master Sep 29, 2022
JakubPietrakIntel pushed a commit to JakubPietrakIntel/pytorch_geometric that referenced this pull request Nov 25, 2022
* add sampler modules

* add sampler.rst

* add classes for docs

* update changelog

* update changelog

* update

Co-authored-by: rusty1s <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants