ray.tune.TuneConfig#

class ray.tune.TuneConfig(mode: str | None = None, metric: str | None = None, search_alg: Searcher | SearchAlgorithm | None = None, scheduler: TrialScheduler | None = None, num_samples: int = 1, max_concurrent_trials: int | None = None, time_budget_s: int | float | timedelta | None = None, reuse_actors: bool = False, trial_name_creator: Callable[[Trial], str] | None = None, trial_dirname_creator: Callable[[Trial], str] | None = None, chdir_to_trial_dir: bool = 'DEPRECATED')[源代码]#

基类:object

调整特定配置。

参数:
  • metric – 要优化的指标。此指标应通过 tune.report() 报告。如果设置,将传递给搜索算法和调度器。

  • mode – 必须是 [min, max] 之一。确定目标是最小化还是最大化指标属性。如果设置,将传递给搜索算法和调度器。

  • search_alg – 优化搜索算法。默认为随机搜索。

  • scheduler – 用于执行实验的调度器。可以选择 FIFO(默认)、MedianStopping、AsyncHyperBand、HyperBand 和 PopulationBasedTraining。更多选项请参考 ray.tune.schedulers。

  • num_samples – 从超参数空间采样的次数。默认为1。如果提供了 grid_search 作为参数,网格将被重复 num_samples 次。如果此值为 -1,则(实际上)无限生成样本,直到满足停止条件。

  • max_concurrent_trials – 最大并发运行试验次数。必须为非负数。如果为 None 或 0,则不会应用限制。这是通过将 search_alg 包装在 ConcurrencyLimiter 中实现的,因此如果 search_alg 已经是 ConcurrencyLimiter,则设置此参数将引发异常。默认为 None。

  • time_budget_s – 全局时间预算,单位为秒,超过此时间后所有试验将被停止。也可以是一个 datetime.timedelta 对象。

  • reuse_actors – 是否在不同试验之间尽可能重复使用演员。这可以大幅加快经常启动和停止演员的实验(例如,时间复用模式下的PBT)。这要求试验具有相同的资源需求。默认为 False

  • trial_name_creator – 可选函数,接收一个 Trial 并返回其名称(即其字符串表示)。请确保在每个试验的名称中包含一些唯一标识符(如 Trial.trial_id)。注意:此API处于alpha阶段,可能会发生变化。

  • trial_dirname_creator – 可选函数,接收一个试验并生成其试验目录名称作为字符串。请确保在每个试验的目录名称中包含一些唯一标识符(如 Trial.trial_id)。否则,试验可能会覆盖其他试验的工件和检查点。返回值不能是路径。注意:此API处于alpha阶段,可能会发生变化。

  • chdir_to_trial_dir – 已弃用。请设置 RAY_CHDIR_TO_TRIAL_DIR 环境变量代替。

PublicAPI (测试版): 此API目前处于测试阶段,在成为稳定版本之前可能会发生变化。

方法

属性

chdir_to_trial_dir

max_concurrent_trials

metric

mode

num_samples

reuse_actors

scheduler

search_alg

time_budget_s

trial_dirname_creator

trial_name_creator