Skip to content

doc:2025.1 spec updates#613

Merged
rscohn2 merged 5 commits intouxlfoundation:mainfrom
ranukund:ranuk/oneccl-2021.15
Feb 28, 2025
Merged

doc:2025.1 spec updates#613
rscohn2 merged 5 commits intouxlfoundation:mainfrom
ranukund:ranuk/oneccl-2021.15

Conversation

@ranukund
Copy link
Copy Markdown
Contributor

No description provided.

@rscohn2 rscohn2 enabled auto-merge (squash) February 27, 2025 17:05
Co-authored-by: Robert Cohn <rscohn2@gmail.com>
auto-merge was automatically disabled February 27, 2025 18:56

Head branch was pushed to by a user without write access

@ranukund ranukund requested a review from rscohn2 February 27, 2025 18:56
Copy link
Copy Markdown

@garzaran garzaran left a comment

Choose a reason for hiding this comment

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

This looks good

Copy link
Copy Markdown
Member

@rscohn2 rscohn2 left a comment

Choose a reason for hiding this comment

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

Sorry. I did not notice the lack of indentation in the first review. Unindented line ends a code block, and there must be a blank line before that.

.. code:: cpp

template<class BufferType>
event ccl::allgather(const BufferType* send_buf,
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Suggested change
event ccl::allgather(const BufferType* send_buf,
event ccl::allgather(const BufferType* send_buf,

And following lines need to be indented

const allgather_attr& attr = default_allgather_attr,
const vector_class<event>& deps = {});

event ccl::allgather(const void* send_buf,
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Also needs indentation

const broadcast_attr& attr = default_broadcast_attr,
const vector_class<event>& deps = {});
template <class BufferType>
event ccl::broadcast(BufferType*send_buf,
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

needs indentation

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Since this is a new file, it needs to be added to the table of contents in operations.rst

@rscohn2
Copy link
Copy Markdown
Member

rscohn2 commented Feb 28, 2025

I pushed some changes to your branch. I believe I fixed the formatting issues as noted in the comments.

If you want to make more changes, you need to sync with the repo in github with my changes. One way to do it is to do a fresh clone of your repo and checkout the branch.

@rscohn2 rscohn2 dismissed their stale review February 28, 2025 04:29

issues resolved

@rscohn2 rscohn2 enabled auto-merge (squash) February 28, 2025 04:30
The buffer to store gathered result of BufferTuype, must be large enough to hold values from all ranks, i.e., size should be equal do BufferType * send_count

send_count
The number of elements of type BufferType in send_buf
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Here and a few other places you used unicode (non breaking space). You cannot use unicode directly.

@rscohn2 rscohn2 merged commit 71f6bf6 into uxlfoundation:main Feb 28, 2025
3 checks passed
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