forked from huawei/mindspore2022
80 lines
3.1 KiB
C++
80 lines
3.1 KiB
C++
/**
|
|
* Copyright 2020 Huawei Technologies Co., Ltd
|
|
*
|
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
* you may not use this file except in compliance with the License.
|
|
* You may obtain a copy of the License at
|
|
*
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
*
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
* See the License for the specific language governing permissions and
|
|
* limitations under the License.
|
|
*/
|
|
|
|
#ifndef MINDSPORE_CCSRC_MINDDATA_DATASET_INCLUDE_CONFIG_H
|
|
#define MINDSPORE_CCSRC_MINDDATA_DATASET_INCLUDE_CONFIG_H
|
|
|
|
#include <cstdint>
|
|
#include <string>
|
|
|
|
namespace mindspore {
|
|
namespace dataset {
|
|
|
|
// Config operations for setting and getting the configuration.
|
|
namespace config {
|
|
|
|
/// \brief Function to set the seed to be used in any random generator. This is used to produce deterministic results.
|
|
/// \param[in] seed the default seed to use.
|
|
bool set_seed(int32_t seed);
|
|
|
|
/// \brief Function to get the seed.
|
|
/// \return the seed set in the configuration.
|
|
uint32_t get_seed();
|
|
|
|
/// \brief Function to set the number of rows to be prefetched.
|
|
/// \param[in] prefetch_size total number of rows to be prefetched.
|
|
bool set_prefetch_size(int32_t prefetch_size);
|
|
|
|
/// \brief Function to get the prefetch size in number of rows.
|
|
/// \return total number of rows to be prefetched.
|
|
int32_t get_prefetch_size();
|
|
|
|
/// \brief Function to set the default number of parallel workers.
|
|
/// \param[in] num_parallel_workers number of parallel workers to be used as a default for each operation.
|
|
bool set_num_parallel_workers(int32_t num_parallel_workers);
|
|
|
|
/// \brief Function to get the default number of parallel workers.
|
|
/// \return number of parallel workers to be used as a default for each operation.
|
|
int32_t get_num_parallel_workers();
|
|
|
|
/// \brief Function to set the default interval (in milliseconds) for monitor sampling.
|
|
/// \param[in] interval interval (in milliseconds) to be used for performance monitor sampling.
|
|
bool set_monitor_sampling_interval(int32_t interval);
|
|
|
|
/// \brief Function to get the default interval of performance monitor sampling.
|
|
/// \return interval (in milliseconds) for performance monitor sampling.
|
|
int32_t get_monitor_sampling_interval();
|
|
|
|
/// \brief Function to set the default timeout (in seconds) for DSWaitedCallback. In case of a deadlock, the wait
|
|
/// function will exit after the timeout period.
|
|
/// \param[in] timeout timeout (in seconds) to be used to end the wait in DSWaitedCallback in case of a deadlock.
|
|
bool set_callback_timeout(int32_t timeout);
|
|
|
|
/// \brief Function to get the default timeout for DSWaitedCallback. In case of a deadback, the wait function will exit
|
|
/// after the timeout period.
|
|
/// \return the duration in seconds.
|
|
int32_t get_callback_timeout();
|
|
|
|
/// \brief Function to load configuration from a file.
|
|
/// \param[in] file path of the configuration file to be loaded.
|
|
bool load(std::string file);
|
|
|
|
} // namespace config
|
|
} // namespace dataset
|
|
} // namespace mindspore
|
|
|
|
#endif // MINDSPORE_CCSRC_MINDDATA_DATASET_INCLUDE_CONFIG_H
|