1 /** 2 * Copyright 2020-2022 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_CCSRC_MINDDATA_DATASET_ENGINE_IR_DATASETOPS_SOURCE_DATA_QUEUE_NODE_H_ 18 #define MINDSPORE_CCSRC_MINDDATA_DATASET_ENGINE_IR_DATASETOPS_SOURCE_DATA_QUEUE_NODE_H_ 19 20 #include <memory> 21 #include <string> 22 #include <vector> 23 24 #include "minddata/dataset/engine/ir/datasetops/dataset_node.h" 25 26 namespace mindspore { 27 namespace dataset { 28 class DataQueueNode : public DatasetNode { 29 public: 30 /// \brief Constructor 31 DataQueueNode(std::shared_ptr<DatasetNode> child, std::string queue_name, std::string device_type, int32_t device_id, 32 bool send_epoch_end, int32_t total_batch, bool create_data_info_queue); 33 34 /// \brief Destructor 35 ~DataQueueNode() override = default; 36 37 /// \brief Node name getter 38 /// \return Name of the current node Name()39 std::string Name() const override { return kTransferNode; } 40 41 /// \brief Print the description 42 /// \param out - The output stream to write output to 43 void Print(std::ostream &out) const override; 44 45 /// \brief Copy the node to a new object 46 /// \return A shared pointer to the new copy 47 std::shared_ptr<DatasetNode> Copy() override; 48 49 /// \brief a base class override function to create the required runtime dataset op objects for this class 50 /// \param node_ops - A vector containing shared pointer to the Dataset Ops that this object will create 51 /// \return Status Status::OK() if build successfully 52 Status Build(std::vector<std::shared_ptr<DatasetOp>> *const node_ops) override; 53 54 /// \brief Parameters validation 55 /// \return Status Status::OK() if all the parameters are valid 56 Status ValidateParams() override; 57 58 static Status get_distribution(std::shared_ptr<DatasetNode> ds, int32_t *device_id); 59 60 /// \brief Base-class override for accepting IRNodePass visitor 61 /// \param[in] p The node to visit 62 /// \param[out] modified Indicator if the node was modified 63 /// \return Status of the node visit 64 Status Accept(IRNodePass *const p, bool *const modified) override; 65 66 /// \brief Base-class override for accepting IRNodePass visitor 67 /// \param[in] p The node to visit 68 /// \param[out] modified Indicator if the node was modified 69 /// \return Status of the node visit 70 Status AcceptAfter(IRNodePass *const p, bool *const modified) override; 71 72 /// \brief Getter functions QueueName()73 const std::string &QueueName() const { return queue_name_; } DeviceId()74 int32_t DeviceId() const { return device_id_; } DeviceType()75 const std::string &DeviceType() const { return device_type_; } SendEpochEnd()76 bool SendEpochEnd() const { return send_epoch_end_; } TotalBatch()77 int32_t TotalBatch() const { return total_batch_; } CreateDataInfoQueue()78 bool CreateDataInfoQueue() const { return create_data_info_queue_; } 79 80 /// \brief Get the arguments of node 81 /// \param[out] out_json JSON string of all attributes 82 /// \return Status of the function 83 Status to_json(nlohmann::json *out_json) override; 84 85 /// \brief Function for read dataset operation from json 86 /// \param[in] json_obj The JSON object to be deserialized 87 /// \param[in] ds dataset node constructed 88 /// \param[out] result Deserialized dataset after the operation 89 /// \return Status The status code returned 90 static Status from_json(nlohmann::json json_obj, std::shared_ptr<DatasetNode> ds, 91 std::shared_ptr<DatasetNode> *result); 92 93 private: 94 std::string queue_name_; 95 int32_t device_id_; 96 std::string device_type_; 97 bool send_epoch_end_; 98 int32_t total_batch_; 99 bool create_data_info_queue_; 100 }; 101 } // namespace dataset 102 } // namespace mindspore 103 #endif // MINDSPORE_CCSRC_MINDDATA_DATASET_ENGINE_IR_DATASETOPS_SOURCE_DATA_QUEUE_NODE_H_ 104