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

Adding small comms tutorial to docs #1204

Merged
merged 6 commits into from
Jan 31, 2023

Conversation

cjnolet
Copy link
Member

@cjnolet cjnolet commented Jan 28, 2023

Adding a small tutorial explaining how to use the raft comms to docs.

@cjnolet cjnolet added doc Documentation non-breaking Non-breaking change labels Jan 28, 2023
@cjnolet cjnolet self-assigned this Jan 28, 2023
@cjnolet cjnolet marked this pull request as ready for review January 28, 2023 02:38
@codecov-commenter
Copy link

codecov-commenter commented Jan 28, 2023

Codecov Report

Base: 87.99% // Head: 87.99% // No change to project coverage 👍

Coverage data is based on head (552c1a8) compared to base (2fb5c06).
Patch has no changes to coverable lines.

Additional details and impacted files
@@              Coverage Diff              @@
##           branch-23.02    #1204   +/-   ##
=============================================
  Coverage         87.99%   87.99%           
=============================================
  Files                21       21           
  Lines               483      483           
=============================================
  Hits                425      425           
  Misses               58       58           

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

docs/source/using_comms.rst Outdated Show resolved Hide resolved
docs/source/using_comms.rst Outdated Show resolved Hide resolved
def run_test_allreduce(handle, root):
cdef const device_resources* h = <device_resources*><size_t>handle.getHandle()

test_allreduce(deref(h), root)
Copy link
Contributor

Choose a reason for hiding this comment

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

Is the indentation level wrong?

Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
test_allreduce(deref(h), root)
test_allreduce(deref(h), root)

docs/source/using_comms.rst Outdated Show resolved Hide resolved
docs/source/using_comms.rst Outdated Show resolved Hide resolved
docs/source/using_comms.rst Show resolved Hide resolved
cjnolet and others added 3 commits January 30, 2023 12:16
Co-authored-by: Micka <9810050+lowener@users.noreply.github.com>
Co-authored-by: Ben Frederickson <github@benfrederickson.com>
@cjnolet cjnolet requested a review from a team as a code owner January 30, 2023 22:17
Copy link
Member

@benfred benfred left a comment

Choose a reason for hiding this comment

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

lgtm!

@cjnolet
Copy link
Member Author

cjnolet commented Jan 31, 2023

/merge

@rapids-bot rapids-bot bot merged commit 6896db6 into rapidsai:branch-23.02 Jan 31, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Documentation non-breaking Non-breaking change python
Projects
Development

Successfully merging this pull request may close these issues.

4 participants