ray.tune.ExperimentAnalysis#

class ray.tune.ExperimentAnalysis(experiment_checkpoint_path: str | PathLike, *, storage_filesystem: pyarrow.fs.FileSystem | None = None, trials: List[Trial] | None = None, default_metric: str | None = None, default_mode: str | None = None)[源代码]#

基类:object

分析来自 Ray Train/Tune 实验的结果。

要使用此类,运行必须将报告的指标历史记录存储在日志文件中(例如,result.jsonprogress.csv)。这是默认行为,除非使用 TUNE_DISABLE_AUTO_CALLBACK_LOGGERS=1 环境变量显式排除默认日志记录器。

参数:
  • experiment_checkpoint_path – 指向一个 experiment_state.json 文件的路径,或包含一个 experiment_state.json 文件的目录。

  • default_metric – 比较结果的默认指标。可以在相应函数的 metric 参数中覆盖。

  • default_mode – 比较结果的默认模式。必须是 [min, max] 之一。可以通过相应函数中的 mode 参数进行覆盖。

  • trials – 可以通过 analysis.trials 访问的试验列表。

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

方法

dataframe

返回一个从试验中构建的 pandas.DataFrame 对象。

get_all_configs

返回所有试验的超参数配置。

get_best_checkpoint

获取所提供试验的最佳持久检查点路径。

get_best_config

获取与试验相对应的最佳配置。

get_best_trial

获取最佳试验对象。

get_last_checkpoint

获取所提供试验的最后一个检查点,即具有最高“training_iteration”的检查点。

属性

best_checkpoint

获取实验中最佳试验的检查点路径

best_config

获取实验中最佳试验的配置

best_dataframe

获取实验中最佳试验的完整结果数据框

best_result

获取实验中最佳试验的最后结果

best_result_df

将实验的最佳结果作为 pandas 数据框获取。

best_trial

获得实验的最佳试验

experiment_path

指向持久存储上实验目录的路径。

results

获取实验所有试验的最后一个结果

results_df

将所有最后的结果作为 pandas 数据框获取。

trial_dataframes

所有试验数据框的列表。