• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /**
2  * Copyright 2020 Huawei Technologies Co., Ltd
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 
17 #ifndef MINDSPORE_CORE_OPS_BROADCAST_H_
18 #define MINDSPORE_CORE_OPS_BROADCAST_H_
19 #include <memory>
20 #include <string>
21 #include <vector>
22 
23 #include "mindapi/base/types.h"
24 #include "ops/base_operator.h"
25 
26 namespace mindspore {
27 namespace ops {
28 constexpr auto kNameBroadcast = "Broadcast";
29 /// \brief Broadcasts the tensor to the whole group. Refer to Python API @ref mindspore.ops.Broadcast for more details.
30 class MIND_API Broadcast : public BaseOperator {
31  public:
32   MIND_API_BASE_MEMBER(Broadcast);
33   /// \brief Constructor.
Broadcast()34   Broadcast() : BaseOperator(kNameBroadcast) {}
35   /// \brief Init. Refer to the parameters of Python API @ref mindspore.ops.Broadcast for the inputs.
36   void Init(const int64_t root_rank, const std::string &group = "hccl_world_group");
37   /// \brief Set root_rank.
38   void set_root_rank(const int64_t root_rank);
39   /// \brief Set group.
40   void set_group(const std::string &group);
41   /// \brief Get root_rank.
42   ///
43   /// \return root_rank.
44   int64_t get_root_rank() const;
45   /// \brief Get group.
46   ///
47   /// \return group.
48   std::string get_group() const;
49 };
50 using PrimBroadcast = std::shared_ptr<Broadcast>;
51 }  // namespace ops
52 }  // namespace mindspore
53 
54 #endif  // MINDSPORE_CORE_OPS_BROADCAST_H_
55