• 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_CCSRC_MINDDATA_DATASET_CALLBACK_PARAM_H
18 #define MINDSPORE_CCSRC_MINDDATA_DATASET_CALLBACK_PARAM_H
19 
20 #include <nlohmann/json.hpp>
21 
22 namespace mindspore {
23 namespace dataset {
24 
25 /// Callback Param is the object a DatasetOp uses to pass run-time information to user defined function.
26 /// This is a prototype for now, more fields will be added
27 class CallbackParam {
28  public:
CallbackParam(int64_t epoch_num,int64_t cur_epoch_step,int64_t total_step_num)29   CallbackParam(int64_t epoch_num, int64_t cur_epoch_step, int64_t total_step_num)
30       : cur_epoch_num_(epoch_num), cur_epoch_step_num_(cur_epoch_step), cur_step_num_(total_step_num) {}
31 
32   ~CallbackParam() = default;
33 
34   // these are constant public fields for easy access and consistency with python cb_param
35   // the names and orders are consistent with batchInfo
36   const int64_t cur_epoch_num_;       // current epoch
37   const int64_t cur_epoch_step_num_;  // step number of the current epoch
38   const int64_t cur_step_num_;        // step number since the first row
39 };
40 }  // namespace dataset
41 }  // namespace mindspore
42 #endif  // MINDSPORE_CCSRC_MINDDATA_DATASET_CALLBACK_PARAM_H
43