[REVIEW] Hiding implementation details for comms #409
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,168 @@ | ||
| /* | ||
| * Copyright (c) 2021, NVIDIA CORPORATION. | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
There was a problem hiding this comment. Should we really place a test file under the main include directory? (i.e. include/raft) There was a problem hiding this comment. @seunghwak, that's a great point and I'm open to suggestions on this one. In short, even though the file contains test functions, I've exposed them through the public API primarily for the hand-off to the cython layer. I guess on one hand it could be argued that the functions are internal to RAFT so maybe they could be treated as implementation details. On the other hand, they are public to the C/C++ API of the comms package so we are trying to make explicit the points which are exposed outside of the Maybe it would be more explicit if we put them in a There was a problem hiding this comment.
If this is the case, I am not opposed to placing these files in the If the test files are purely for internal testing, I prefer something like |
||
|
|
||
| #pragma once | ||
|
|
||
| #include <raft/comms/comms.hpp> | ||
| #include <raft/comms/detail/test.hpp> | ||
|
|
||
| #include <raft/handle.hpp> | ||
|
|
||
| namespace raft { | ||
| namespace comms { | ||
|
|
||
| /** | ||
| * @brief A simple sanity check that NCCL is able to perform a collective operation | ||
| * | ||
| * @param[in] handle the raft handle to use. This is expected to already have an | ||
| * initialized comms instance. | ||
| * @param[in] root the root rank id | ||
| */ | ||
| bool test_collective_allreduce(const handle_t& handle, int root) | ||
| { | ||
| return detail::test_collective_allreduce(handle, root); | ||
| } | ||
|
|
||
| /** | ||
| * @brief A simple sanity check that NCCL is able to perform a collective operation | ||
| * | ||
| * @param[in] handle the raft handle to use. This is expected to already have an | ||
| * initialized comms instance. | ||
| * @param[in] root the root rank id | ||
| */ | ||
| bool test_collective_broadcast(const handle_t& handle, int root) | ||
| { | ||
| return detail::test_collective_broadcast(handle, root); | ||
| } | ||
|
|
||
| /** | ||
| * @brief A simple sanity check that NCCL is able to perform a collective reduce | ||
| * | ||
| * @param[in] handle the raft handle to use. This is expected to already have an | ||
| * initialized comms instance. | ||
| * @param[in] root the root rank id | ||
| */ | ||
| bool test_collective_reduce(const handle_t& handle, int root) | ||
| { | ||
| return detail::test_collective_reduce(handle, root); | ||
| } | ||
|
|
||
| /** | ||
| * @brief A simple sanity check that NCCL is able to perform a collective allgather | ||
| * | ||
| * @param[in] handle the raft handle to use. This is expected to already have an | ||
| * initialized comms instance. | ||
| * @param[in] root the root rank id | ||
| */ | ||
| bool test_collective_allgather(const handle_t& handle, int root) | ||
| { | ||
| return detail::test_collective_allgather(handle, root); | ||
| } | ||
|
|
||
| /** | ||
| * @brief A simple sanity check that NCCL is able to perform a collective gather | ||
| * | ||
| * @param[in] handle the raft handle to use. This is expected to already have an | ||
| * initialized comms instance. | ||
| * @param[in] root the root rank id | ||
| */ | ||
| bool test_collective_gather(const handle_t& handle, int root) | ||
| { | ||
| return detail::test_collective_gather(handle, root); | ||
| } | ||
|
|
||
| /** | ||
| * @brief A simple sanity check that NCCL is able to perform a collective gatherv | ||
| * | ||
| * @param[in] handle the raft handle to use. This is expected to already have an | ||
| * initialized comms instance. | ||
| * @param[in] root the root rank id | ||
| */ | ||
| bool test_collective_gatherv(const handle_t& handle, int root) | ||
| { | ||
| return detail::test_collective_gatherv(handle, root); | ||
| } | ||
|
|
||
| /** | ||
| * @brief A simple sanity check that NCCL is able to perform a collective reducescatter | ||
| * | ||
| * @param[in] handle the raft handle to use. This is expected to already have an | ||
| * initialized comms instance. | ||
| * @param[in] root the root rank id | ||
| */ | ||
| bool test_collective_reducescatter(const handle_t& handle, int root) | ||
| { | ||
| return detail::test_collective_reducescatter(handle, root); | ||
| } | ||
|
|
||
| /** | ||
| * A simple sanity check that UCX is able to send messages between all ranks | ||
| * | ||
| * @param[in] h the raft handle to use. This is expected to already have an | ||
| * initialized comms instance. | ||
| * @param[in] numTrials number of iterations of all-to-all messaging to perform | ||
| */ | ||
| bool test_pointToPoint_simple_send_recv(const handle_t& h, int numTrials) | ||
| { | ||
| return detail::test_pointToPoint_simple_send_recv(h, numTrials); | ||
| } | ||
|
|
||
| /** | ||
| * A simple sanity check that device is able to send OR receive. | ||
| * | ||
| * @param h the raft handle to use. This is expected to already have an | ||
| * initialized comms instance. | ||
| * @param numTrials number of iterations of send or receive messaging to perform | ||
| */ | ||
| bool test_pointToPoint_device_send_or_recv(const handle_t& h, int numTrials) | ||
| { | ||
| return detail::test_pointToPoint_device_send_or_recv(h, numTrials); | ||
| } | ||
|
|
||
| /** | ||
| * A simple sanity check that device is able to send and receive at the same time. | ||
| * | ||
| * @param h the raft handle to use. This is expected to already have an | ||
| * initialized comms instance. | ||
| * @param numTrials number of iterations of send or receive messaging to perform | ||
| */ | ||
| bool test_pointToPoint_device_sendrecv(const handle_t& h, int numTrials) | ||
| { | ||
| return detail::test_pointToPoint_device_sendrecv(h, numTrials); | ||
| } | ||
|
|
||
| /** | ||
| * A simple sanity check that device is able to perform multiple concurrent sends and receives. | ||
| * | ||
| * @param h the raft handle to use. This is expected to already have an | ||
| * initialized comms instance. | ||
| * @param numTrials number of iterations of send or receive messaging to perform | ||
| */ | ||
| bool test_pointToPoint_device_multicast_sendrecv(const handle_t& h, int numTrials) | ||
| { | ||
| return detail::test_pointToPoint_device_multicast_sendrecv(h, numTrials); | ||
| } | ||
|
|
||
| /** | ||
| * A simple test that the comms can be split into 2 separate subcommunicators | ||
| * | ||
| * @param h the raft handle to use. This is expected to already have an | ||
| * initialized comms instance. | ||
| * @param n_colors number of different colors to test | ||
| */ | ||
| bool test_commsplit(const handle_t& h, int n_colors) { return detail::test_commsplit(h, n_colors); } | ||
| } // namespace comms | ||
| }; // namespace raft | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why did you put additional space here? Or is this clang-format's job?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I didn't add any additional spaces. This must have been clang-format.