1 /** 2 * Copyright 2021 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_SBU_NODE_H_ 18 #define MINDSPORE_CCSRC_MINDDATA_DATASET_ENGINE_IR_DATASETOPS_SOURCE_SBU_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 29 class SBUNode : public MappableSourceNode { 30 public: 31 /// \brief Constructor. 32 SBUNode(const std::string &dataset_dir, bool decode, const std::shared_ptr<SamplerObj> &sampler, 33 const std::shared_ptr<DatasetCache> &cache); 34 35 /// \brief Destructor. 36 ~SBUNode() = default; 37 38 /// \brief Node name getter. 39 /// \return Name of the current node. Name()40 std::string Name() const override { return kSBUNode; } 41 42 /// \brief Print the description. 43 /// \param out - The output stream to write output to. 44 void Print(std::ostream &out) const override; 45 46 /// \brief Copy the node to a new object. 47 /// \return A shared pointer to the new copy. 48 std::shared_ptr<DatasetNode> Copy() override; 49 50 /// \brief a base class override function to create the required runtime dataset op objects for this class. 51 /// \param node_ops - A vector containing shared pointer to the Dataset Ops that this object will create. 52 /// \return Status Status::OK() if build successfully. 53 Status Build(std::vector<std::shared_ptr<DatasetOp>> *const node_ops) override; 54 55 /// \brief Parameters validation. 56 /// \return Status Status::OK() if all the parameters are valid. 57 Status ValidateParams() override; 58 59 /// \brief Get the shard id of node. 60 /// \param[in] shard_id The shard id. 61 /// \return Status Status::OK() if get shard id successfully. 62 Status GetShardId(int32_t *shard_id) override; 63 64 /// \brief Base-class override for GetDatasetSize. 65 /// \param[in] size_getter Shared pointer to DatasetSizeGetter. 66 /// \param[in] estimate This is only supported by some of the ops and it's used to speed up the process of getting 67 /// dataset size at the expense of accuracy. 68 /// \param[out] dataset_size the size of the dataset. 69 /// \return Status of the function. 70 Status GetDatasetSize(const std::shared_ptr<DatasetSizeGetter> &size_getter, bool estimate, 71 int64_t *dataset_size) override; 72 73 /// \brief Getter functions. DatasetDir()74 const std::string &DatasetDir() const { return dataset_dir_; } Decode()75 bool Decode() const { return decode_; } 76 77 /// \brief Get the arguments of node. 78 /// \param[out] out_json JSON string of all attributes. 79 /// \return Status of the function. 80 Status to_json(nlohmann::json *out_json) override; 81 82 /// \brief Sampler getter. 83 /// \return SamplerObj of the current node. Sampler()84 std::shared_ptr<SamplerObj> Sampler() override { return sampler_; } 85 86 /// \brief Sampler setter. SetSampler(std::shared_ptr<SamplerObj> sampler)87 void SetSampler(std::shared_ptr<SamplerObj> sampler) override { sampler_ = sampler; } 88 89 private: 90 std::string dataset_dir_; 91 bool decode_; 92 std::shared_ptr<SamplerObj> sampler_; 93 }; 94 95 } // namespace dataset 96 } // namespace mindspore 97 #endif // MINDSPORE_CCSRC_MINDDATA_DATASET_ENGINE_IR_DATASETOPS_SOURCE_SBU_NODE_H_ 98