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