diff options
Diffstat (limited to 'data/en_us/paiautoml/2022-08-28/api-docs.php')
| -rw-r--r-- | data/en_us/paiautoml/2022-08-28/api-docs.php | 4568 |
1 files changed, 1570 insertions, 2998 deletions
diff --git a/data/en_us/paiautoml/2022-08-28/api-docs.php b/data/en_us/paiautoml/2022-08-28/api-docs.php index 34c983d..e709e71 100644 --- a/data/en_us/paiautoml/2022-08-28/api-docs.php +++ b/data/en_us/paiautoml/2022-08-28/api-docs.php @@ -1,51 +1,7 @@ <?php return [ 'version' => '1.0', - 'info' => [ - 'style' => 'ROA', - 'product' => 'paiAutoML', - 'version' => '2022-08-28', - ], - 'directories' => [ - [ - 'id' => 267710, - 'title' => 'Service Association Role', - 'type' => 'directory', - 'children' => [ - 'GetServiceIdentityRole', - 'CreateServiceIdentityRole', - ], - ], - [ - 'id' => 190161, - 'title' => 'HPO', - 'type' => 'directory', - 'children' => [ - 'CreateHpoExperiment', - 'ListHpoExperiments', - 'GetHpoExperiment', - 'UpdateHpoExperiment', - 'StopHpoExperiment', - 'DeleteHpoExperiment', - 'ListHpoExperimentLogs', - 'ListHpoTrials', - 'GetHpoTrial', - 'StopHpoTrials', - 'RestartHpoTrials', - 'ListHpoTrialLogNames', - 'ListHpoTrialLogs', - 'ListHpoTrialCommands', - ], - ], - [ - 'id' => 267707, - 'title' => 'AutoFE', - 'type' => 'directory', - 'children' => [ - 'CreateAutofeExperiment', - 'GetAutofeExperiment', - ], - ], - ], + 'info' => ['style' => 'ROA', 'product' => 'paiAutoML', 'version' => '2022-08-28'], + 'directories' => ['CreateAutofeExperiment', 'CreateHpoExperiment', 'CreateServiceIdentityRole', 'DeleteHpoExperiment', 'GetAutofeExperiment', 'GetHpoExperiment', 'GetHpoTrial', 'GetServiceIdentityRole', 'ListHpoExperimentLogs', 'ListHpoExperiments', 'ListHpoTrialCommands', 'ListHpoTrialLogNames', 'ListHpoTrialLogs', 'ListHpoTrials', 'RestartHpoTrials', 'StopHpoExperiment', 'StopHpoTrials', 'UpdateHpoExperiment'], 'components' => [ 'schemas' => [ 'AutofeExperimentConfiguration' => [ @@ -60,52 +16,11 @@ 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'oss_bucket' => [ - 'title' => 'oss_bucket', - 'description' => 'The name of the OSS bucket.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'autofe-service', - 'backendName' => 'oss_bucket', - ], - 'oss_access_id' => [ - 'title' => 'oss_access_id', - 'description' => 'oss access id'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'required' => false, - 'example' => 'Ltx***yw', - 'backendName' => 'oss_access_id', - ], - 'oss_access_key' => [ - 'title' => 'oss_access_key', - 'description' => 'oss access key'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'required' => false, - 'example' => 'Tc***Mu', - 'backendName' => 'oss_access_key', - 'sensitive' => true, - ], - 'oss_role_arn' => [ - 'title' => 'oss_role_arn', - 'description' => 'The service-linked role for PAIAutoML. If this parameter is specified, AccessKey ID and Secret are not required.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'required' => false, - 'example' => 'acs:ram::xxx:role/aliyunserviceroleforpaiautoml'."\n", - 'backendName' => 'oss_role_arn', - ], - 'oss_endpoint' => [ - 'title' => 'oss_endpoint', - 'description' => 'oss endpoint'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'oss-cn-beijing.aliyuncs.com', - 'backendName' => 'oss_endpoint', - ], + 'oss_bucket' => ['title' => 'oss_bucket', 'description' => 'The name of the OSS bucket.'."\n", 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'autofe-service', 'backendName' => 'oss_bucket'], + 'oss_access_id' => ['title' => 'oss_access_id', 'description' => 'oss access id'."\n", 'visibility' => 'Public', 'type' => 'string', 'required' => false, 'example' => 'Ltx***yw', 'backendName' => 'oss_access_id'], + 'oss_access_key' => ['title' => 'oss_access_key', 'description' => 'oss access key'."\n", 'visibility' => 'Public', 'type' => 'string', 'required' => false, 'example' => 'Tc***Mu', 'backendName' => 'oss_access_key', 'sensitive' => true], + 'oss_role_arn' => ['title' => 'oss_role_arn', 'description' => 'The service-linked role for PAIAutoML. If this parameter is specified, AccessKey ID and Secret are not required.'."\n", 'visibility' => 'Public', 'type' => 'string', 'required' => false, 'example' => 'acs:ram::xxx:role/aliyunserviceroleforpaiautoml'."\n", 'backendName' => 'oss_role_arn'], + 'oss_endpoint' => ['title' => 'oss_endpoint', 'description' => 'oss endpoint'."\n", 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'oss-cn-beijing.aliyuncs.com', 'backendName' => 'oss_endpoint'], ], 'required' => true, 'backendName' => 'oss_config', @@ -116,58 +31,12 @@ 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'odps_region_id' => [ - 'title' => 'odps_region_id', - 'description' => 'The MaxCompute region ID.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-beijing', - 'backendName' => 'odps_region_id', - ], - 'odps_project_name' => [ - 'title' => 'odps_project_name', - 'description' => 'The name of the MaxCompute project.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'pai_rec', - 'backendName' => 'odps_project_name', - ], - 'odps_endpoint' => [ - 'title' => 'odps_endpoint', - 'description' => 'odps endpoint'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'http://service.cn-beijing.maxcompute.aliyun.com/api', - 'backendName' => 'odps_endpoint', - ], - 'odps_access_id' => [ - 'title' => 'odps_access_id', - 'description' => 'odps access id'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'Ltx***yw'."\n", - 'backendName' => 'odps_access_id', - ], - 'odps_access_key' => [ - 'title' => 'odps_access_key', - 'description' => 'odps access key'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'Tc***Mu'."\n", - 'backendName' => 'odps_access_key', - 'sensitive' => true, - ], - 'odps_role_arn' => [ - 'title' => 'odps_role_arn', - 'description' => 'The service-linked role for PAIAutoML. If this parameter is specified, AccessKey ID and Secret are not required.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'acs:ram::xxx:role/aliyunserviceroleforpaiautoml'."\n", - 'backendName' => 'odps_role_arn', - ], + 'odps_region_id' => ['title' => 'odps_region_id', 'description' => 'The MaxCompute region ID.'."\n", 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'cn-beijing', 'backendName' => 'odps_region_id'], + 'odps_project_name' => ['title' => 'odps_project_name', 'description' => 'The name of the MaxCompute project.'."\n", 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'pai_rec', 'backendName' => 'odps_project_name'], + 'odps_endpoint' => ['title' => 'odps_endpoint', 'description' => 'odps endpoint'."\n", 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'http://service.cn-beijing.maxcompute.aliyun.com/api', 'backendName' => 'odps_endpoint'], + 'odps_access_id' => ['title' => 'odps_access_id', 'description' => 'odps access id'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'Ltx***yw'."\n", 'backendName' => 'odps_access_id'], + 'odps_access_key' => ['title' => 'odps_access_key', 'description' => 'odps access key'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'Tc***Mu'."\n", 'backendName' => 'odps_access_key', 'sensitive' => true], + 'odps_role_arn' => ['title' => 'odps_role_arn', 'description' => 'The service-linked role for PAIAutoML. If this parameter is specified, AccessKey ID and Secret are not required.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'acs:ram::xxx:role/aliyunserviceroleforpaiautoml'."\n", 'backendName' => 'odps_role_arn'], ], 'required' => true, 'backendName' => 'odps_config', @@ -178,194 +47,29 @@ 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'workspace_name' => [ - 'title' => 'workspace_name', - 'description' => 'The name of the workspace.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'my_workspace_1', - 'backendName' => 'workspace_name', - ], - 'output_config_oss_dir' => [ - 'title' => 'output_config_oss_dir', - 'description' => 'The output path of the dynamic configurations.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'oss://bucket_name/folder/', - 'backendName' => 'output_config_oss_dir', - ], - 'label' => [ - 'title' => 'label', - 'description' => 'The name of the label column of the input data.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'is_click', - 'backendName' => 'label', - ], - 'data_source' => [ - 'title' => 'data_source', - 'description' => 'The name of the data source.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'pai_online_project.finance_record, oss://autofe-test/data/train.csv'."\n", - 'backendName' => 'data_source', - ], - 'data_type' => [ - 'title' => 'data_type', - 'description' => 'The type of the data.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'odps, oss', - 'backendName' => 'data_type', - ], - 'aggregate_only' => [ - 'title' => 'aggregate_only', - 'description' => 'Specifies whether to perform only aggregate data analysis. If you specify false, the four operations are also performed.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'true / false', - 'backendName' => 'aggregate_only', - ], - 'reuse_results' => [ - 'title' => 'reuse_results', - 'description' => 'Specifies whether to reuse the intermediate results.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'false', - 'backendName' => 'reuse_results', - ], - 'workers' => [ - 'title' => 'workers', - 'description' => 'The number of workers to be used in AutoFE.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '10', - 'backendName' => 'workers', - ], - 'memory' => [ - 'title' => 'memory', - 'description' => 'The memory usage of each worker in the experiment.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '4000', - 'backendName' => 'memory', - ], - 'cpu' => [ - 'title' => 'cpu', - 'description' => 'The CPU usage of each worker in the experiment.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '2', - 'backendName' => 'cpu', - ], - 'debug_mode' => [ - 'title' => 'debug_mode', - 'description' => 'Specifies whether to enable the debug mode.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'false', - 'backendName' => 'debug_mode', - ], - 'action' => [ - 'title' => 'action', - 'description' => 'The operations of the experiment. Valid values: `fs_train`, `train`, `analyze`, `pipeline`, `selection`, and `transform`.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'fs_train', - 'backendName' => 'action', - ], - 'sample_size' => [ - 'title' => 'sample_size', - 'description' => 'The number of data samples. This parameter is needed when the data size is too large.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '5000000', - 'backendName' => 'sample_size', - ], - 'analyze_exp_id' => [ - 'title' => 'analyze_exp_id', - 'description' => 'The ID of the feature analysis experiment. This parameter is used only if data analysis is already done. If AutoFE is performed for the first time, this parameter is not required.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 't2qz2opx', - 'backendName' => 'analyze_exp_id', - ], - 'data_partition' => [ - 'title' => 'data_partition', - 'description' => 'The data partition.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'ds=20230720', - 'backendName' => 'data_partition', - ], - 'exclude_columns' => [ - 'title' => 'exclude_columns', - 'description' => 'The name of the column to be ignored. For example, the ID columns or other columns not relevant to feature engineering.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'c1,c2,c3', - 'backendName' => 'exclude_columns', - ], - 'feature_selection' => [ - 'title' => 'feature_selection', - 'description' => 'Specifies whether to use the results of feature selection for feature analysis.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'true', - 'backendName' => 'feature_selection', - ], - 'selection_exp_id' => [ - 'title' => 'selection_exp_id', - 'description' => 'The ID of the feature selection experiment.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 't2qz2opx', - 'backendName' => 'selection_exp_id', - ], - 'pipeline_exp_id' => [ - 'title' => 'pipeline_exp_id', - 'description' => 'The ID of the pipeline training experiment.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 't2qz2opx', - 'backendName' => 'pipeline_exp_id', - ], - 'sample_ratio' => [ - 'title' => 'sample_ratio', - 'description' => 'The ratio of data samples. You can specify this parameter when the data size is too large.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '0.01', - 'backendName' => 'sample_ratio', - ], - 'filter_thresh' => [ - 'title' => 'filter_thresh', - 'description' => 'The filtering threshold of low frequency features.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '10', - 'backendName' => 'filter_thresh', - ], - 'skip_select' => [ - 'title' => 'skip_select', - 'description' => 'Specifies whether all original features are contained in the output.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'true', - 'backendName' => 'skip_select', - ], - 'iv_thresh' => [ - 'title' => 'iv_thresh', - 'description' => 'The information value threshold for feature selection. If the information value of a feature is lower than iv_thresh, the feature is filtered out. We recommend that you set this parameter to 0.02.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '0.02', - 'backendName' => 'iv_thresh', - ], + 'workspace_name' => ['title' => 'workspace_name', 'description' => 'The name of the workspace.'."\n", 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'my_workspace_1', 'backendName' => 'workspace_name'], + 'output_config_oss_dir' => ['title' => 'output_config_oss_dir', 'description' => 'The output path of the dynamic configurations.'."\n", 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'oss://bucket_name/folder/', 'backendName' => 'output_config_oss_dir'], + 'label' => ['title' => 'label', 'description' => 'The name of the label column of the input data.'."\n", 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'is_click', 'backendName' => 'label'], + 'data_source' => ['title' => 'data_source', 'description' => 'The name of the data source.'."\n", 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'pai_online_project.finance_record, oss://autofe-test/data/train.csv'."\n", 'backendName' => 'data_source'], + 'data_type' => ['title' => 'data_type', 'description' => 'The type of the data.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'odps, oss', 'backendName' => 'data_type'], + 'aggregate_only' => ['title' => 'aggregate_only', 'description' => 'Specifies whether to perform only aggregate data analysis. If you specify false, the four operations are also performed.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'true / false', 'backendName' => 'aggregate_only'], + 'reuse_results' => ['title' => 'reuse_results', 'description' => 'Specifies whether to reuse the intermediate results.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'false', 'backendName' => 'reuse_results'], + 'workers' => ['title' => 'workers', 'description' => 'The number of workers to be used in AutoFE.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => '10', 'backendName' => 'workers'], + 'memory' => ['title' => 'memory', 'description' => 'The memory usage of each worker in the experiment.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => '4000', 'backendName' => 'memory'], + 'cpu' => ['title' => 'cpu', 'description' => 'The CPU usage of each worker in the experiment.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => '2', 'backendName' => 'cpu'], + 'debug_mode' => ['title' => 'debug_mode', 'description' => 'Specifies whether to enable the debug mode.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'false', 'backendName' => 'debug_mode'], + 'action' => ['title' => 'action', 'description' => 'The operations of the experiment. Valid values: `fs_train`, `train`, `analyze`, `pipeline`, `selection`, and `transform`.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'fs_train', 'backendName' => 'action'], + 'sample_size' => ['title' => 'sample_size', 'description' => 'The number of data samples. This parameter is needed when the data size is too large.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => '5000000', 'backendName' => 'sample_size'], + 'analyze_exp_id' => ['title' => 'analyze_exp_id', 'description' => 'The ID of the feature analysis experiment. This parameter is used only if data analysis is already done. If AutoFE is performed for the first time, this parameter is not required.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 't2qz2opx', 'backendName' => 'analyze_exp_id'], + 'data_partition' => ['title' => 'data_partition', 'description' => 'The data partition.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'ds=20230720', 'backendName' => 'data_partition'], + 'exclude_columns' => ['title' => 'exclude_columns', 'description' => 'The name of the column to be ignored. For example, the ID columns or other columns not relevant to feature engineering.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'c1,c2,c3', 'backendName' => 'exclude_columns'], + 'feature_selection' => ['title' => 'feature_selection', 'description' => 'Specifies whether to use the results of feature selection for feature analysis.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'true', 'backendName' => 'feature_selection'], + 'selection_exp_id' => ['title' => 'selection_exp_id', 'description' => 'The ID of the feature selection experiment.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 't2qz2opx', 'backendName' => 'selection_exp_id'], + 'pipeline_exp_id' => ['title' => 'pipeline_exp_id', 'description' => 'The ID of the pipeline training experiment.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 't2qz2opx', 'backendName' => 'pipeline_exp_id'], + 'sample_ratio' => ['title' => 'sample_ratio', 'description' => 'The ratio of data samples. You can specify this parameter when the data size is too large.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => '0.01', 'backendName' => 'sample_ratio'], + 'filter_thresh' => ['title' => 'filter_thresh', 'description' => 'The filtering threshold of low frequency features.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => '10', 'backendName' => 'filter_thresh'], + 'skip_select' => ['title' => 'skip_select', 'description' => 'Specifies whether all original features are contained in the output.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'true', 'backendName' => 'skip_select'], + 'iv_thresh' => ['title' => 'iv_thresh', 'description' => 'The information value threshold for feature selection. If the information value of a feature is lower than iv_thresh, the feature is filtered out. We recommend that you set this parameter to 0.02.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => '0.02', 'backendName' => 'iv_thresh'], ], 'required' => true, 'backendName' => 'yml_config', @@ -389,19 +93,14 @@ 'description' => 'The source and destination paths of params_config.'."\n", 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'description' => 'The source and destination paths. The values are strings separated by commas.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => './local/path/foo.config,oss://bucket/remote/path/bar.config', - 'extendType' => 'true', - ], + 'items' => ['description' => 'The source and destination paths. The values are strings separated by commas.'."\n", 'visibility' => 'Public', 'type' => 'string', 'extendType' => 'true', 'example' => './local/path/foo.config,oss://bucket/remote/path/bar.config', 'title' => ''], 'example' => 'src_path,dst_file_path', 'backendName' => 'params_src_dst_filepath', 'itemName' => 'params_src_dst_filepath', ], ], 'backendName' => 'params_config', + 'example' => '', ], 'platform_config' => [ 'title' => 'platform_config', @@ -409,43 +108,24 @@ 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'name' => [ - 'title' => 'name of the computation platform', - 'description' => 'The name of the platform where the experiment is executed.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'DLC, MaxCompute,paiflow, etc', - 'backendName' => 'name', - ], + 'name' => ['title' => 'name of the computation platform', 'description' => 'The name of the platform where the experiment is executed.'."\n", 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'backendName' => 'name', 'example' => 'DLC, MaxCompute,paiflow, etc'], 'cmd' => [ 'title' => 'a list of commands to be executed', 'description' => 'The list of commands to be executed on the background computing platform.'."\n", 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'description' => 'The commands to be executed.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'pai -name kmeans -project foo -Dseed 1', - 'extendType' => 'true', - ], + 'items' => ['description' => 'The commands to be executed.'."\n", 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'extendType' => 'true', 'example' => 'pai -name kmeans -project foo -Dseed 1', 'title' => ''], 'required' => true, 'backendName' => 'cmd', 'itemName' => 'commands', + 'example' => '', ], - 'resume' => [ - 'title' => 'resume', - 'description' => 'Specifies whether to enable resume. For example, if the first line succeeds and the second line fails due to insufficient resources, you can enable resume to start from the second line.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '0/1'."\n", - 'backendName' => 'resume', - ], + 'resume' => ['title' => 'resume', 'description' => 'Specifies whether to enable resume. For example, if the first line succeeds and the second line fails due to insufficient resources, you can enable resume to start from the second line.'."\n", 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'resume', 'example' => '0/1。'."\n" + .'1表示启用。不填写不启用'], ], 'required' => true, 'backendName' => 'platform_config', + 'example' => '', ], 'metric_config' => [ 'title' => 'metric_config', @@ -453,61 +133,26 @@ 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'metric_type' => [ - 'title' => 'metric_type', - 'description' => 'The metric type of the user evaluation trial. Valid values: summary, table, json, stdout.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'table, summary, stdout or json'."\n", - 'backendName' => 'metric_type', - ], + 'metric_type' => ['title' => 'metric_type', 'description' => 'The metric type of the user evaluation trial. Valid values: summary, table, json, stdout.'."\n", 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'backendName' => 'metric_type', 'example' => 'table, summary, stdout或者json'], 'metric_source' => [ 'title' => 'metric_source', 'description' => 'metric_source'."\n", 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'description' => 'Source of the metric. For example, an OSS file path or an SQL statement to obtain the metric from a MaxCompute table.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'For \'table\', it is a MaxCompute language to generate the metric, e.g., select count(*) as cnt from nni_test1_${exp_id}_${trial_id};'."\n" - .'For \'summary\', it is path of the summary file, e.g., oss://test-nni/examples/search/pai/metric/metric_${exp_id}_${trial_id}/'."\n" - .'for \'stdout\', it refers to the command to get the metric, e.g., cmd1', - 'extendType' => 'true', - ], + 'items' => ['description' => 'Source of the metric. For example, an OSS file path or an SQL statement to obtain the metric from a MaxCompute table.'."\n", 'visibility' => 'Public', 'type' => 'string', 'extendType' => 'true', 'example' => '对于table类型，为从Table获取metric的MaxCompute语句，如：select count(*) as cnt from nni_test1_${exp_id}_${trial_id};'."\n" + .'对于summary类型，为summary所在路径，如：oss://test-nni/examples/search/pai/metric/metric_${exp_id}_${trial_id}/'."\n" + .'对于stdout类型，为从那一条cmd抽取metric，如：cmd1 （序号从1开始）', 'title' => ''], 'required' => true, 'backendName' => 'metric_source', + 'example' => '', ], - 'final_mode' => [ - 'title' => 'final_mode', - 'description' => 'Specifies how to calculate the final metric from the intermediate metrics. Valid values: final, best, avg.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'final, best, avg', - 'backendName' => 'final_mode', - ], - 'metric_dict' => [ - 'title' => 'metric_dict', - 'description' => 'The name and weight of metrics. Use this parameter if you need to consider multiple metrics at the same time. Note: The weight can be negative, and the sum of the weights is not necessarily 1.'."\n", - 'visibility' => 'Public', - 'type' => 'object', - 'required' => true, - 'example' => '{\'auc\':0.25, \'recall\':0.5, \'precision\':0.25}', - 'backendName' => 'metric_dict', - ], - 'source_list_final_mode' => [ - 'title' => 'source_list_final_mode', - 'description' => 'Specifies how to calculate the final metric if multiple metric sources are used. Optional. Default value: final_mode. Valid values: final, best, and avg.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'avg', - 'backendName' => 'source_list_final_mode', - ], + 'final_mode' => ['title' => 'final_mode', 'description' => 'Specifies how to calculate the final metric from the intermediate metrics. Valid values: final, best, avg.'."\n", 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'backendName' => 'final_mode', 'example' => 'final, best, avg'], + 'metric_dict' => ['title' => 'metric_dict', 'description' => 'The name and weight of metrics. Use this parameter if you need to consider multiple metrics at the same time. Note: The weight can be negative, and the sum of the weights is not necessarily 1.'."\n", 'visibility' => 'Public', 'type' => 'object', 'required' => true, 'backendName' => 'metric_dict', 'example' => '{\'auc\':0.25, \'recall\':0.5, \'precision\':0.25}'], + 'source_list_final_mode' => ['title' => 'source_list_final_mode', 'description' => 'Specifies how to calculate the final metric if multiple metric sources are used. Optional. Default value: final_mode. Valid values: final, best, and avg.'."\n", 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'source_list_final_mode', 'example' => 'avg'], ], 'required' => true, 'backendName' => 'metric_config', + 'example' => '', ], 'oss_config' => [ 'title' => 'oss_config', @@ -515,41 +160,13 @@ 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'endpoint' => [ - 'title' => 'endpoint', - 'description' => 'endpoint'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'http://oss-cn-beijing.aliyuncs.com', - 'backendName' => 'endpoint', - ], - 'accessKeyID' => [ - 'title' => 'accessKeyID', - 'description' => 'accessKeyID'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'ak string', - 'backendName' => 'accessKeyID', - ], - 'accessKeySecret' => [ - 'title' => 'accessKeySecret', - 'description' => 'accessKeySecret'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'sk string', - 'backendName' => 'accessKeySecret', - 'sensitive' => true, - ], - 'role_arn' => [ - 'title' => 'role_arn', - 'description' => 'The service-linked role for PAIAutoML. If this parameter is specified, AccessKey ID and Secret are not required.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'acs:ram::xxx:role/aliyunserviceroleforpaiautoml'."\n", - 'backendName' => 'role_arn', - ], + 'endpoint' => ['title' => 'endpoint', 'description' => 'endpoint'."\n", 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'endpoint', 'example' => 'http://oss-cn-beijing.aliyuncs.com'], + 'accessKeyID' => ['title' => 'accessKeyID', 'description' => 'accessKeyID'."\n", 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'accessKeyID', 'example' => 'ak字符串'], + 'accessKeySecret' => ['title' => 'accessKeySecret', 'description' => 'accessKeySecret'."\n", 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'accessKeySecret', 'sensitive' => true, 'example' => 'sk字符串'], + 'role_arn' => ['title' => 'role_arn', 'description' => 'The service-linked role for PAIAutoML. If this parameter is specified, AccessKey ID and Secret are not required.'."\n", 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'role_arn', 'example' => 'acs:ram::xxx:role/aliyunserviceroleforpaiautoml'], ], 'backendName' => 'oss_config', + 'example' => '', ], 'odps_config' => [ 'title' => 'odps_config', @@ -557,65 +174,16 @@ 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'access_id' => [ - 'title' => 'access_id', - 'description' => 'access_id'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'ak string'."\n", - 'backendName' => 'access_id', - ], - 'access_key' => [ - 'title' => 'access_key', - 'description' => 'access_key'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'sk string'."\n", - 'backendName' => 'access_key', - 'sensitive' => true, - ], - 'project_name' => [ - 'title' => 'project_name', - 'description' => 'The name of the MaxCompute project.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'my_project_x', - 'backendName' => 'project_name', - ], - 'end_point' => [ - 'title' => 'end_point', - 'description' => 'end_point'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'http://service.cn-beijing.maxcompute.aliyun.com/api', - 'backendName' => 'end_point', - ], - 'log_view_host' => [ - 'title' => 'log_view_host', - 'description' => 'log_view_host'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'http://logview.odps.aliyun.com', - 'backendName' => 'log_view_host', - ], - 'region' => [ - 'title' => 'region', - 'description' => 'region'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'cn-hangzhou', - 'backendName' => 'region', - ], - 'role_arn' => [ - 'title' => 'role_arn', - 'description' => 'The service-linked role for PAIAutoML. If this parameter is specified, AccessKey ID and Secret are not required.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'acs:ram::xxx:role/aliyunserviceroleforpaiautoml'."\n", - 'backendName' => 'role_arn', - ], + 'access_id' => ['title' => 'access_id', 'description' => 'access_id'."\n", 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'access_id', 'example' => 'ak字符串'], + 'access_key' => ['title' => 'access_key', 'description' => 'access_key'."\n", 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'access_key', 'sensitive' => true, 'example' => 'sk字符串'], + 'project_name' => ['title' => 'project_name', 'description' => 'The name of the MaxCompute project.'."\n", 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'project_name', 'example' => 'my_project_x'], + 'end_point' => ['title' => 'end_point', 'description' => 'end_point'."\n", 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'end_point', 'example' => 'http://service.cn-beijing.maxcompute.aliyun.com/api'], + 'log_view_host' => ['title' => 'log_view_host', 'description' => 'log_view_host'."\n", 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'log_view_host', 'example' => 'http://logview.odps.aliyun.com'], + 'region' => ['title' => 'region', 'description' => 'region'."\n", 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'region', 'example' => 'cn-hangzhou / cn-beijing / cn-shanghai / cn-shenzhen / cn-hongkong'], + 'role_arn' => ['title' => 'role_arn', 'description' => 'The service-linked role for PAIAutoML. If this parameter is specified, AccessKey ID and Secret are not required.'."\n", 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'role_arn', 'example' => 'acs:ram::xxx:role/aliyunserviceroleforpaiautoml'."\n"], ], 'backendName' => 'odps_config', + 'example' => '', ], 'ts_config' => [ 'title' => 'ts_config', @@ -623,41 +191,13 @@ 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'access_key_id' => [ - 'title' => 'access_key_id', - 'description' => 'access_key_id'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'ak string', - 'backendName' => 'access_key_id', - ], - 'access_key_secret' => [ - 'title' => 'access_key_secret', - 'description' => 'access_key_secret'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'sk string', - 'backendName' => 'access_key_secret', - 'sensitive' => true, - ], - 'region_id' => [ - 'title' => 'region_id', - 'description' => 'region_id'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'cn-hangzhou / cn-beijing / cn-shanghai / cn-shenzhen / cn-hongkong', - 'backendName' => 'region_id', - ], - 'endpoint' => [ - 'title' => 'endpoint', - 'description' => 'endpoint'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'pai.cn-shanghai.aliyuncs.com', - 'backendName' => 'endpoint', - ], + 'access_key_id' => ['title' => 'access_key_id', 'description' => 'access_key_id'."\n", 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'access_key_id', 'example' => 'ak字符串'], + 'access_key_secret' => ['title' => 'access_key_secret', 'description' => 'access_key_secret'."\n", 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'access_key_secret', 'sensitive' => true, 'example' => 'sk字符串'], + 'region_id' => ['title' => 'region_id', 'description' => 'region_id'."\n", 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'region_id', 'example' => 'cn-hangzhou / cn-beijing / cn-shanghai / cn-shenzhen / cn-hongkong'."\n"], + 'endpoint' => ['title' => 'endpoint', 'description' => 'endpoint'."\n", 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'endpoint', 'example' => 'pai.cn-shanghai.aliyuncs.com'], ], 'backendName' => 'ts_config', + 'example' => '', ], 'paiflow_config' => [ 'title' => 'paiflow_config', @@ -665,41 +205,13 @@ 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'access_key_id' => [ - 'title' => 'access_key_id', - 'description' => 'access_key_id'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'ak string', - 'backendName' => 'access_key_id', - ], - 'access_key_secret' => [ - 'title' => 'access_key_secret', - 'description' => 'access_key_secret'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'sk string', - 'backendName' => 'access_key_secret', - 'sensitive' => true, - ], - 'region_id' => [ - 'title' => 'region_id', - 'description' => 'region_id'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'cn-hangzhou / cn-beijing / cn-shanghai / cn-shenzhen / cn-hongkong', - 'backendName' => 'region_id', - ], - 'workspace_id' => [ - 'title' => 'workspace_id', - 'description' => 'The ID of the PAI workspace.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '12345', - 'backendName' => 'workspace_id', - ], + 'access_key_id' => ['title' => 'access_key_id', 'description' => 'access_key_id'."\n", 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'access_key_id', 'example' => 'ak字符串'], + 'access_key_secret' => ['title' => 'access_key_secret', 'description' => 'access_key_secret'."\n", 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'access_key_secret', 'sensitive' => true, 'example' => 'sk字符串'], + 'region_id' => ['title' => 'region_id', 'description' => 'region_id'."\n", 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'region_id', 'example' => 'cn-hangzhou / cn-beijing / cn-shanghai / cn-shenzhen / cn-hongkong'."\n"], + 'workspace_id' => ['title' => 'workspace_id', 'description' => 'The ID of the PAI workspace.'."\n", 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'workspace_id', 'example' => '12345'], ], 'backendName' => 'paiflow_config', + 'example' => '', ], 'yml_config' => [ 'title' => 'yml_config', @@ -707,195 +219,70 @@ 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'trial_concurrency' => [ - 'title' => 'trialConcurrency', - 'description' => 'The maximum number of concurrent trials.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '5', - 'backendName' => 'trialConcurrency', - ], - 'max_trial_number' => [ - 'title' => 'maxTrialNumber', - 'description' => 'The maximum number of trials for an experiment. Note that the experiment may end before all trials are run.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - 'backendName' => 'maxTrialNumber', - ], - 'experiment_name' => [ - 'title' => 'experiment_name', - 'description' => 'The name of the experiment.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'my_hpo_exp_3', - 'backendName' => 'experiment_name', - ], + 'trial_concurrency' => ['title' => 'trialConcurrency', 'description' => 'The maximum number of concurrent trials.'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int32', 'backendName' => 'trialConcurrency', 'example' => '5'], + 'max_trial_number' => ['title' => 'maxTrialNumber', 'description' => 'The maximum number of trials for an experiment. Note that the experiment may end before all trials are run.'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int32', 'backendName' => 'maxTrialNumber', 'example' => '20'], + 'experiment_name' => ['title' => 'experiment_name', 'description' => 'The name of the experiment.'."\n", 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'experiment_name', 'example' => 'my_hpo_exp_3'], 'tuner' => [ 'title' => 'tuner', 'description' => 'The HPO algorithm.'."\n", 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'name' => [ - 'title' => 'name', - 'description' => 'The name of the HPO algorithm.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'TPE', - 'backendName' => 'name', - ], - 'class_args' => [ - 'title' => 'class_args', - 'description' => 'The parameters of the HPO algorithm.'."\n", - 'visibility' => 'Public', - 'type' => 'object', - 'backendName' => 'class_args', - 'example' => '', - ], + 'name' => ['title' => 'name', 'description' => 'The name of the HPO algorithm.'."\n", 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'name', 'example' => 'TPE'], + 'class_args' => ['title' => 'class_args', 'description' => 'The parameters of the HPO algorithm.'."\n", 'visibility' => 'Public', 'type' => 'object', 'backendName' => 'class_args', 'example' => ''], ], 'backendName' => 'tuner', + 'example' => '', ], - 'debug' => [ - 'title' => 'debug', - 'description' => 'Specifies whether to debug.'."\n", - 'visibility' => 'Public', - 'type' => 'boolean', - 'example' => 'true', - 'backendName' => 'debug', - ], - 'log_level' => [ - 'title' => 'log_level', - 'description' => 'The log level.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'debug', - 'backendName' => 'log_level', - ], + 'debug' => ['title' => 'debug', 'description' => 'Specifies whether to debug.'."\n", 'visibility' => 'Public', 'type' => 'boolean', 'backendName' => 'debug', 'example' => 'false/true'], + 'log_level' => ['title' => 'log_level', 'description' => 'The log level.'."\n", 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'log_level', 'example' => 'debug'], 'assessor' => [ 'title' => 'assessor', 'description' => 'assessor'."\n", 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'name' => [ - 'title' => 'name', - 'description' => 'The name of the class used for evaluation.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'PAIAssessor', - 'backendName' => 'name', - ], + 'name' => ['title' => 'name', 'description' => 'The name of the class used for evaluation.'."\n", 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'name', 'example' => 'PAIAssessor'], 'class_args' => [ 'title' => 'class_args', 'description' => 'class_args'."\n", 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'proportion' => [ - 'title' => 'proportion', - 'description' => 'The proportion of the optimal value of this hyperparameter search to the historical value.'."\n", - 'visibility' => 'Public', - 'type' => 'number', - 'format' => 'float', - 'example' => '0.5', - 'backendName' => 'proportion', - ], - 'start_step' => [ - 'title' => 'start_step', - 'description' => 'The step from which EarlyStop can be triggered.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - 'backendName' => 'start_step', - ], - 'moving_avg' => [ - 'title' => 'moving_avg', - 'description' => 'Specifies whether to use the average moving of all history to determine EarlyStop.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'true', - 'backendName' => 'moving_avg', - ], - 'optimize_mode' => [ - 'title' => 'optimize_mode', - 'description' => 'The optimization mode.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'maximize', - 'backendName' => 'optimize_mode', - ], - 'earlystop' => [ - 'title' => 'earlystop', - 'description' => 'Specifies whether to enable EarlyStop.'."\n", - 'visibility' => 'Public', - 'type' => 'boolean', - 'example' => 'True, False', - 'backendName' => 'earlystop', - ], + 'proportion' => ['title' => 'proportion', 'description' => 'The proportion of the optimal value of this hyperparameter search to the historical value.'."\n", 'visibility' => 'Public', 'type' => 'number', 'format' => 'float', 'backendName' => 'proportion', 'example' => '0.5'], + 'start_step' => ['title' => 'start_step', 'description' => 'The step from which EarlyStop can be triggered.'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int32', 'backendName' => 'start_step', 'example' => '2'], + 'moving_avg' => ['title' => 'moving_avg', 'description' => 'Specifies whether to use the average moving of all history to determine EarlyStop.'."\n", 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'moving_avg', 'example' => 'true'], + 'optimize_mode' => ['title' => 'optimize_mode', 'description' => 'The optimization mode.'."\n", 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'optimize_mode', 'example' => 'maximize/minimize'], + 'earlystop' => ['title' => 'earlystop', 'description' => 'Specifies whether to enable EarlyStop.'."\n", 'visibility' => 'Public', 'type' => 'boolean', 'backendName' => 'earlystop', 'example' => 'True, False'], ], 'backendName' => 'class_args', + 'example' => '', ], ], 'backendName' => 'assessor', + 'example' => '', ], ], 'backendName' => 'yml_config', + 'example' => '', ], - 'search_space' => [ - 'title' => 'search_space', - 'description' => 'The search space of the hyperparameter. The value is a JSON string.'."\n", - 'visibility' => 'Public', - 'type' => 'object', - 'example' => '{'."\n" - .' "${tree_count}":{"_type":"choice","_value":[5,10,3]},'."\n" - .' "${max_depth}":{"_type":"randint","_value":[3,6]}'."\n" - .'}', - 'backendName' => 'search_space', - ], + 'search_space' => ['title' => 'search_space', 'description' => 'The search space of the hyperparameter. The value is a JSON string.'."\n", 'visibility' => 'Public', 'type' => 'object', 'backendName' => 'search_space', 'example' => '{'."\n" + .' "${tree_count}":{"_type":"choice","_value":[5,10,3]},'."\n" + .' "${max_depth}":{"_type":"randint","_value":[3,6]}'."\n" + .'}'], 'k8s_config' => [ 'title' => 'k8s_config', 'description' => 'No configuration required.'."\n", 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'nni_container_requested_memory' => [ - 'title' => 'nni_container_requested_memory', - 'description' => 'nni_container_requested_memory'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'no need to set', - 'backendName' => 'nni_container_requested_memory', - ], - 'nni_container_requested_cpu' => [ - 'title' => 'nni_container_requested_cpu', - 'description' => 'nni_container_requested_cpu'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'no need to set', - 'backendName' => 'nni_container_requested_cpu', - ], - 'nni_container_memory_limit' => [ - 'title' => 'nni_container_memory_limit', - 'description' => 'nni_container_memory_limit'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'no need to set', - 'backendName' => 'nni_container_memory_limit', - ], - 'nni_container_cpu_limit' => [ - 'title' => 'nni_container_cpu_limit', - 'description' => 'nni_container_cpu_limit'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'no need to set', - 'backendName' => 'nni_container_cpu_limit', - ], + 'nni_container_requested_memory' => ['title' => 'nni_container_requested_memory', 'description' => 'nni_container_requested_memory'."\n", 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'nni_container_requested_memory', 'example' => '不需要配置'], + 'nni_container_requested_cpu' => ['title' => 'nni_container_requested_cpu', 'description' => 'nni_container_requested_cpu'."\n", 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'nni_container_requested_cpu', 'example' => '不需要配置'], + 'nni_container_memory_limit' => ['title' => 'nni_container_memory_limit', 'description' => 'nni_container_memory_limit'."\n", 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'nni_container_memory_limit', 'example' => '不需要配置'], + 'nni_container_cpu_limit' => ['title' => 'nni_container_cpu_limit', 'description' => 'nni_container_cpu_limit'."\n", 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'nni_container_cpu_limit', 'example' => '不需要配置'], ], 'backendName' => 'k8s_config', + 'example' => '', ], 'dlc_config' => [ 'title' => 'dlc_config', @@ -903,49 +290,14 @@ 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'access_id' => [ - 'title' => 'access_id', - 'description' => 'access_id'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'ak string', - 'backendName' => 'access_id', - ], - 'access_key' => [ - 'title' => 'access_key', - 'description' => 'access_key'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'sk string', - 'backendName' => 'access_key', - 'sensitive' => true, - ], - 'endpoint' => [ - 'title' => 'endpoint', - 'description' => 'endpoint'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'pai-dlc.cn-shanghai.aliyuncs.com', - 'backendName' => 'endpoint', - ], - 'region' => [ - 'title' => 'region', - 'description' => 'region'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'cn-hangzhou / cn-beijing / cn-shanghai / cn-shenzhen / cn-hongkong', - 'backendName' => 'region', - ], - 'protocol' => [ - 'title' => 'protocol', - 'description' => 'protocol'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'https', - 'backendName' => 'protocol', - ], + 'access_id' => ['title' => 'access_id', 'description' => 'access_id'."\n", 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'access_id', 'example' => 'ak字符串'], + 'access_key' => ['title' => 'access_key', 'description' => 'access_key'."\n", 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'access_key', 'sensitive' => true, 'example' => 'sk字符串'], + 'endpoint' => ['title' => 'endpoint', 'description' => 'endpoint'."\n", 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'endpoint', 'example' => 'pai-dlc.cn-shanghai.aliyuncs.com'], + 'region' => ['title' => 'region', 'description' => 'region'."\n", 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'region', 'example' => 'cn-hangzhou / cn-beijing / cn-shanghai / cn-shenzhen / cn-hongkong'."\n"], + 'protocol' => ['title' => 'protocol', 'description' => 'protocol'."\n", 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'protocol', 'example' => 'https'], ], 'backendName' => 'dlc_config', + 'example' => '', ], 'schedule_config' => [ 'title' => 'schedule_config', @@ -953,32 +305,12 @@ 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'day' => [ - 'title' => 'day', - 'description' => 'day'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'everyday', - 'backendName' => 'day', - ], - 'start_time' => [ - 'title' => 'start_time', - 'description' => 'start_time'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '11:10', - 'backendName' => 'start_time', - ], - 'end_time' => [ - 'title' => 'end_time', - 'description' => 'end_time'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '23:56', - 'backendName' => 'end_time', - ], + 'day' => ['title' => 'day', 'description' => 'day'."\n", 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'day', 'example' => 'everyday'], + 'start_time' => ['title' => 'start_time', 'description' => 'start_time'."\n", 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'start_time', 'example' => '11:10'], + 'end_time' => ['title' => 'end_time', 'description' => 'end_time'."\n", 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'end_time', 'example' => '23:56'], ], 'backendName' => 'schedule_config', + 'example' => '', ], 'monitor_config' => [ 'title' => 'monitor_config', @@ -986,50 +318,15 @@ 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'url' => [ - 'title' => 'url', - 'description' => 'The Webhook URL of the custom robot.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'https://oapi.dingtalk.com/robot/send?access_token=${UID}', - 'backendName' => 'url', - ], - 'keyword' => [ - 'title' => 'keyword', - 'description' => 'The custom keyword for the custom robot.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'monitor', - 'backendName' => 'keyword', - ], - 'at_mobiles' => [ - 'title' => 'at_mobiles', - 'description' => 'The phone number of the group member to be @ mentioned. Phone numbers of non-members are de-identified.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '[1472583690]', - 'backendName' => 'at_mobiles', - 'itemName' => 'atMobiles', - ], - 'at_user_ids' => [ - 'title' => 'at_user_ids', - 'description' => 'The userid of the member to be @ mentioned.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '[1234567890]', - 'backendName' => 'at_user_ids', - 'itemName' => 'atUserIds', - ], - 'is_at_all' => [ - 'title' => 'is_at_all', - 'description' => 'Specifies whether to @ mention everyone.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'False', - 'backendName' => 'is_at_all', - ], + 'url' => ['title' => 'url', 'description' => 'The Webhook URL of the custom robot.'."\n", 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'url', 'example' => 'https://oapi.dingtalk.com/robot/send?access_token=${UID}'."\n" + .'参考https://open.dingtalk.com/document/robots/custom-robot-access去添加自定义机器人，获取url'], + 'keyword' => ['title' => 'keyword', 'description' => 'The custom keyword for the custom robot.'."\n", 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'keyword', 'example' => 'monitor'], + 'at_mobiles' => ['title' => 'at_mobiles', 'description' => 'The phone number of the group member to be @ mentioned. Phone numbers of non-members are de-identified.'."\n", 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'at_mobiles', 'itemName' => 'atMobiles', 'example' => '[1472583690]'], + 'at_user_ids' => ['title' => 'at_user_ids', 'description' => 'The userid of the member to be @ mentioned.'."\n", 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'at_user_ids', 'itemName' => 'atUserIds', 'example' => '[1234567890]'], + 'is_at_all' => ['title' => 'is_at_all', 'description' => 'Specifies whether to @ mention everyone.'."\n", 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'is_at_all', 'example' => 'True/False'], ], 'backendName' => 'monitor_config', + 'example' => '', ], 'output_config' => [ 'title' => 'output_config', @@ -1037,138 +334,75 @@ 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'model_path' => [ - 'title' => 'model_path', - 'description' => 'If you use the Service Edition, you can configure model_path to obtain the optimal model.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'oss://bucket/foo/bar/model/model_${exp_id}_${trial_id}', - 'backendName' => 'model_path', - ], - 'summary_path' => [ - 'title' => 'summary_path', - 'description' => 'If you use the Standalone Edition, you can configure a summary to view TensorBoard locally.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'oss://bucket/foo/bar/model_${exp_id}_${trial_id}/', - 'backendName' => 'summary_path', - ], + 'model_path' => ['title' => 'model_path', 'description' => 'If you use the Service Edition, you can configure model_path to obtain the optimal model.'."\n", 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'model_path', 'example' => 'oss://bucket/foo/bar/model/model_${exp_id}_${trial_id}'], + 'summary_path' => ['title' => 'summary_path', 'description' => 'If you use the Standalone Edition, you can configure a summary to view TensorBoard locally.'."\n", 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'summary_path', 'example' => 'oss://bucket/foo/bar/model_${exp_id}_${trial_id}/'], ], 'backendName' => 'output_config', + 'example' => '', ], ], + 'example' => '', ], ], ], 'apis' => [ - 'GetServiceIdentityRole' => [ - 'summary' => 'GetServiceIdentityRole, return role name if SLR exists, empty otherwise', - 'path' => '/api/automl/v1/serviceidentityrole', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'CreateAutofeExperiment' => [ + 'path' => '/api/automl/v1/autofe/experiment', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '190053', - 'abilityTreeNodes' => [ - 'FEATURElearn0UHCCK', - ], - 'tenantRelevance' => 'publicInformation', + 'abilityTreeCode' => '162654', + 'abilityTreeNodes' => ['FEATURElearn0UHCCK'], ], - 'parameters' => [], - 'responses' => [ - 200 => [ + 'parameters' => [ + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The request body.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the POP request.'."\n", - 'type' => 'string', - 'example' => '3F190916-B3E5-5D1E-AD0C-35C0DF105F51', - ], - 'RoleName' => [ - 'description' => 'The name of the RAM role.'."\n", - 'type' => 'string', - 'example' => 'AliyunServiceRoleForPaiAutoml', - ], - 'Code' => [ - 'description' => 'The internal error code. This parameter is returned if an exception occurred.'."\n", - 'type' => 'string', - 'example' => 'SUCCESS', - ], - 'Message' => [ - 'description' => 'The error message. This parameter is returned if an exception occurred.'."\n", - 'type' => 'string', - 'example' => 'Execution failure, please try again.', + 'Name' => ['description' => 'The name of the experiment.'."\n", 'type' => 'string', 'required' => true, 'example' => 'my experiment x'], + 'AutofeExperimentConfiguration' => ['description' => 'The AutoFE experiment required configurations.', 'required' => false, '$ref' => '#/components/schemas/AutofeExperimentConfiguration'], + 'Description' => ['description' => 'The description of the experiment.'."\n", 'type' => 'string', 'required' => false, 'example' => 'This is an AutoFE experiment.'], + 'Accessibility' => ['description' => 'The visibility of the experiment in the workspace. Valid values:'."\n" + ."\n" + .'* PRIVATE: The experiment is visible only to you and the administrator of the workspace.'."\n" + .'* PUBLIC: The experiment is public in the workspace.'."\n", 'type' => 'string', 'required' => false, 'example' => 'PUBLIC'], + 'WorkspaceId' => ['description' => 'The workspace ID.'."\n", 'type' => 'string', 'required' => false, 'example' => '283301'], + 'Tag' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => ['type' => 'string', 'required' => false, 'description' => 'The key of the tag.'."\n", 'example' => 'group'], + 'Value' => ['type' => 'string', 'required' => false, 'description' => 'The value of the tag.', 'example' => 'group_name'], + ], + 'required' => false, + 'description' => 'The tag list.', + ], + 'required' => false, + 'maxItems' => 20, + 'description' => 'The list of tags. You can specify a maximum of 20 tags.'."\n", ], ], + 'required' => false, ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'eventInfo' => [ - 'enable' => false, - 'eventNames' => [], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3F190916-B3E5-5D1E-AD0C-35C0DF105F51\\",\\n \\"RoleName\\": \\"AliyunServiceRoleForPaiAutoml\\",\\n \\"Code\\": \\"SUCCESS\\",\\n \\"Message\\": \\"Execution failure, please try again.\\"\\n}","type":"json"}]', - 'title' => 'GetServiceIdentityRole', - ], - 'CreateServiceIdentityRole' => [ - 'summary' => 'Creates a service-linked role.', - 'path' => '/api/automl/v1/serviceidentityrole', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '190056', - 'abilityTreeNodes' => [ - 'FEATURElearn0UHCCK', - ], - 'tenantRelevance' => 'publicInformation', - ], - 'parameters' => [], 'responses' => [ 200 => [ 'schema' => [ @@ -1176,62 +410,33 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '3F190916-B3E5-5D1E-AD0C-35C0DF105F51', - ], - 'Code' => [ - 'description' => 'The internal error code. This parameter is returned if an exception occurred.'."\n", - 'type' => 'string', - 'example' => 'ExecutionFailure', - ], - 'Message' => [ - 'description' => 'The error message. This parameter is returned if an exception occurred.'."\n", - 'type' => 'string', - 'example' => 'Execution failure, please try again.', - ], - 'RoleName' => [ - 'description' => 'The name of the role.'."\n", - 'type' => 'string', - 'example' => 'AliyunServiceRoleForPaiAutoml', - ], + 'Message' => ['description' => 'The error message. This parameter is returned if an exception occurred.'."\n", 'type' => 'string', 'example' => 'Missing \'user_id\' in request.'], + 'Code' => ['description' => 'The internal error code. This parameter is returned if an exception occurred.'."\n", 'type' => 'string', 'example' => 'INVALID_INPUT_PARAMS'], + 'ExperimentId' => ['description' => 'The ID of the experiment.'."\n", 'type' => 'string', 'example' => 't8cNdMO'], + 'RequestId' => ['description' => 'The ID of the POP request.'."\n", 'type' => 'string', 'example' => '22A1EC4E-15A2-51FF-BFA3-10D6735BAA69'], + 'Detail' => ['description' => 'The detailed information about the request error.'."\n", 'type' => 'object', 'example' => '{}'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'eventInfo' => [ - 'enable' => false, - 'eventNames' => [], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3F190916-B3E5-5D1E-AD0C-35C0DF105F51\\",\\n \\"Code\\": \\"ExecutionFailure\\",\\n \\"Message\\": \\"Execution failure, please try again.\\",\\n \\"RoleName\\": \\"AliyunServiceRoleForPaiAutoml\\"\\n}","type":"json"}]', - 'title' => 'CreateServiceIdentityRole', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"Missing \'user_id\' in request.\\",\\n \\"Code\\": \\"INVALID_INPUT_PARAMS\\",\\n \\"ExperimentId\\": \\"t8cNdMO\\",\\n \\"RequestId\\": \\"22A1EC4E-15A2-51FF-BFA3-10D6735BAA69\\",\\n \\"Detail\\": {}\\n}","type":"json"}]', + 'title' => 'CreateAutofeExperiment', + 'summary' => 'CreateAutofeExperiment', + 'translator' => 'machine', ], 'CreateHpoExperiment' => [ 'summary' => 'calling HPO CreateExperiment', 'path' => '/api/automl/v1/hpo/experiment', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ @@ -1239,9 +444,7 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '162681', - 'abilityTreeNodes' => [ - 'FEATURElearnVYA4L9', - ], + 'abilityTreeNodes' => ['FEATURElearnVYA4L9'], ], 'parameters' => [ [ @@ -1252,38 +455,14 @@ 'description' => 'The request body.'."\n", 'type' => 'object', 'properties' => [ - 'HpoExperimentConfiguration' => [ - 'description' => 'The parameter struct of the HPO experiment configuration.'."\n", - 'required' => false, - '$ref' => '#/components/schemas/HpoExperimentConfig', - ], - 'Name' => [ - 'description' => 'The name of the experiment.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'my experiment x', - ], - 'WorkspaceId' => [ - 'description' => 'The workspace ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'default', - ], - 'Description' => [ - 'description' => 'The description of the experiment.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'This is an AutoML HPO experiment.', - ], - 'Accessibility' => [ - 'description' => 'The visibility of the code configuration. Valid values:'."\n" - ."\n" - .'* PUBLIC: The configuration is public in the workspace.'."\n" - .'* PRIVATE: The configuration is visible only to you and the administrator of the workspace.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'PRIVATE', - ], + 'HpoExperimentConfiguration' => ['description' => 'The parameter struct of the HPO experiment configuration.'."\n", 'required' => false, '$ref' => '#/components/schemas/HpoExperimentConfig', 'title' => '', 'example' => ''], + 'Name' => ['description' => 'The name of the experiment.'."\n", 'type' => 'string', 'required' => false, 'example' => 'my experiment x', 'title' => ''], + 'WorkspaceId' => ['description' => 'The workspace ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'default', 'title' => ''], + 'Description' => ['description' => 'The description of the experiment.'."\n", 'type' => 'string', 'required' => false, 'example' => 'This is an AutoML HPO experiment.', 'title' => ''], + 'Accessibility' => ['description' => 'The visibility of the code configuration. Valid values:'."\n" + ."\n" + .'* PUBLIC: The configuration is public in the workspace.'."\n" + .'* PRIVATE: The configuration is visible only to you and the administrator of the workspace.'."\n", 'type' => 'string', 'required' => false, 'example' => 'PRIVATE', 'title' => ''], 'Tag' => [ 'description' => 'Tag information.', 'type' => 'array', @@ -1291,26 +470,22 @@ 'description' => 'Tag information.', 'type' => 'object', 'properties' => [ - 'Key' => [ - 'description' => 'Tag name', - 'type' => 'string', - 'required' => false, - 'example' => 'group', - ], - 'Value' => [ - 'description' => 'Tag value', - 'type' => 'string', - 'required' => false, - 'example' => 'group_name', - ], + 'Key' => ['description' => 'Tag name', 'type' => 'string', 'required' => false, 'example' => 'group', 'title' => ''], + 'Value' => ['description' => 'Tag value', 'type' => 'string', 'required' => false, 'example' => 'group_name', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], 'required' => false, 'maxItems' => 20, + 'title' => '', + 'example' => '', ], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], @@ -1321,468 +496,266 @@ 'description' => 'The response body.'."\n", 'type' => 'object', 'properties' => [ - 'ExperimentId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the HPO experiment.'."\n", - 'type' => 'string', - 'example' => 'sORVEck', - ], - 'Code' => [ - 'description' => 'The internal error code. This parameter is returned if an exception occurred.'."\n", - 'type' => 'string', - 'example' => 'INVALID_INPUT_PARAMS', - ], - 'Message' => [ - 'description' => 'The error message. This parameter is returned if an exception occurred.'."\n", - 'type' => 'string', - 'example' => 'Missing \'user_id\' in request.', - ], - 'RequestId' => [ - 'description' => 'The ID of the POP request.'."\n", - 'type' => 'string', - 'example' => '3F190916-B3E5-5D1E-AD0C-35C0DF105F51', - ], + 'ExperimentId' => ['title' => 'Id of the request', 'description' => 'The ID of the HPO experiment.'."\n", 'type' => 'string', 'example' => 'sORVEck'], + 'Code' => ['description' => 'The internal error code. This parameter is returned if an exception occurred.'."\n", 'type' => 'string', 'example' => 'INVALID_INPUT_PARAMS', 'title' => ''], + 'Message' => ['description' => 'The error message. This parameter is returned if an exception occurred.'."\n", 'type' => 'string', 'example' => 'Missing \'user_id\' in request.', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the POP request.'."\n", 'type' => 'string', 'example' => '3F190916-B3E5-5D1E-AD0C-35C0DF105F51', 'title' => ''], 'AccessDeniedDetail' => [ 'description' => 'The information about the request denial.'."\n", 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'example' => '{"AuthPrincipalType": "sub", "PolicyType": "AccountLevelIdentityBasedPolicy", "NoPermissionType": "NoPermission"}', - 'description' => 'The information about the request denial..'."\n", - ], + 'additionalProperties' => ['type' => 'string', 'example' => '{"AuthPrincipalType": "sub", "PolicyType": "AccountLevelIdentityBasedPolicy", "NoPermissionType": "NoPermission"}', 'description' => 'The information about the request denial..'."\n", 'title' => ''], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ExperimentId\\": \\"sORVEck\\",\\n \\"Code\\": \\"INVALID_INPUT_PARAMS\\",\\n \\"Message\\": \\"Missing \'user_id\' in request.\\",\\n \\"RequestId\\": \\"3F190916-B3E5-5D1E-AD0C-35C0DF105F51\\",\\n \\"AccessDeniedDetail\\": {\\n \\"key\\": \\"{\\\\\\"AuthPrincipalType\\\\\\": \\\\\\"sub\\\\\\", \\\\\\"PolicyType\\\\\\": \\\\\\"AccountLevelIdentityBasedPolicy\\\\\\", \\\\\\"NoPermissionType\\\\\\": \\\\\\"NoPermission\\\\\\"}\\"\\n }\\n}","type":"json"}]', 'title' => 'CreateHpoExperiment', - 'translator' => 'machine', - ], - 'ListHpoExperiments' => [ - 'summary' => 'Queries information about a hyperparameter optimization (HPO) experiment that meets specific requirements.', - 'path' => '/api/automl/v1/hpo/experiments', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'paiautoml:CreateHpoExperiment', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIAutoML', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'CreateServiceIdentityRole' => [ + 'summary' => 'Creates a service-linked role.', + 'path' => '/api/automl/v1/serviceidentityrole', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '190772', - 'abilityTreeNodes' => [ - 'FEATURElearn0UHCCK', - ], + 'abilityTreeCode' => '190056', + 'abilityTreeNodes' => ['FEATURElearn0UHCCK'], + 'tenantRelevance' => 'publicInformation', ], - 'parameters' => [ - [ - 'name' => 'Name', - 'in' => 'query', - 'schema' => [ - 'description' => 'The keyword of the name of the experiment.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'my_hpo_exp_1', - ], - ], - [ - 'name' => 'Creator', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the user who created the experiment.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '266977839132045194', - ], - ], - [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => 'The page number. Pages start from page 1. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - ], - [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], - ], - [ - 'name' => 'MinCreateTime', - 'in' => 'query', - 'schema' => [ - 'description' => 'The earliest experiment creation time.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Format: yyyy-mm-dd hh:mm:ss or yyyy-mm-dd. Example: 2023-03-31 10:29:30'."\n", - ], - ], - [ - 'name' => 'MaxCreateTime', - 'in' => 'query', + 'parameters' => [], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The latest experiment creation time.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Format: yyyy-mm-dd hh:mm:ss or yyyy-mm-dd. Example: 2023-03-31 10:29:30'."\n", + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '3F190916-B3E5-5D1E-AD0C-35C0DF105F51'], + 'Code' => ['description' => 'The internal error code. This parameter is returned if an exception occurred.'."\n", 'type' => 'string', 'example' => 'ExecutionFailure', 'title' => ''], + 'Message' => ['description' => 'The error message. This parameter is returned if an exception occurred.'."\n", 'type' => 'string', 'example' => 'Execution failure, please try again.', 'title' => ''], + 'RoleName' => ['description' => 'The name of the role.'."\n", 'type' => 'string', 'example' => 'AliyunServiceRoleForPaiAutoml', 'title' => ''], + ], + 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3F190916-B3E5-5D1E-AD0C-35C0DF105F51\\",\\n \\"Code\\": \\"ExecutionFailure\\",\\n \\"Message\\": \\"Execution failure, please try again.\\",\\n \\"RoleName\\": \\"AliyunServiceRoleForPaiAutoml\\"\\n}","type":"json"}]', + 'title' => 'CreateServiceIdentityRole', + 'changeSet' => [], + 'ramActions' => [ [ - 'name' => 'Status', - 'in' => 'query', - 'schema' => [ - 'description' => 'The status of the experiment.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'CREATED, RUNNING, FINISHED, FAILED, EARLY_STOPPED, USER_CANCELED, SYS_CANCELED, WAITING, NO_MORE_TRIAL, UNKNOWN', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'paiautoml:CreateServiceIdentityRole', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIAutoML', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + ], + 'DeleteHpoExperiment' => [ + 'summary' => 'Deletes a hyperparameter optimization (HPO) experiment. After you delete the experiment, you cannot obtain the data about the experiment and its trials by using the Get or List API operations.', + 'path' => '/api/automl/v1/hpo/experiment/{ExperimentId}/delete', + 'methods' => ['put'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'WorkspaceId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The workspace ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'default', - ], + 'AK' => [], ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '196042', + 'abilityTreeNodes' => ['FEATURElearn0UHCCK'], + ], + 'parameters' => [ [ - 'name' => 'Accessibility', - 'in' => 'query', - 'schema' => [ - 'description' => 'The visibility of the workspace.'."\n" - ."\n" - .'* PRIVATE: The workspace is visible only to you and the administrator of the workspace.'."\n" - .'* PUBLIC: The workspace is visible to all users.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'PRIVATE', - ], + 'name' => 'ExperimentId', + 'in' => 'path', + 'schema' => ['title' => 'A short description of struct', 'description' => 'The ID of the experiment.'."\n", 'type' => 'string', 'required' => false, 'example' => 'abcde'], ], - [ - 'name' => 'IncludeConfigData', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'Specifies whether to include experiment configuration data in the response.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'True, False', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the POP request.'."\n", 'type' => 'string', 'example' => '3F190916-B3E5-5D1E-AD0C-35C0DF105F51'], + 'Code' => ['description' => 'The internal error code. This parameter is returned if an exception occurred.'."\n", 'type' => 'string', 'example' => 'INVALID_USER_OR_EXP', 'title' => ''], + 'Message' => ['description' => 'The error message. This parameter is returned if an exception occurred.'."\n", 'type' => 'string', 'example' => 'Missing \'user_id\' in request.', 'title' => ''], + 'AccessDeniedDetail' => ['description' => 'The details about the access denial.'."\n", 'type' => 'object', 'example' => '{'."\n" + .' "AuthPrincipalType": "sub",'."\n" + .' "PolicyType": "AccountLevelIdentityBasedPolicy",'."\n" + .' "NoPermissionType": "NoPermission"'."\n" + .'}'."\n", 'title' => ''], + ], + 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3F190916-B3E5-5D1E-AD0C-35C0DF105F51\\",\\n \\"Code\\": \\"INVALID_USER_OR_EXP\\",\\n \\"Message\\": \\"Missing \'user_id\' in request.\\",\\n \\"AccessDeniedDetail\\": {\\n \\"AuthPrincipalType\\": \\"sub\\",\\n \\"PolicyType\\": \\"AccountLevelIdentityBasedPolicy\\",\\n \\"NoPermissionType\\": \\"NoPermission\\"\\n }\\n}","type":"json"}]', + 'title' => 'DeleteHpoExperiment', + 'changeSet' => [], + 'ramActions' => [ [ - 'name' => 'SortBy', - 'in' => 'query', - 'schema' => [ - 'description' => 'The filter that is used to sort experiments.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'GmtCreateTime', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'paiautoml:DeleteHpoExperiment', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIAutoML', 'resourceType' => 'HpoExperiment', 'arn' => 'acs:paiautoml:{#regionId}:{#accountId}:hpoexperiment/{#HpoExperimentId}'], + ], ], ], + ], + ], + 'GetAutofeExperiment' => [ + 'path' => '/api/automl/v1/autofe/experiment/{ExperimentId}', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'Order', - 'in' => 'query', - 'schema' => [ - 'description' => 'The sorting order. Specify this parameter together with the SortBy parameter. Valid values:'."\n" - ."\n" - .'* DESC: in descending order. This is the default value.'."\n" - .'* ASC: in ascending order.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ASC, DESC.'."\n" - ."\n", - ], + 'AK' => [], ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '162733', + 'abilityTreeNodes' => ['FEATURElearn0UHCCK'], + ], + 'parameters' => [ [ - 'name' => 'Tag', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => 'Resource tags.', - 'type' => 'array', - 'items' => [ - 'description' => 'List of tags. Query filter conditions. Up to 20 tags can be specified.', - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => 'The tag key of the resource', - 'type' => 'string', - 'required' => false, - 'example' => 'group', - ], - 'Value' => [ - 'description' => 'Tag value.'."\n" - .'A tag value can contain up to 128 characters, and it cannot start with `aliyun` or `acs:`. It should not include `http://` or `https://`.'."\n" - .'Up to 20 tag values are supported in a single request.', - 'type' => 'string', - 'required' => false, - 'example' => 'group_name', - ], - ], - 'required' => false, - ], - 'required' => false, - ], + 'name' => 'ExperimentId', + 'in' => 'path', + 'schema' => ['description' => 'Experiment ID', 'type' => 'string', 'required' => true, 'example' => 'tfKs0Ds'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '3F190916-B3E5-5D1E-AD0C-35C0DF105F51', - ], - 'Code' => [ - 'title' => '响应状态。', - 'description' => 'The internal error code. This parameter is returned if an exception occurred.'."\n", - 'type' => 'string', - 'example' => 'INVALID_INPUT_PARAMS', - ], - 'Message' => [ - 'title' => '响应错误信息。只在响应出错时被设置', - 'description' => 'The error message. This parameter is returned if an exception occurred.'."\n", + 'Code' => ['description' => 'Internal error code. Set only when the response has error.', 'type' => 'string', 'example' => 'INVALID_USER_OR_EXP'], + 'Message' => ['description' => 'Response error message. Set only when the response has error.', 'type' => 'string', 'example' => 'Missing \'user_id\' in request.'], + 'RequestId' => ['description' => 'POP request ID', 'type' => 'string', 'example' => '071A904D-5A49-597F-9F69-81C7701D04AC'], + 'Detail' => ['description' => 'Detailed information of the error.', 'type' => 'object'], + 'ExperimentId' => ['description' => 'Experiment ID.', 'type' => 'string', 'example' => 'tfKs0Ds'], + 'Creator' => ['description' => 'User ID of the experiment creator', 'type' => 'string', 'example' => '266977839132045194'], + 'Name' => ['description' => 'Experiment name', 'type' => 'string', 'example' => 'autofe experiment name'], + 'JobMeta' => ['description' => 'Basic information about the experiment running status, including the number of subtasks, URLs corresponding to each task, etc.', 'type' => 'string', 'example' => '{"action": "fs_train", "request_id": "6B6D4FB6-87AA-5C0E-94AB-E0F830955D1E", "job_num": 7, "job_runs": [{"job_url": "https://pai.console.aliyun.com/?projectId=®ionId=cn-beijing#/studio/task/detail/flow-fqlk86bvk68", "duration": 181, "finish_at": 1719158854000, "create_time": "2024-06-23T16:04:31.000Z", "status": "Succeeded"}, {"job_url": "https://pai.console.aliyun.com/?projectId=®ionId=cn-beijing#/studio/task/detail/flow-q18k5jo66h3k", "duration": 233, "finish_at": 1719159106000, "create_time": "2024-06-23T16:07:51.000Z", "status": "Succeeded"}, {"job_url": "https://pai.console.aliyun.com/?projectId=®ionId=cn-beijing#/studio/task/detail/flow-g7b38dmqes0nm4le", "duration": 173, "finish_at": 1719159306000, "create_time": "2024-06-23T16:12:12.000Z", "status": "Succeeded"}, {"job_url": "https://pai.console.aliyun.com/?projectId=®ionId=cn-beijing#/studio/task/detail/flow-524dab97aazs3jmc", "duration": 199, "finish_at": 1719159527000, "create_time": "2024-06-23T16:15:28.000Z", "status": "Succeeded"}, {"job_url": "https://pai.console.aliyun.com/?projectId=®ionId=cn-beijing#/studio/task/detail/flow-a8z56wy2ppwmxx04", "duration": 197, "finish_at": 1719159747000, "create_time": "2024-06-23T16:19:08.000Z", "status": "Succeeded"}, {"job_url": "https://pai.console.aliyun.com/?projectId=®ionId=cn-beijing#/studio/task/detail/flow-2cgsbxzzzma1j", "duration": 210, "finish_at": 1719159982000, "create_time": "2024-06-23T16:22:51.000Z", "status": "Succeeded"}, {"job_url": "https://pai.console.aliyun.com/?projectId=®ionId=cn-beijing#/studio/task/detail/flow-3cgsvf3ien1cw7", "duration": 184, "finish_at": 1719160188000, "create_time": "2024-06-23T16:26:43.000Z", "status": "Succeeded"}], "workspace_id": "86006"}{"action": "fs_train", "request_id": "6B6D4FB6-87AA-5C0E-94AB-E0F830955D1E", "job_num": 7, "job_runs": [{"job_url": "https://pai.console.aliyun.com/?projectId=®ionId=cn-beijing#/studio/task/detail/flow-fqlk86betchc69vk68", "duration": 181, "finish_at": 1719158854000, "create_time": "2024-06-23T16:04:31.000Z", "status": "Succeeded"}, {"job_url": "https://pai.console.aliyun.com/?projectId=®ionId=cn-beijing#/studio/task/detail/flow-q18ijqak558jo66h3k", "duration": 233, "finish_at": 1719159106000, "create_time": "2024-06-23T16:07:51.000Z", "status": "Succeeded"}, {"job_url": "https://pai.console.aliyun.com/?projectId=®ionId=cn-beijing#/studio/task/detail/flow-g7b38df7mqes0nm4le", "duration": 173, "finish_at": 1719159306000, "create_time": "2024-06-23T16:12:12.000Z", "status": "Succeeded"}, {"job_url": "https://pai.console.aliyun.com/?projectId=®ionId=cn-beijing#/studio/task/detail/flow-524zedab97aazs3jmc", "duration": 199, "finish_at": 1719159527000, "create_time": "2024-06-23T16:15:28.000Z", "status": "Succeeded"}, {"job_url": "https://pai.console.aliyun.com/?projectId=®ionId=cn-beijing#/studio/task/detail/flow-a8z56wy2ppm6wmxx04", "duration": 197, "finish_at": 1719159747000, "create_time": "2024-06-23T16:19:08.000Z", "status": "Succeeded"}, {"job_url": "https://pai.console.aliyun.com/?projectId=®ionId=cn-beijing#/studio/task/detail/flow-2cgsbxzx9i35zzma1j", "duration": 210, "finish_at": 1719159982000, "create_time": "2024-06-23T16:22:51.000Z", "status": "Succeeded"}, {"job_url": "https://pai.console.aliyun.com/?projectId=®ionId=cn-beijing#/studio/task/detail/flow-3cgsvf3bprlien1cw7", "duration": 184, "finish_at": 1719160188000, "create_time": "2024-06-23T16:26:43.000Z", "status": "Succeeded"}], "workspace_id": "86006"}'], + 'GmtCreateTime' => ['description' => 'Experiment creation time.', 'type' => 'string', 'example' => '2023-08-18T09:41:01Z'], + 'GmtModifiedTime' => ['description' => 'Latest update time of experiment data.', 'type' => 'string', 'example' => '2023-11-30T02:05:34.000Z'], + 'Status' => ['description' => 'Experiment status', 'type' => 'string', 'example' => 'FINISHED, FAILED, USER_CANCELED'], + 'SelectedFeatures' => ['description' => 'Original features selected for feature engineering.', 'type' => 'string', 'example' => 'age,sex,education'], + 'Description' => ['description' => 'Experiment description information', 'type' => 'string', 'example' => 'My first experiment.'], + 'Accessibility' => [ + 'description' => 'Workspace visibility, possible values are:'."\n" + .'- PRIVATE: Visible only to you and administrators within this workspace.'."\n" + .'- PUBLIC: Visible to everyone within this workspace.', 'type' => 'string', - 'example' => 'Missing \'user_id\' in request.', - ], - 'AccessDeniedDetail' => [ - 'description' => 'The information about the request denial.'."\n", - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'example' => '{'."\n" - .' "AuthPrincipalType": "sub",'."\n" - .' "PolicyType": "AccountLevelIdentityBasedPolicy",'."\n" - .' "NoPermissionType": "NoPermission"'."\n" - .'}', - 'description' => 'The information about the request denial.'."\n", - ], - ], - 'TotalCount' => [ - 'description' => 'The total number of experiments returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '5', + 'enumValueTitles' => ['PUBLIC' => 'PUBLIC', 'PRIVATE' => 'PRIVATE'], + 'example' => 'PRIVATE', ], - 'Experiments' => [ - 'title' => '符合搜索条件的实验列表。', - 'description' => 'The experiments that meet the requirements.'."\n", + 'Tags' => [ 'type' => 'array', 'items' => [ - 'description' => 'The struct of the experiment data.'."\n", 'type' => 'object', 'properties' => [ - 'ExperimentId' => [ - 'title' => '实验id。', - 'description' => 'The ID of the experiment.'."\n", - 'type' => 'string', - 'example' => 'sORVEck', - ], - 'Creator' => [ - 'title' => '实验创建者的id。', - 'description' => 'The ID of the user who created the experiment.'."\n", - 'type' => 'string', - 'example' => '1049310008714189', - ], - 'SearchSpace' => [ - 'title' => '实验配置里的SearchSpace属性。', - 'description' => 'The SearchSpace property in the experiment configuration.'."\n", - 'type' => 'string', - 'example' => '{\'foo\':\'bar\'}', - ], - 'Name' => [ - 'title' => '实验名称。', - 'description' => 'The name of the experiment.'."\n", - 'type' => 'string', - 'example' => 'my experiment x', - ], - 'Status' => [ - 'title' => '实验状态。', - 'description' => 'The status of the experiment.'."\n", - 'type' => 'string', - 'example' => 'CREATED, RUNNING, FINISHED, FAILED, EARLY_STOPPED, USER_CANCELED, SYS_CANCELED, WAITING, NO_MORE_TRIAL, UNKNOWN', - ], - 'JobType' => [ - 'description' => 'The type of the experiment. For HPO experiments, the value of this parameter is 1.'."\n", - 'type' => 'string', - 'example' => '1', - ], - 'ConfigIni' => [ - 'description' => 'The content of the trial.ini configuration file. The actual value of sensitive data such as an AccessKey pair is replaced with asterisks (\\*).'."\n", - 'type' => 'string', - 'example' => '[odps_config]'."\n" - .'key1 = value1'."\n" - .'key2 = value2', - ], - 'ConfigYml' => [ - 'description' => 'The content of the exp.yml configuration file.'."\n", - 'type' => 'string', - 'example' => 'experimentName: dlc_oss_mnist'."\n" - .'experimentWorkingDirectory: ../expdir'."\n" - .'searchSpaceFile: search_space.json'."\n" - .'trialCommand: python3 -m hpo_tools.core.utils.run --config=./trial.ini'."\n" - .'trialConcurrency: 1'."\n" - .'maxTrialNumber: 4'."\n" - .'tuner:'."\n" - .' name: TPE'."\n" - .' classArgs:'."\n" - .' optimize_mode: maximize'."\n" - .'trainingService:'."\n" - .' platform: local'."\n" - .'assessor:'."\n" - .' name: PAIAssessor'."\n" - .' classArgs:'."\n" - .' optimize_mode: maximize'."\n" - .' start_step: 2', - ], - 'GmtCreateTime' => [ - 'title' => '实验创建时间。', - 'description' => 'The time at which the experiment was created.'."\n", - 'type' => 'string', - 'example' => '2023-03-31T10:29:30Z', - ], - 'GmtModifiedTime' => [ - 'title' => '实验数据最近更新时间。', - 'description' => 'The time at which the experiment data was last modified.'."\n", - 'type' => 'string', - 'example' => '2022-10-27T00:55:54Z', - ], - 'WorkspaceId' => [ - 'description' => 'The ID of the workspace.'."\n", - 'type' => 'string', - 'example' => 'foo', - ], - 'Accessibility' => [ - 'description' => 'The visibility of the workspace. Select the type of the task. Valid values:'."\n" - ."\n" - .'* PRIVATE (default): The workspace is visible only to you and the administrator of the workspace.'."\n" - .'* PUBLIC: The workspace is visible to all users.'."\n", - 'type' => 'string', - 'example' => 'PUBLIC', - ], - 'Description' => [ - 'description' => 'PUBLIC: The workspace is visible to all users.'."\n", - 'type' => 'string', - 'example' => 'desc', - ], - 'TrialCount' => [ - 'description' => 'The total number of trials of the experiment'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - ], - 'TrialStatus' => [ - 'description' => 'The information that contains the status of the trials and the trials in each state.'."\n", - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'example' => '3', - 'description' => 'FINISHED'."\n", - ], - ], - 'Deleted' => [ - 'description' => 'Indicates whether the experiment is deleted.'."\n", - 'type' => 'boolean', - 'example' => '1', - ], - 'Tags' => [ - 'description' => 'Tag system list', - 'type' => 'array', - 'items' => [ - 'description' => 'Tag list', - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => 'Tag key of the resource', - 'type' => 'string', - 'example' => 'group', - ], - 'Value' => [ - 'description' => 'Tag value.', - 'type' => 'string', - 'example' => 'group_name', - ], - ], - ], - ], + 'Key' => ['type' => 'string', 'description' => 'The tag key.'."\n", 'example' => 'group'], + 'Value' => ['type' => 'string', 'description' => 'The tag value.'."\n", 'example' => 'group_name'], ], + 'description' => 'The tag list.', ], + 'description' => 'The list of tags.'."\n", ], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3F190916-B3E5-5D1E-AD0C-35C0DF105F51\\",\\n \\"Code\\": \\"INVALID_INPUT_PARAMS\\",\\n \\"Message\\": \\"Missing \'user_id\' in request.\\",\\n \\"AccessDeniedDetail\\": {\\n \\"key\\": \\"{\\\\n \\\\\\"AuthPrincipalType\\\\\\": \\\\\\"sub\\\\\\",\\\\n \\\\\\"PolicyType\\\\\\": \\\\\\"AccountLevelIdentityBasedPolicy\\\\\\",\\\\n \\\\\\"NoPermissionType\\\\\\": \\\\\\"NoPermission\\\\\\"\\\\n}\\"\\n },\\n \\"TotalCount\\": 5,\\n \\"Experiments\\": [\\n {\\n \\"ExperimentId\\": \\"sORVEck\\",\\n \\"Creator\\": \\"1049310008714189\\",\\n \\"SearchSpace\\": \\"{\'foo\':\'bar\'}\\",\\n \\"Name\\": \\"my experiment x\\",\\n \\"Status\\": \\"CREATED, RUNNING, FINISHED, FAILED, EARLY_STOPPED, USER_CANCELED, WAITING, NO_MORE_TRIAL, UNKNOWN\\",\\n \\"JobType\\": \\"1\\",\\n \\"ConfigIni\\": \\"[odps_config]\\\\nkey1 = value1\\\\nkey2 = value2\\",\\n \\"ConfigYml\\": \\"experimentName: dlc_oss_mnist\\\\nexperimentWorkingDirectory: ../expdir\\\\nsearchSpaceFile: search_space.json\\\\ntrialCommand: python3 -m hpo_tools.core.utils.run --config=./trial.ini\\\\ntrialConcurrency: 1\\\\nmaxTrialNumber: 4\\\\ntuner:\\\\n name: TPE\\\\n classArgs:\\\\n optimize_mode: maximize\\\\ntrainingService:\\\\n platform: local\\\\nassessor:\\\\n name: PAIAssessor\\\\n classArgs:\\\\n optimize_mode: maximize\\\\n start_step: 2\\",\\n \\"GmtCreateTime\\": \\"2023-03-31T10:29:30Z\\",\\n \\"GmtModifiedTime\\": \\"2022-10-27T00:55:54Z\\",\\n \\"WorkspaceId\\": \\"default\\",\\n \\"Accessibility\\": \\"PUBLIC\\",\\n \\"Description\\": \\"description\\",\\n \\"TrialCount\\": 20,\\n \\"TrialStatus\\": {\\n \\"key\\": \\"3\\"\\n },\\n \\"Deleted\\": true,\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"group\\",\\n \\"Value\\": \\"group_name\\"\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', - 'title' => 'ListHpoExperiments', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"INVALID_USER_OR_EXP\\",\\n \\"Message\\": \\"Missing \'user_id\' in request.\\",\\n \\"RequestId\\": \\"071A904D-5A49-597F-9F69-81C7701D04AC\\",\\n \\"Detail\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"ExperimentId\\": \\"tfKs0Ds\\",\\n \\"Creator\\": \\"266977839132045194\\",\\n \\"Name\\": \\"自动特征工程实验\\",\\n \\"JobMeta\\": \\"{\\\\\\"action\\\\\\": \\\\\\"fs_train\\\\\\", \\\\\\"request_id\\\\\\": \\\\\\"6B6D4FB6-87AA-5C0E-94AB-E0F830955D1E\\\\\\", \\\\\\"job_num\\\\\\": 7, \\\\\\"job_runs\\\\\\": [{\\\\\\"job_url\\\\\\": \\\\\\"https://pai.console.aliyun.com/?projectId=®ionId=cn-beijing#/studio/task/detail/flow-fqlk86bvk68\\\\\\", \\\\\\"duration\\\\\\": 181, \\\\\\"finish_at\\\\\\": 1719158854000, \\\\\\"create_time\\\\\\": \\\\\\"2024-06-23T16:04:31.000Z\\\\\\", \\\\\\"status\\\\\\": \\\\\\"Succeeded\\\\\\"}, {\\\\\\"job_url\\\\\\": \\\\\\"https://pai.console.aliyun.com/?projectId=®ionId=cn-beijing#/studio/task/detail/flow-q18k5jo66h3k\\\\\\", \\\\\\"duration\\\\\\": 233, \\\\\\"finish_at\\\\\\": 1719159106000, \\\\\\"create_time\\\\\\": \\\\\\"2024-06-23T16:07:51.000Z\\\\\\", \\\\\\"status\\\\\\": \\\\\\"Succeeded\\\\\\"}, {\\\\\\"job_url\\\\\\": \\\\\\"https://pai.console.aliyun.com/?projectId=®ionId=cn-beijing#/studio/task/detail/flow-g7b38dmqes0nm4le\\\\\\", \\\\\\"duration\\\\\\": 173, \\\\\\"finish_at\\\\\\": 1719159306000, \\\\\\"create_time\\\\\\": \\\\\\"2024-06-23T16:12:12.000Z\\\\\\", \\\\\\"status\\\\\\": \\\\\\"Succeeded\\\\\\"}, {\\\\\\"job_url\\\\\\": \\\\\\"https://pai.console.aliyun.com/?projectId=®ionId=cn-beijing#/studio/task/detail/flow-524dab97aazs3jmc\\\\\\", \\\\\\"duration\\\\\\": 199, \\\\\\"finish_at\\\\\\": 1719159527000, \\\\\\"create_time\\\\\\": \\\\\\"2024-06-23T16:15:28.000Z\\\\\\", \\\\\\"status\\\\\\": \\\\\\"Succeeded\\\\\\"}, {\\\\\\"job_url\\\\\\": \\\\\\"https://pai.console.aliyun.com/?projectId=®ionId=cn-beijing#/studio/task/detail/flow-a8z56wy2ppwmxx04\\\\\\", \\\\\\"duration\\\\\\": 197, \\\\\\"finish_at\\\\\\": 1719159747000, \\\\\\"create_time\\\\\\": \\\\\\"2024-06-23T16:19:08.000Z\\\\\\", \\\\\\"status\\\\\\": \\\\\\"Succeeded\\\\\\"}, {\\\\\\"job_url\\\\\\": \\\\\\"https://pai.console.aliyun.com/?projectId=®ionId=cn-beijing#/studio/task/detail/flow-2cgsbxzzzma1j\\\\\\", \\\\\\"duration\\\\\\": 210, \\\\\\"finish_at\\\\\\": 1719159982000, \\\\\\"create_time\\\\\\": \\\\\\"2024-06-23T16:22:51.000Z\\\\\\", \\\\\\"status\\\\\\": \\\\\\"Succeeded\\\\\\"}, {\\\\\\"job_url\\\\\\": \\\\\\"https://pai.console.aliyun.com/?projectId=®ionId=cn-beijing#/studio/task/detail/flow-3cgsvf3ien1cw7\\\\\\", \\\\\\"duration\\\\\\": 184, \\\\\\"finish_at\\\\\\": 1719160188000, \\\\\\"create_time\\\\\\": \\\\\\"2024-06-23T16:26:43.000Z\\\\\\", \\\\\\"status\\\\\\": \\\\\\"Succeeded\\\\\\"}], \\\\\\"workspace_id\\\\\\": \\\\\\"86006\\\\\\"}{\\\\\\"action\\\\\\": \\\\\\"fs_train\\\\\\", \\\\\\"request_id\\\\\\": \\\\\\"6B6D4FB6-87AA-5C0E-94AB-E0F830955D1E\\\\\\", \\\\\\"job_num\\\\\\": 7, \\\\\\"job_runs\\\\\\": [{\\\\\\"job_url\\\\\\": \\\\\\"https://pai.console.aliyun.com/?projectId=®ionId=cn-beijing#/studio/task/detail/flow-fqlk86betchc69vk68\\\\\\", \\\\\\"duration\\\\\\": 181, \\\\\\"finish_at\\\\\\": 1719158854000, \\\\\\"create_time\\\\\\": \\\\\\"2024-06-23T16:04:31.000Z\\\\\\", \\\\\\"status\\\\\\": \\\\\\"Succeeded\\\\\\"}, {\\\\\\"job_url\\\\\\": \\\\\\"https://pai.console.aliyun.com/?projectId=®ionId=cn-beijing#/studio/task/detail/flow-q18ijqak558jo66h3k\\\\\\", \\\\\\"duration\\\\\\": 233, \\\\\\"finish_at\\\\\\": 1719159106000, \\\\\\"create_time\\\\\\": \\\\\\"2024-06-23T16:07:51.000Z\\\\\\", \\\\\\"status\\\\\\": \\\\\\"Succeeded\\\\\\"}, {\\\\\\"job_url\\\\\\": \\\\\\"https://pai.console.aliyun.com/?projectId=®ionId=cn-beijing#/studio/task/detail/flow-g7b38df7mqes0nm4le\\\\\\", \\\\\\"duration\\\\\\": 173, \\\\\\"finish_at\\\\\\": 1719159306000, \\\\\\"create_time\\\\\\": \\\\\\"2024-06-23T16:12:12.000Z\\\\\\", \\\\\\"status\\\\\\": \\\\\\"Succeeded\\\\\\"}, {\\\\\\"job_url\\\\\\": \\\\\\"https://pai.console.aliyun.com/?projectId=®ionId=cn-beijing#/studio/task/detail/flow-524zedab97aazs3jmc\\\\\\", \\\\\\"duration\\\\\\": 199, \\\\\\"finish_at\\\\\\": 1719159527000, \\\\\\"create_time\\\\\\": \\\\\\"2024-06-23T16:15:28.000Z\\\\\\", \\\\\\"status\\\\\\": \\\\\\"Succeeded\\\\\\"}, {\\\\\\"job_url\\\\\\": \\\\\\"https://pai.console.aliyun.com/?projectId=®ionId=cn-beijing#/studio/task/detail/flow-a8z56wy2ppm6wmxx04\\\\\\", \\\\\\"duration\\\\\\": 197, \\\\\\"finish_at\\\\\\": 1719159747000, \\\\\\"create_time\\\\\\": \\\\\\"2024-06-23T16:19:08.000Z\\\\\\", \\\\\\"status\\\\\\": \\\\\\"Succeeded\\\\\\"}, {\\\\\\"job_url\\\\\\": \\\\\\"https://pai.console.aliyun.com/?projectId=®ionId=cn-beijing#/studio/task/detail/flow-2cgsbxzx9i35zzma1j\\\\\\", \\\\\\"duration\\\\\\": 210, \\\\\\"finish_at\\\\\\": 1719159982000, \\\\\\"create_time\\\\\\": \\\\\\"2024-06-23T16:22:51.000Z\\\\\\", \\\\\\"status\\\\\\": \\\\\\"Succeeded\\\\\\"}, {\\\\\\"job_url\\\\\\": \\\\\\"https://pai.console.aliyun.com/?projectId=®ionId=cn-beijing#/studio/task/detail/flow-3cgsvf3bprlien1cw7\\\\\\", \\\\\\"duration\\\\\\": 184, \\\\\\"finish_at\\\\\\": 1719160188000, \\\\\\"create_time\\\\\\": \\\\\\"2024-06-23T16:26:43.000Z\\\\\\", \\\\\\"status\\\\\\": \\\\\\"Succeeded\\\\\\"}], \\\\\\"workspace_id\\\\\\": \\\\\\"86006\\\\\\"}\\",\\n \\"GmtCreateTime\\": \\"2023-08-18T09:41:01Z\\",\\n \\"GmtModifiedTime\\": \\"2023-11-30T02:05:34.000Z\\",\\n \\"Status\\": \\"FINISHED, FAILED, USER_CANCELED\\",\\n \\"SelectedFeatures\\": \\"age,sex,education\\",\\n \\"Description\\": \\"我的实验\\",\\n \\"Accessibility\\": \\"PRIVATE\\",\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"group\\",\\n \\"Value\\": \\"group_name\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Get AutoFE Experiment Information', + 'summary' => 'Get AutoFE Experiment', 'translator' => 'machine', ], 'GetHpoExperiment' => [ 'summary' => 'Queries the information about a hyperparameter optimization (HPO) experiment, including the status and configuration of the experiment, and the status of its trials.', 'path' => '/api/automl/v1/hpo/experiment/{ExperimentId}', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ @@ -1790,21 +763,13 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '162519', - 'abilityTreeNodes' => [ - 'FEATURElearn0UHCCK', - ], + 'abilityTreeNodes' => ['FEATURElearn0UHCCK'], ], 'parameters' => [ [ 'name' => 'ExperimentId', 'in' => 'path', - 'schema' => [ - 'title' => 'A short description of struct', - 'description' => 'The ID of the HPO experiment.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'sX5O9Q8', - ], + 'schema' => ['title' => 'A short description of struct', 'description' => 'The ID of the HPO experiment.'."\n", 'type' => 'string', 'required' => false, 'example' => 'sX5O9Q8'], ], ], 'responses' => [ @@ -1814,215 +779,132 @@ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the POP request.'."\n", - 'type' => 'string', - 'example' => '3F190916-B3E5-5D1E-AD0C-35C0DF105F51', - ], - 'Code' => [ - 'description' => 'The internal error code. This parameter is returned if an exception occurred.'."\n", - 'type' => 'string', - 'example' => 'INVALID_INPUT_PARAMS', - ], - 'Message' => [ - 'description' => 'The error message. This parameter is returned if an exception occurred.'."\n", - 'type' => 'string', - 'example' => 'Missing \'user_id\' in request.', - ], - 'AccessDeniedDetail' => [ - 'description' => 'The details about the access denial.'."\n", - 'type' => 'object', - 'example' => '{'."\n" - .' "AuthPrincipalType": "sub",'."\n" - .' "PolicyType": "AccountLevelIdentityBasedPolicy",'."\n" - .' "NoPermissionType": "NoPermission"'."\n" - .'}'."\n", - ], - 'ExperimentId' => [ - 'description' => 'The ID of the HPO experiment.'."\n", - 'type' => 'string', - 'example' => 'sX5O9Q8', - ], - 'Creator' => [ - 'description' => 'The ID of the user who created the experiment.'."\n", - 'type' => 'string', - 'example' => '123456789', - ], - 'SearchSpace' => [ - 'description' => 'The configuration content of the search_space.json file.'."\n", - 'type' => 'string', - 'example' => '{"${centerCount}":{"_type":"choice","_value":[2,3,4,5]},"${distanceType}":{"_type":"choice","_value":["euclidean","cosine","cityblock"]}}', - ], - 'Name' => [ - 'description' => 'The name of the experiment.'."\n", - 'type' => 'string', - 'example' => 'my_hpo_exp_1', - ], - 'Status' => [ - 'description' => 'The status of the experiment. Valid values:'."\n", - 'type' => 'string', - 'example' => 'INVALID_USER_OR_EXP, SUCCESS, or EXECUTION_FAILURE', - ], - 'JobType' => [ - 'description' => 'The type of the experiment. For HPO experiments, the value of this parameter is 1.'."\n", - 'type' => 'string', - 'example' => '1', - ], - 'ConfigIni' => [ - 'description' => 'The content of the trial.ini configuration file.'."\n", - 'type' => 'string', - 'example' => '[odps_config]'."\n" - .'access_id=foo'."\n" - .'access_key=bar'."\n" - .'end_point=http://service.odps.aliyun.com/api'."\n" - .'log_view_host=http://logview.odps.aliyun.com'."\n" - .'project_name=my_project', - ], - 'ConfigYml' => [ - 'description' => 'The content of the exp.yml configuration file.'."\n", - 'type' => 'string', - 'example' => 'assessor:'."\n" - .' classArgs:'."\n" - .' optimize_mode: maximize'."\n" - .' start_step: 1'."\n" - .' name: PAIAssessor'."\n" - .'debug: true'."\n" - .'experimentName: maxcompute_kmeans_monitor'."\n" - .'experimentWorkingDirectory: ../expdir'."\n" - .'logLevel: debug'."\n" - .'maxTrialNumber: 10'."\n" - .'searchSpaceFile: search_space.json'."\n" - .'trainingService:'."\n" - .' platform: local'."\n" - .'trialCommand: python3 -m hpo_tools.core.utils.run --config=./config.ini'."\n" - .'trialConcurrency: 2'."\n" - .'tuner:'."\n" - .' classArgs:'."\n" - .' optimize_mode: maximize'."\n" - .' name: TPE', - ], - 'GmtCreateTime' => [ - 'description' => 'The time at which the experiment was created.'."\n", - 'type' => 'string', - 'example' => '2024-01-01 08:30:11', - ], - 'GmtModifiedTime' => [ - 'description' => 'The time at which the experiment data was last updated.'."\n", - 'type' => 'string', - 'example' => '2024-01-01 08:30:11', - ], - 'WorkspaceId' => [ - 'description' => 'The workspace ID.'."\n", - 'type' => 'string', - 'example' => '12345', - ], - 'Accessibility' => [ - 'description' => 'The visibility of the experiment in the workspace.'."\n" - ."\n" - .'* PRIVATE: The experiment is visible only to you and the administrator of the workspace.'."\n" - .'* PUBLIC: The experiment is public in the workspace.'."\n", - 'type' => 'string', - 'example' => 'PRIVATE', - ], - 'Description' => [ - 'description' => 'The description of the experiment.'."\n", - 'type' => 'string', - 'example' => 'This is experiment is for tune the LR of model.', - ], - 'TrialCount' => [ - 'description' => 'The number of trials that are generated by the experiment.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', - ], + 'RequestId' => ['description' => 'The ID of the POP request.'."\n", 'type' => 'string', 'example' => '3F190916-B3E5-5D1E-AD0C-35C0DF105F51', 'title' => ''], + 'Code' => ['description' => 'The internal error code. This parameter is returned if an exception occurred.'."\n", 'type' => 'string', 'example' => 'INVALID_INPUT_PARAMS', 'title' => ''], + 'Message' => ['description' => 'The error message. This parameter is returned if an exception occurred.'."\n", 'type' => 'string', 'example' => 'Missing \'user_id\' in request.', 'title' => ''], + 'AccessDeniedDetail' => ['description' => 'The details about the access denial.'."\n", 'type' => 'object', 'example' => '{'."\n" + .' "AuthPrincipalType": "sub",'."\n" + .' "PolicyType": "AccountLevelIdentityBasedPolicy",'."\n" + .' "NoPermissionType": "NoPermission"'."\n" + .'}'."\n", 'title' => ''], + 'ExperimentId' => ['description' => 'The ID of the HPO experiment.'."\n", 'type' => 'string', 'example' => 'sX5O9Q8', 'title' => ''], + 'Creator' => ['description' => 'The ID of the user who created the experiment.'."\n", 'type' => 'string', 'example' => '123456789', 'title' => ''], + 'SearchSpace' => ['description' => 'The configuration content of the search_space.json file.'."\n", 'type' => 'string', 'example' => '{"${centerCount}":{"_type":"choice","_value":[2,3,4,5]},"${distanceType}":{"_type":"choice","_value":["euclidean","cosine","cityblock"]}}', 'title' => ''], + 'Name' => ['description' => 'The name of the experiment.'."\n", 'type' => 'string', 'example' => 'my_hpo_exp_1', 'title' => ''], + 'Status' => ['description' => 'The status of the experiment. Valid values:'."\n", 'type' => 'string', 'example' => 'INVALID_USER_OR_EXP, SUCCESS, or EXECUTION_FAILURE', 'title' => ''], + 'JobType' => ['description' => 'The type of the experiment. For HPO experiments, the value of this parameter is 1.'."\n", 'type' => 'string', 'example' => '1', 'title' => ''], + 'ConfigIni' => ['description' => 'The content of the trial.ini configuration file.'."\n", 'type' => 'string', 'example' => '[odps_config]'."\n" + .'access_id=foo'."\n" + .'access_key=bar'."\n" + .'end_point=http://service.odps.aliyun.com/api'."\n" + .'log_view_host=http://logview.odps.aliyun.com'."\n" + .'project_name=my_project', 'title' => ''], + 'ConfigYml' => ['description' => 'The content of the exp.yml configuration file.'."\n", 'type' => 'string', 'example' => 'assessor:'."\n" + .' classArgs:'."\n" + .' optimize_mode: maximize'."\n" + .' start_step: 1'."\n" + .' name: PAIAssessor'."\n" + .'debug: true'."\n" + .'experimentName: maxcompute_kmeans_monitor'."\n" + .'experimentWorkingDirectory: ../expdir'."\n" + .'logLevel: debug'."\n" + .'maxTrialNumber: 10'."\n" + .'searchSpaceFile: search_space.json'."\n" + .'trainingService:'."\n" + .' platform: local'."\n" + .'trialCommand: python3 -m hpo_tools.core.utils.run --config=./config.ini'."\n" + .'trialConcurrency: 2'."\n" + .'tuner:'."\n" + .' classArgs:'."\n" + .' optimize_mode: maximize'."\n" + .' name: TPE', 'title' => ''], + 'GmtCreateTime' => ['description' => 'The time at which the experiment was created.'."\n", 'type' => 'string', 'example' => '2024-01-01 08:30:11', 'title' => ''], + 'GmtModifiedTime' => ['description' => 'The time at which the experiment data was last updated.'."\n", 'type' => 'string', 'example' => '2024-01-01 08:30:11', 'title' => ''], + 'WorkspaceId' => ['description' => 'The workspace ID.'."\n", 'type' => 'string', 'example' => '12345', 'title' => ''], + 'Accessibility' => ['description' => 'The visibility of the experiment in the workspace.'."\n" + ."\n" + .'* PRIVATE: The experiment is visible only to you and the administrator of the workspace.'."\n" + .'* PUBLIC: The experiment is public in the workspace.'."\n", 'type' => 'string', 'example' => 'PRIVATE', 'title' => ''], + 'Description' => ['description' => 'The description of the experiment.'."\n", 'type' => 'string', 'example' => '我的实验', 'title' => ''], + 'TrialCount' => ['description' => 'The number of trials that are generated by the experiment.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'title' => ''], 'TrialStatus' => [ 'description' => 'The status and number of the trials.'."\n", 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'description' => 'The information that contains the status of the trials and the trials in each state.'."\n", - 'example' => '{‘FINISHED\':1, \'RUNNING\':2}', - ], - ], - 'HpoExperimentConfiguration' => [ - 'description' => 'The configuration information of the experiment.'."\n", - 'type' => 'object', - 'example' => '{'."\n" - .' "output_config": {'."\n" - .' "model_path": "bi_ps_${exp_id}_${trial_id}"'."\n" - .' },'."\n" - .' "platform_config": {'."\n" - .' "cmd": ['."\n" - .' "PAI -name ps_smart\\n -project foo",'."\n" - .' "PAI -name prediction\\n -project foo",'."\n" - .' "PAI -name evaluate -project foo",'."\n" - .' "INSERT OVERWRITE TABLE my_table;"'."\n" - .' ],'."\n" - .' "name": "MaxCompute"'."\n" - .' },'."\n" - .' "metric_config": {'."\n" - .' "metric_dict": {'."\n" - .' "recall": 0.5,'."\n" - .' "auc": 0.25,'."\n" - .' "precision": 0.25'."\n" - .' },'."\n" - .' "metric_source": ['."\n" - .' "select * from my_metrics where pt=\'${exp_id}_${trial_id}\';"'."\n" - .' ],'."\n" - .' "metric_type": "table",'."\n" - .' "final_mode": "best"'."\n" - .' },'."\n" - .' "odps_config": {'."\n" - .' "project_name": "my_project",'."\n" - .' "role_arn": "acs:ram::123456789:role/aliyunserviceroleforfoo",'."\n" - .' "region": "cn-shanghai",'."\n" - .' "end_point": "http://service.cn.maxcompute.aliyun-inc.com/api",'."\n" - .' "log_view_host": "http://logview.odps.aliyun.com"'."\n" - .' },'."\n" - .' "yml_config": {'."\n" - .' "max_trial_number": 5,'."\n" - .' "assessor": {'."\n" - .' "name": "PAIAssessor",'."\n" - .' "class_args": {'."\n" - .' "earlystop": true,'."\n" - .' "start_step": 5,'."\n" - .' "optimize_mode": "maximize"'."\n" - .' }'."\n" - .' },'."\n" - .' "experiment_name": "my_exp",'."\n" - .' "tuner": {'."\n" - .' "name": "TPE",'."\n" - .' "class_args": {'."\n" - .' "optimize_mode": "maximize"'."\n" - .' }'."\n" - .' },'."\n" - .' "trial_concurrency": 2'."\n" - .' },'."\n" - .' "search_space": {'."\n" - .' "${max_depth}": {'."\n" - .' "_type": "choice",'."\n" - .' "_value": ['."\n" - .' 1,'."\n" - .' 3,'."\n" - .' 5'."\n" - .' ]'."\n" - .' },'."\n" - .' "${tree_count}": {'."\n" - .' "_value": ['."\n" - .' 50,'."\n" - .' 100,'."\n" - .' 150'."\n" - .' ],'."\n" - .' "_type": "choice"'."\n" - .' }'."\n" - .' }'."\n" - .'}', - ], - 'Deleted' => [ - 'description' => 'Indicates whether the experiment is deleted.'."\n", - 'type' => 'boolean', - 'example' => '0', - ], + 'additionalProperties' => ['type' => 'string', 'description' => 'The information that contains the status of the trials and the trials in each state.'."\n", 'example' => '{‘FINISHED\':1, \'RUNNING\':2}', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'HpoExperimentConfiguration' => ['description' => 'The configuration information of the experiment.'."\n", 'type' => 'object', 'example' => '{'."\n" + .' "output_config": {'."\n" + .' "model_path": "bi_ps_${exp_id}_${trial_id}"'."\n" + .' },'."\n" + .' "platform_config": {'."\n" + .' "cmd": ['."\n" + .' "PAI -name ps_smart\\n -project foo",'."\n" + .' "PAI -name prediction\\n -project foo",'."\n" + .' "PAI -name evaluate -project foo",'."\n" + .' "INSERT OVERWRITE TABLE my_table;"'."\n" + .' ],'."\n" + .' "name": "MaxCompute"'."\n" + .' },'."\n" + .' "metric_config": {'."\n" + .' "metric_dict": {'."\n" + .' "recall": 0.5,'."\n" + .' "auc": 0.25,'."\n" + .' "precision": 0.25'."\n" + .' },'."\n" + .' "metric_source": ['."\n" + .' "select * from my_metrics where pt=\'${exp_id}_${trial_id}\';"'."\n" + .' ],'."\n" + .' "metric_type": "table",'."\n" + .' "final_mode": "best"'."\n" + .' },'."\n" + .' "odps_config": {'."\n" + .' "project_name": "my_project",'."\n" + .' "role_arn": "acs:ram::123456789:role/aliyunserviceroleforfoo",'."\n" + .' "region": "cn-shanghai",'."\n" + .' "end_point": "http://service.cn.maxcompute.aliyun-inc.com/api",'."\n" + .' "log_view_host": "http://logview.odps.aliyun.com"'."\n" + .' },'."\n" + .' "yml_config": {'."\n" + .' "max_trial_number": 5,'."\n" + .' "assessor": {'."\n" + .' "name": "PAIAssessor",'."\n" + .' "class_args": {'."\n" + .' "earlystop": true,'."\n" + .' "start_step": 5,'."\n" + .' "optimize_mode": "maximize"'."\n" + .' }'."\n" + .' },'."\n" + .' "experiment_name": "my_exp",'."\n" + .' "tuner": {'."\n" + .' "name": "TPE",'."\n" + .' "class_args": {'."\n" + .' "optimize_mode": "maximize"'."\n" + .' }'."\n" + .' },'."\n" + .' "trial_concurrency": 2'."\n" + .' },'."\n" + .' "search_space": {'."\n" + .' "${max_depth}": {'."\n" + .' "_type": "choice",'."\n" + .' "_value": ['."\n" + .' 1,'."\n" + .' 3,'."\n" + .' 5'."\n" + .' ]'."\n" + .' },'."\n" + .' "${tree_count}": {'."\n" + .' "_value": ['."\n" + .' 50,'."\n" + .' 100,'."\n" + .' 150'."\n" + .' ],'."\n" + .' "_type": "choice"'."\n" + .' }'."\n" + .' }'."\n" + .'}', 'title' => ''], + 'Deleted' => ['description' => 'Indicates whether the experiment is deleted.'."\n", 'type' => 'boolean', 'example' => '0', 'title' => ''], 'Tags' => [ 'description' => 'List of user-defined tags', 'type' => 'array', @@ -2030,145 +912,73 @@ 'description' => 'Resource tags.', 'type' => 'object', 'properties' => [ - 'Key' => [ - 'description' => 'Tag key', - 'type' => 'string', - 'example' => 'group', - ], - 'Value' => [ - 'description' => 'Tag value.', - 'type' => 'string', - 'example' => 'group_name', - ], + 'Key' => ['description' => 'Tag key', 'type' => 'string', 'example' => 'group', 'title' => ''], + 'Value' => ['description' => 'Tag value.', 'type' => 'string', 'example' => 'group_name', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3F190916-B3E5-5D1E-AD0C-35C0DF105F51\\",\\n \\"Code\\": \\"INVALID_INPUT_PARAMS\\",\\n \\"Message\\": \\"Missing \'user_id\' in request.\\",\\n \\"AccessDeniedDetail\\": {\\n \\"AuthPrincipalType\\": \\"sub\\",\\n \\"PolicyType\\": \\"AccountLevelIdentityBasedPolicy\\",\\n \\"NoPermissionType\\": \\"NoPermission\\"\\n },\\n \\"ExperimentId\\": \\"sX5O9Q8\\",\\n \\"Creator\\": \\"123456789\\",\\n \\"SearchSpace\\": \\"{\\\\\\"${centerCount}\\\\\\":{\\\\\\"_type\\\\\\":\\\\\\"choice\\\\\\",\\\\\\"_value\\\\\\":[2,3,4,5]},\\\\\\"${distanceType}\\\\\\":{\\\\\\"_type\\\\\\":\\\\\\"choice\\\\\\",\\\\\\"_value\\\\\\":[\\\\\\"euclidean\\\\\\",\\\\\\"cosine\\\\\\",\\\\\\"cityblock\\\\\\"]}}\\",\\n \\"Name\\": \\"my_hpo_exp_1\\",\\n \\"Status\\": \\"INVALID_USER_OR_EXP, SUCCESS, or EXECUTION_FAILURE\\",\\n \\"JobType\\": \\"1\\",\\n \\"ConfigIni\\": \\"[odps_config]\\\\naccess_id=foo\\\\naccess_key=bar\\\\nend_point=http://service.odps.aliyun.com/api\\\\nlog_view_host=http://logview.odps.aliyun.com\\\\nproject_name=my_project\\",\\n \\"ConfigYml\\": \\"assessor:\\\\n classArgs:\\\\n optimize_mode: maximize\\\\n start_step: 1\\\\n name: PAIAssessor\\\\ndebug: true\\\\nexperimentName: maxcompute_kmeans_monitor\\\\nexperimentWorkingDirectory: ../expdir\\\\nlogLevel: debug\\\\nmaxTrialNumber: 10\\\\nsearchSpaceFile: search_space.json\\\\ntrainingService:\\\\n platform: local\\\\ntrialCommand: python3 -m hpo_tools.core.utils.run --config=./config.ini\\\\ntrialConcurrency: 2\\\\ntuner:\\\\n classArgs:\\\\n optimize_mode: maximize\\\\n name: TPE\\",\\n \\"GmtCreateTime\\": \\"2024-01-01 08:30:11\\",\\n \\"GmtModifiedTime\\": \\"2024-01-01 08:30:11\\",\\n \\"WorkspaceId\\": \\"12345\\",\\n \\"Accessibility\\": \\"PRIVATE\\",\\n \\"Description\\": \\"我的实验\\",\\n \\"TrialCount\\": 3,\\n \\"TrialStatus\\": {\\n \\"key\\": \\"{‘FINISHED\':1, \'RUNNING\':2}\\"\\n },\\n \\"HpoExperimentConfiguration\\": {\\n \\"output_config\\": {\\n \\"model_path\\": \\"bi_ps_${exp_id}_${trial_id}\\"\\n },\\n \\"platform_config\\": {\\n \\"cmd\\": [\\n \\"PAI -name ps_smart\\\\n -project foo\\",\\n \\"PAI -name prediction\\\\n -project foo\\",\\n \\"PAI -name evaluate -project foo\\",\\n \\"INSERT OVERWRITE TABLE my_table;\\"\\n ],\\n \\"name\\": \\"MaxCompute\\"\\n },\\n \\"metric_config\\": {\\n \\"metric_dict\\": {\\n \\"recall\\": 0.5,\\n \\"auc\\": 0.25,\\n \\"precision\\": 0.25\\n },\\n \\"metric_source\\": [\\n \\"select * from my_metrics where pt=\'${exp_id}_${trial_id}\';\\"\\n ],\\n \\"metric_type\\": \\"table\\",\\n \\"final_mode\\": \\"best\\"\\n },\\n \\"odps_config\\": {\\n \\"project_name\\": \\"my_project\\",\\n \\"role_arn\\": \\"acs:ram::123456789:role/aliyunserviceroleforfoo\\",\\n \\"region\\": \\"cn-shanghai\\",\\n \\"end_point\\": \\"http://service.cn.maxcompute.aliyun-inc.com/api\\",\\n \\"log_view_host\\": \\"http://logview.odps.aliyun.com\\"\\n },\\n \\"yml_config\\": {\\n \\"max_trial_number\\": 5,\\n \\"assessor\\": {\\n \\"name\\": \\"PAIAssessor\\",\\n \\"class_args\\": {\\n \\"earlystop\\": true,\\n \\"start_step\\": 5,\\n \\"optimize_mode\\": \\"maximize\\"\\n }\\n },\\n \\"experiment_name\\": \\"my_exp\\",\\n \\"tuner\\": {\\n \\"name\\": \\"TPE\\",\\n \\"class_args\\": {\\n \\"optimize_mode\\": \\"maximize\\"\\n }\\n },\\n \\"trial_concurrency\\": 2\\n },\\n \\"search_space\\": {\\n \\"${max_depth}\\": {\\n \\"_type\\": \\"choice\\",\\n \\"_value\\": [\\n 1,\\n 3,\\n 5\\n ]\\n },\\n \\"${tree_count}\\": {\\n \\"_value\\": [\\n 50,\\n 100,\\n 150\\n ],\\n \\"_type\\": \\"choice\\"\\n }\\n }\\n },\\n \\"Deleted\\": true,\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"group\\",\\n \\"Value\\": \\"group_name\\"\\n }\\n ]\\n}","type":"json"}]', 'title' => 'GetHpoExperiment', - 'translator' => 'machine', - ], - 'UpdateHpoExperiment' => [ - 'summary' => 'Updates the configurations of a running hyperparameter optimization (HPO) experiment. After you update the experiment, the experiment continues to run based on the new configurations.', - 'path' => '/api/automl/v1/hpo/experiment/{ExperimentId}/update', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'paiautoml:GetHpoExperiment', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIAutoML', 'resourceType' => 'HpoExperiment', 'arn' => 'acs:paiautoml:{#regionId}:{#accountId}:hpoexperiment/{#HpoExperimentId}'], + ], + ], + ], ], + ], + 'GetHpoTrial' => [ + 'summary' => 'Queries information about a trial in a hyperparameter optimization (HPO) experiment.', + 'path' => '/api/automl/v1/hpo/experiment/{ExperimentId}/trial/{TrialId}', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '195655', - 'abilityTreeNodes' => [ - 'FEATURElearn0UHCCK', - ], + 'abilityTreeCode' => '192107', + 'abilityTreeNodes' => ['FEATURElearn0UHCCK'], ], 'parameters' => [ [ 'name' => 'ExperimentId', 'in' => 'path', - 'schema' => [ - 'title' => 'A short description of struct', - 'description' => 'The ID of the HPO experiment.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'abcde', - ], + 'schema' => ['title' => '', 'description' => 'The ID of the experiment.'."\n", 'type' => 'string', 'required' => true, 'example' => 'abcde'], ], [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'description' => 'The request body.'."\n", - 'type' => 'object', - 'properties' => [ - 'HpoExperimentConfiguration' => [ - 'description' => 'The parameter struct of the HPO experiment configuration.'."\n", - 'required' => false, - '$ref' => '#/components/schemas/HpoExperimentConfig', - ], - 'Description' => [ - 'description' => 'The description of the experiment.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'This is an AutoML HPO experiment.', - ], - 'Accessibility' => [ - 'description' => 'The visibility of the experiment in the workspace. Valid values:'."\n" - ."\n" - .'* PRIVATE: The experiment is visible only to you and the administrator of the workspace.'."\n" - .'* PUBLIC: The experiment is public in the workspace.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'PRIVATE', - ], - 'Name' => [ - 'description' => 'The name of the experiment.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'my experiment x', - ], - 'WorkspaceId' => [ - 'description' => 'The workspace ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '12345', - ], - 'Tag' => [ - 'description' => 'Tag information.', - 'type' => 'array', - 'items' => [ - 'description' => 'Tag information.', - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => 'Tag name', - 'type' => 'string', - 'required' => false, - 'example' => 'group', - ], - 'Value' => [ - 'description' => 'Tag value', - 'type' => 'string', - 'required' => false, - 'example' => 'group_name', - ], - ], - 'required' => false, - ], - 'required' => false, - ], - ], - 'required' => false, - ], + 'name' => 'TrialId', + 'in' => 'path', + 'schema' => ['description' => 'trial id'."\n", 'type' => 'string', 'required' => true, 'example' => 'mf99W4', 'title' => ''], ], ], 'responses' => [ @@ -2178,263 +988,134 @@ 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the POP request.'."\n", - 'type' => 'string', - 'example' => '3F190916-B3E5-5D1E-AD0C-35C0DF105F51', - ], - 'Code' => [ - 'description' => 'The status code.'."\n", - 'type' => 'string', - 'example' => 'SUCCESS', - ], - 'Message' => [ - 'description' => 'The error message. This parameter is returned if an exception occurred.'."\n", - 'type' => 'string', - 'example' => 'Missing \'user_id\' in request.', - ], + 'RequestId' => ['description' => 'The ID of the POP request.'."\n", 'type' => 'string', 'example' => '3F190916-B3E5-5D1E-AD0C-35C0DF105F51', 'title' => ''], + 'Code' => ['title' => '', 'description' => 'The internal error code. This parameter is returned if an exception occurred.'."\n", 'type' => 'string', 'example' => 'INVALID_INPUT_PARAMS'], + 'Message' => ['title' => '', 'description' => 'The error message. This parameter is returned if an exception occurred.'."\n", 'type' => 'string', 'example' => 'Missing \'user_id\' in request.'], 'AccessDeniedDetail' => [ 'description' => 'The details about the access denial.'."\n", 'type' => 'object', - 'example' => '{'."\n" + 'additionalProperties' => ['type' => 'string', 'example' => '{'."\n" .' "AuthPrincipalType": "sub",'."\n" .' "PolicyType": "AccountLevelIdentityBasedPolicy",'."\n" .' "NoPermissionType": "NoPermission"'."\n" - .'}'."\n", - ], + .'}'."\n", 'description' => 'The details about the access denial.'."\n", 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'TrialId' => ['description' => 'The ID of the trial.'."\n", 'type' => 'string', 'example' => 'mf99W4', 'title' => ''], + 'ExperimentId' => ['description' => 'The ID of the HPO experiment.'."\n", 'type' => 'string', 'example' => 'abcde', 'title' => ''], + 'Model' => ['description' => 'The storage location of the model generated by the backend task to which the trial belongs.'."\n", 'type' => 'string', 'example' => 'model_table_name_foo', 'title' => ''], + 'Hyperparam' => ['description' => 'The hyperparameter values of the trial.'."\n", 'type' => 'string', 'example' => '{"${centerCount}": 5, "${distanceType}": "cosine"}', 'title' => ''], + 'ParameterId' => ['description' => 'The ID assigned by the backend task to which the trial belongs.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'Status' => ['description' => 'The status of the trial.'."\n", 'type' => 'string', 'example' => 'FINISHED, FAILED, USER_CANCELED', 'title' => ''], + 'MetricName' => ['description' => 'The name of the metric. Not used.'."\n", 'type' => 'string', 'example' => '空字符串', 'title' => ''], + 'Metric' => ['description' => 'The array of the results of the calculated metrics of the trial. The array includes one or more temporary values generated during the calculation and the final value.'."\n", 'type' => 'string', 'example' => '[{"default":0.087745,"val_loss=([0-9\\\\\\\\.]+)":0.087745},'."\n" + .'{"default":1.085841,"val_loss=([0-9\\\\\\\\.]+)":0.085841},'."\n" + .'{"default":0.087745,"type":"FINAL","val_loss=([0-9\\\\\\\\.]+)":0.087745}]', 'title' => ''], + 'JobMeta' => ['description' => 'The meta information of the backend task to which the trial belongs. The value is in the JSON string format.'."\n", 'type' => 'string', 'example' => '{"nni_trial_id": "asdf", "nni_exp_id": "abcde", "nni_trial_sequence_id": 2}', 'title' => ''], + 'FinalMetric' => ['description' => 'The final metric value calculated by the backend task after the trial is completed. The value is the value of the default key in the metric item of the FINAL type in the metric array.'."\n", 'type' => 'string', 'example' => '{"default":0.087745,"type":"FINAL","val_loss=([0-9\\\\\\\\.]+)":0.087745}', 'title' => ''], + 'GmtCreateTime' => ['description' => 'The time at which the trial was created. The time is in UTC.'."\n", 'type' => 'string', 'example' => '2024-01-02 12:34:56', 'title' => ''], + 'GmtModifiedTime' => ['description' => 'The time at which the trial was last modified. The time is in UTC.'."\n", 'type' => 'string', 'example' => '2024-01-02 21:32:56', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3F190916-B3E5-5D1E-AD0C-35C0DF105F51\\",\\n \\"Code\\": \\"SUCCESS\\",\\n \\"Message\\": \\"Missing \'user_id\' in request.\\",\\n \\"AccessDeniedDetail\\": {\\n \\"AuthPrincipalType\\": \\"sub\\",\\n \\"PolicyType\\": \\"AccountLevelIdentityBasedPolicy\\",\\n \\"NoPermissionType\\": \\"NoPermission\\"\\n }\\n}","type":"json"}]', - 'title' => 'UpdateHpoExperiment', - ], - 'StopHpoExperiment' => [ - 'summary' => 'Stops a hyperparameter optimization (HPO) experiment, including its trials and the backend tasks.', - 'path' => '/api/automl/v1/hpo/experiment/{ExperimentId}/stop', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '162610', - 'abilityTreeNodes' => [ - 'FEATURElearn0UHCCK', - ], - ], - 'parameters' => [ + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3F190916-B3E5-5D1E-AD0C-35C0DF105F51\\",\\n \\"Code\\": \\"INVALID_INPUT_PARAMS\\",\\n \\"Message\\": \\"Missing \'user_id\' in request.\\",\\n \\"AccessDeniedDetail\\": {\\n \\"key\\": \\"{\\\\n \\\\\\"AuthPrincipalType\\\\\\": \\\\\\"sub\\\\\\",\\\\n \\\\\\"PolicyType\\\\\\": \\\\\\"AccountLevelIdentityBasedPolicy\\\\\\",\\\\n \\\\\\"NoPermissionType\\\\\\": \\\\\\"NoPermission\\\\\\"\\\\n}\\\\n\\"\\n },\\n \\"TrialId\\": \\"mf99W4\\",\\n \\"ExperimentId\\": \\"abcde\\",\\n \\"Model\\": \\"model_table_name_foo\\",\\n \\"Hyperparam\\": \\"{\\\\\\"${centerCount}\\\\\\": 5, \\\\\\"${distanceType}\\\\\\": \\\\\\"cosine\\\\\\"}\\",\\n \\"ParameterId\\": 0,\\n \\"Status\\": \\"FINISHED, FAILED, USER_CANCELED\\",\\n \\"MetricName\\": \\"空字符串\\",\\n \\"Metric\\": \\"[{\\\\\\"default\\\\\\":0.087745,\\\\\\"val_loss=([0-9\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\.]+)\\\\\\":0.087745},\\\\n{\\\\\\"default\\\\\\":1.085841,\\\\\\"val_loss=([0-9\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\.]+)\\\\\\":0.085841},\\\\n{\\\\\\"default\\\\\\":0.087745,\\\\\\"type\\\\\\":\\\\\\"FINAL\\\\\\",\\\\\\"val_loss=([0-9\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\.]+)\\\\\\":0.087745}]\\",\\n \\"JobMeta\\": \\"{\\\\\\"nni_trial_id\\\\\\": \\\\\\"asdf\\\\\\", \\\\\\"nni_exp_id\\\\\\": \\\\\\"abcde\\\\\\", \\\\\\"nni_trial_sequence_id\\\\\\": 2}\\",\\n \\"FinalMetric\\": \\"{\\\\\\"default\\\\\\":0.087745,\\\\\\"type\\\\\\":\\\\\\"FINAL\\\\\\",\\\\\\"val_loss=([0-9\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\.]+)\\\\\\":0.087745}\\",\\n \\"GmtCreateTime\\": \\"2024-01-02 12:34:56\\",\\n \\"GmtModifiedTime\\": \\"2024-01-02 21:32:56\\"\\n}","type":"json"}]', + 'title' => 'GetHpoTrial', + 'changeSet' => [], + 'ramActions' => [ [ - 'name' => 'ExperimentId', - 'in' => 'path', - 'schema' => [ - 'title' => '需要被停止的实验的id。', - 'description' => 'The ID of the experiment that you want to stop.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'abcde', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", - 'type' => 'object', - 'properties' => [ - 'ExpId' => [ - 'title' => '实验id。', - 'description' => 'The ID of the experiment.'."\n", - 'type' => 'string', - 'example' => 'sHpITOH', - ], - 'Code' => [ - 'title' => '响应状态。', - 'description' => 'The internal error code. This parameter is returned if an exception occurred.'."\n", - 'type' => 'string', - 'example' => 'INVALID_INPUT_PARAMS', - ], - 'Message' => [ - 'title' => '响应错误信息。只在响应出错时被设置。', - 'description' => 'The error message. This parameter is returned if an exception occurred.'."\n", - 'type' => 'string', - 'example' => 'Missing \'user_id\' in request.', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '071A904D-5A49-597F-9F69-81C7701D04AC', - ], - 'AccessDeniedDetail' => [ - 'description' => 'The details about the access denial.'."\n", - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'example' => '{'."\n" - .' "AuthPrincipalType": "sub",'."\n" - .' "PolicyType": "AccountLevelIdentityBasedPolicy",'."\n" - .' "NoPermissionType": "NoPermission"'."\n" - .'}'."\n", - 'description' => 'The details about the access denial.'."\n", - ], - ], - 'Status' => [ - 'description' => 'Current expriment status.', - 'type' => 'string', - 'example' => 'TERMINATING, USER_CANCELED', - ], + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'paiautoml:GetHpoTrial', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIAutoML', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'eventInfo' => [ - 'enable' => false, - 'eventNames' => [], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ExpId\\": \\"abcde\\",\\n \\"Code\\": \\"INVALID_INPUT_PARAMS\\",\\n \\"Message\\": \\"Missing \'user_id\' in request.\\",\\n \\"RequestId\\": \\"071A904D-5A49-597F-9F69-81C7701D04AC\\",\\n \\"AccessDeniedDetail\\": {\\n \\"key\\": \\"{\\\\n \\\\\\"AuthPrincipalType\\\\\\": \\\\\\"sub\\\\\\",\\\\n \\\\\\"PolicyType\\\\\\": \\\\\\"AccountLevelIdentityBasedPolicy\\\\\\",\\\\n \\\\\\"NoPermissionType\\\\\\": \\\\\\"NoPermission\\\\\\"\\\\n}\\\\n\\"\\n },\\n \\"Status\\": \\"TERMINATING, USER_CANCELED\\"\\n}","type":"json"}]', - 'title' => 'StopHpoExperiment', - 'translator' => 'machine', ], - 'DeleteHpoExperiment' => [ - 'summary' => 'Deletes a hyperparameter optimization (HPO) experiment. After you delete the experiment, you cannot obtain the data about the experiment and its trials by using the Get or List API operations.', - 'path' => '/api/automl/v1/hpo/experiment/{ExperimentId}/delete', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'https', - ], + 'GetServiceIdentityRole' => [ + 'summary' => 'GetServiceIdentityRole, return role name if SLR exists, empty otherwise', + 'path' => '/api/automl/v1/serviceidentityrole', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', + 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '196042', - 'abilityTreeNodes' => [ - 'FEATURElearn0UHCCK', - ], - ], - 'parameters' => [ - [ - 'name' => 'ExperimentId', - 'in' => 'path', - 'schema' => [ - 'title' => 'A short description of struct', - 'description' => 'The ID of the experiment.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'sORVEck', - ], - ], + 'abilityTreeCode' => '190053', + 'abilityTreeNodes' => ['FEATURElearn0UHCCK'], + 'tenantRelevance' => 'publicInformation', ], + 'parameters' => [], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the POP request.'."\n", - 'type' => 'string', - 'example' => '3F190916-B3E5-5D1E-AD0C-35C0DF105F51', - ], - 'Code' => [ - 'description' => 'The internal error code. This parameter is returned if an exception occurred.'."\n", - 'type' => 'string', - 'example' => 'INVALID_USER_OR_EXP', - ], - 'Message' => [ - 'description' => 'The error message. This parameter is returned if an exception occurred.'."\n", - 'type' => 'string', - 'example' => 'Missing \'user_id\' in request.', - ], - 'AccessDeniedDetail' => [ - 'description' => 'The details about the access denial.'."\n", - 'type' => 'object', - 'example' => '{'."\n" - .' "AuthPrincipalType": "sub",'."\n" - .' "PolicyType": "AccountLevelIdentityBasedPolicy",'."\n" - .' "NoPermissionType": "NoPermission"'."\n" - .'}'."\n", - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the POP request.'."\n", 'type' => 'string', 'example' => '3F190916-B3E5-5D1E-AD0C-35C0DF105F51'], + 'RoleName' => ['description' => 'The name of the RAM role.'."\n", 'type' => 'string', 'example' => 'AliyunServiceRoleForPaiAutoml', 'title' => ''], + 'Code' => ['description' => 'The internal error code. This parameter is returned if an exception occurred.'."\n", 'type' => 'string', 'example' => 'SUCCESS', 'title' => ''], + 'Message' => ['description' => 'The error message. This parameter is returned if an exception occurred.'."\n", 'type' => 'string', 'example' => 'Execution failure, please try again.', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3F190916-B3E5-5D1E-AD0C-35C0DF105F51\\",\\n \\"Code\\": \\"INVALID_USER_OR_EXP\\",\\n \\"Message\\": \\"Missing \'user_id\' in request.\\",\\n \\"AccessDeniedDetail\\": {\\n \\"AuthPrincipalType\\": \\"sub\\",\\n \\"PolicyType\\": \\"AccountLevelIdentityBasedPolicy\\",\\n \\"NoPermissionType\\": \\"NoPermission\\"\\n }\\n}","type":"json"}]', - 'title' => 'DeleteHpoExperiment', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3F190916-B3E5-5D1E-AD0C-35C0DF105F51\\",\\n \\"RoleName\\": \\"AliyunServiceRoleForPaiAutoml\\",\\n \\"Code\\": \\"SUCCESS\\",\\n \\"Message\\": \\"Execution failure, please try again.\\"\\n}","type":"json"}]', + 'title' => 'GetServiceIdentityRole', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'paiautoml:GetServiceIdentityRole', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIAutoML', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], ], 'ListHpoExperimentLogs' => [ 'summary' => 'Queries the content of a log file for a hyperparameter optimization (HPO) experiment.', 'path' => '/api/automl/v1/hpo/experiment/{ExperimentId}/logs', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ @@ -2442,53 +1123,28 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '195804', - 'abilityTreeNodes' => [ - 'FEATURElearn0UHCCK', - ], + 'abilityTreeNodes' => ['FEATURElearn0UHCCK'], ], 'parameters' => [ [ 'name' => 'ExperimentId', 'in' => 'path', - 'schema' => [ - 'title' => 'A short description of struct', - 'description' => 'The ID of the HPO experiment.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'abcde', - ], + 'schema' => ['title' => 'A short description of struct', 'description' => 'The ID of the HPO experiment.'."\n", 'type' => 'string', 'required' => false, 'example' => 'abcde'], ], [ 'name' => 'LogName', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the log. Valid values: nnimanager.log and dispatcher.log.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'nnimanager.log', - ], + 'schema' => ['description' => 'The name of the log. Valid values: nnimanager.log and dispatcher.log.'."\n", 'type' => 'string', 'required' => false, 'example' => 'nnimanager.log', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => 'The page number. Page start from page 1. If you leave this parameter empty, all content in the log file is returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The page number. Page start from page 1. If you leave this parameter empty, all content in the log file is returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page. If you leave this parameter empty, all content in the log file is returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '40', - ], + 'schema' => ['description' => 'The number of entries per page. If you leave this parameter empty, all content in the log file is returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '40', 'title' => ''], ], ], 'responses' => [ @@ -2498,148 +1154,160 @@ 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '071A904D-5A49-597F-9F69-81C7701D04AC', - ], - 'Code' => [ - 'description' => 'The status code.'."\n", - 'type' => 'string', - 'example' => 'SUCCESS', - ], - 'Message' => [ - 'description' => 'The error message. This parameter is returned if an exception occurred.'."\n", - 'type' => 'string', - 'example' => 'Missing \'user_id\' in request.', - ], - 'AccessDeniedDetail' => [ - 'description' => 'The details about the access denial.'."\n", - 'type' => 'object', - 'example' => '{'."\n" - .' "AuthPrincipalType": "sub",'."\n" - .' "PolicyType": "AccountLevelIdentityBasedPolicy",'."\n" - .' "NoPermissionType": "NoPermission"'."\n" - .'}'."\n", - ], - 'TotalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '467', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '071A904D-5A49-597F-9F69-81C7701D04AC'], + 'Code' => ['description' => 'The status code.'."\n", 'type' => 'string', 'example' => 'SUCCESS', 'title' => ''], + 'Message' => ['description' => 'The error message. This parameter is returned if an exception occurred.'."\n", 'type' => 'string', 'example' => 'Missing \'user_id\' in request.', 'title' => ''], + 'AccessDeniedDetail' => ['description' => 'The details about the access denial.'."\n", 'type' => 'object', 'example' => '{'."\n" + .' "AuthPrincipalType": "sub",'."\n" + .' "PolicyType": "AccountLevelIdentityBasedPolicy",'."\n" + .' "NoPermissionType": "NoPermission"'."\n" + .'}'."\n", 'title' => ''], + 'TotalCount' => ['description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '467', 'title' => ''], 'Logs' => [ 'description' => 'The content of the log entry.'."\n", 'type' => 'array', - 'items' => [ - 'description' => 'The content of the log entry.'."\n", - 'type' => 'string', - 'example' => '[2024-03-07 18:29:29] INFO (LocalTrainingService) Run local machine training service.', - ], + 'items' => ['description' => 'The content of the log entry.'."\n", 'type' => 'string', 'example' => '[2024-03-07 18:29:29] INFO (LocalTrainingService) Run local machine training service.', 'title' => ''], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"071A904D-5A49-597F-9F69-81C7701D04AC\\",\\n \\"Code\\": \\"SUCCESS\\",\\n \\"Message\\": \\"Missing \'user_id\' in request.\\",\\n \\"AccessDeniedDetail\\": {\\n \\"AuthPrincipalType\\": \\"sub\\",\\n \\"PolicyType\\": \\"AccountLevelIdentityBasedPolicy\\",\\n \\"NoPermissionType\\": \\"NoPermission\\"\\n },\\n \\"TotalCount\\": 467,\\n \\"Logs\\": [\\n \\"[2024-03-07 18:29:29] INFO (LocalTrainingService) Run local machine training service.\\"\\n ]\\n}","type":"json"}]', 'title' => 'ListHpoExperimentLogs', - ], - 'ListHpoTrials' => [ - 'summary' => 'Returns all the trials for the specified experiment ID.', - 'path' => '/api/automl/v1/hpo/experiment/{ExperimentId}/trials', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'paiautoml:ListHpoExperimentLogs', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIAutoML', 'resourceType' => 'HpoExperiment', 'arn' => 'acs:paiautoml:{#regionId}:{#accountId}:hpoexperiment/{#HpoExperimentId}'], + ], + ], + ], ], + ], + 'ListHpoExperiments' => [ + 'summary' => 'Queries information about a hyperparameter optimization (HPO) experiment that meets specific requirements.', + 'path' => '/api/automl/v1/hpo/experiments', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '190695', - 'abilityTreeNodes' => [ - 'FEATURElearn0UHCCK', - ], + 'abilityTreeCode' => '190772', + 'abilityTreeNodes' => ['FEATURElearn0UHCCK'], ], 'parameters' => [ [ - 'name' => 'ExperimentId', - 'in' => 'path', - 'schema' => [ - 'description' => 'The ID of the HPO experiment.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'abcde', - ], + 'name' => 'Name', + 'in' => 'query', + 'schema' => ['description' => 'The keyword of the name of the experiment.'."\n", 'type' => 'string', 'required' => false, 'example' => '任意关键字', 'title' => ''], + ], + [ + 'name' => 'Creator', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the user who created the experiment.'."\n", 'type' => 'string', 'required' => false, 'example' => '266977839132045194', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'description' => 'The page number to return. Pages start from 1. You can use this parameter to search for HPO experiments.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The page number. Pages start from page 1. Default value: 1.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'title' => '本次读取的最大数据记录数量', - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'MinCreateTime', + 'in' => 'query', + 'schema' => ['description' => 'The earliest experiment creation time.'."\n", 'type' => 'string', 'required' => false, 'example' => 'yyyy-mm-dd hh:mm:ss或着yyyy-mm-dd，比如2023-03-31 10:29:30', 'title' => ''], + ], + [ + 'name' => 'MaxCreateTime', + 'in' => 'query', + 'schema' => ['description' => 'The latest experiment creation time.'."\n", 'type' => 'string', 'required' => false, 'example' => 'yyyy-mm-dd hh:mm:ss或着yyyy-mm-dd，比如2023-03-31 10:29:30', 'title' => ''], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => ['description' => 'The status of the experiment.'."\n", 'type' => 'string', 'required' => false, 'example' => 'CREATED, RUNNING, FINISHED, FAILED, EARLY_STOPPED, USER_CANCELED, SYS_CANCELED, WAITING, NO_MORE_TRIAL, UNKNOWN', 'title' => ''], + ], + [ + 'name' => 'WorkspaceId', + 'in' => 'query', + 'schema' => ['description' => 'The workspace ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'default', 'title' => ''], + ], + [ + 'name' => 'Accessibility', + 'in' => 'query', + 'schema' => ['description' => 'The visibility of the workspace.'."\n" + ."\n" + .'* PRIVATE: The workspace is visible only to you and the administrator of the workspace.'."\n" + .'* PUBLIC: The workspace is visible to all users.'."\n", 'type' => 'string', 'required' => false, 'example' => 'PRIVATE', 'title' => ''], + ], + [ + 'name' => 'IncludeConfigData', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to include experiment configuration data in the response.'."\n", 'type' => 'string', 'required' => false, 'example' => 'True或者False，默认False表示不包括', 'title' => ''], ], [ 'name' => 'SortBy', 'in' => 'query', - 'schema' => [ - 'description' => 'The basis for sorting.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'GmtCreateTime', - ], + 'schema' => ['description' => 'The filter that is used to sort experiments.'."\n", 'type' => 'string', 'required' => false, 'example' => 'create_time, update_time, workspace_id, status, accessibility其中之一', 'title' => ''], ], [ 'name' => 'Order', 'in' => 'query', + 'schema' => ['description' => 'The sorting order. Specify this parameter together with the SortBy parameter. Valid values:'."\n" + ."\n" + .'* DESC: in descending order. This is the default value.'."\n" + .'* ASC: in ascending order.'."\n", 'type' => 'string', 'required' => false, 'example' => 'DESC或ASC', 'title' => ''], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => 'The order of specific fields of results in a paged query (ascending or descending). Default value: ASC.'."\n" - ."\n" - .'* ASC Ascend'."\n" - .'* DESC Descend'."\n", - 'type' => 'string', + 'description' => 'Resource tags.', + 'type' => 'array', + 'items' => [ + 'description' => 'List of tags. Query filter conditions. Up to 20 tags can be specified.', + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The tag key of the resource', 'type' => 'string', 'required' => false, 'example' => 'group', 'title' => ''], + 'Value' => ['description' => 'Tag value.'."\n" + .'A tag value can contain up to 128 characters, and it cannot start with `aliyun` or `acs:`. It should not include `http://` or `https://`.'."\n" + .'Up to 20 tag values are supported in a single request.', 'type' => 'string', 'required' => false, 'example' => 'group_name', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], 'required' => false, - 'example' => 'ASC', + 'title' => '', + 'example' => '', ], ], ], @@ -2650,182 +1318,152 @@ 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '3F190916-B3E5-5D1E-AD0C-35C0DF105F51', - ], - 'Code' => [ - 'description' => 'The internal error code. This parameter is returned if an exception occurred.'."\n", - 'type' => 'string', - 'example' => 'INVALID_USER_OR_EXP', - ], - 'Message' => [ - 'description' => 'The error message. This parameter is returned if an exception occurred.'."\n", - 'type' => 'string', - 'example' => 'Missing \'user_id\' in request.', - ], - 'TotalCount' => [ - 'title' => 'TotalCount本次请求条件下的数据总量，此参数为可选参数，默认可不返回', - 'description' => 'The total number of entries returned. By default, this parameter is not returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '5', + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '3F190916-B3E5-5D1E-AD0C-35C0DF105F51', 'title' => ''], + 'Code' => ['title' => '', 'description' => 'The internal error code. This parameter is returned if an exception occurred.'."\n", 'type' => 'string', 'example' => 'INVALID_INPUT_PARAMS'], + 'Message' => ['title' => '', 'description' => 'The error message. This parameter is returned if an exception occurred.'."\n", 'type' => 'string', 'example' => 'Missing \'user_id\' in request.'], + 'AccessDeniedDetail' => [ + 'description' => 'The information about the request denial.'."\n", + 'type' => 'object', + 'additionalProperties' => ['type' => 'string', 'example' => '{'."\n" + .' "AuthPrincipalType": "sub",'."\n" + .' "PolicyType": "AccountLevelIdentityBasedPolicy",'."\n" + .' "NoPermissionType": "NoPermission"'."\n" + .'}', 'description' => 'The information about the request denial.'."\n", 'title' => ''], + 'title' => '', + 'example' => '', ], - 'Trials' => [ - 'description' => 'Data structs of the trial.'."\n", + 'TotalCount' => ['description' => 'The total number of experiments returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''], + 'Experiments' => [ + 'title' => '', + 'description' => 'The experiments that meet the requirements.'."\n", 'type' => 'array', 'items' => [ - 'description' => 'The struct of the trial.'."\n", + 'description' => 'The struct of the experiment data.'."\n", 'type' => 'object', 'properties' => [ - 'TrialId' => [ - 'description' => 'The ID of the trial.'."\n", - 'type' => 'string', - 'example' => 'asdf', - ], - 'ExperimentId' => [ - 'description' => 'The ID of the HPO experiment.'."\n", - 'type' => 'string', - 'example' => 'abcde', - ], - 'ParameterId' => [ - 'description' => 'The ID assigned by the backend task to which the trial belongs.'."\n", - 'type' => 'integer', - 'format' => 'int32', + 'ExperimentId' => ['title' => '', 'description' => 'The ID of the experiment.'."\n", 'type' => 'string', 'example' => 'sORVEck'], + 'Creator' => ['title' => '', 'description' => 'The ID of the user who created the experiment.'."\n", 'type' => 'string', 'example' => '1049310008714189'], + 'SearchSpace' => ['title' => '', 'description' => 'The SearchSpace property in the experiment configuration.'."\n", 'type' => 'string', 'example' => '{\'foo\':\'bar\'}'], + 'Name' => ['title' => '', 'description' => 'The name of the experiment.'."\n", 'type' => 'string', 'example' => 'my experiment x'], + 'Status' => ['title' => '', 'description' => 'The status of the experiment.'."\n", 'type' => 'string', 'example' => 'CREATED, RUNNING, FINISHED, FAILED, EARLY_STOPPED, USER_CANCELED, WAITING, NO_MORE_TRIAL, UNKNOWN'], + 'JobType' => ['description' => 'The type of the experiment. For HPO experiments, the value of this parameter is 1.'."\n", 'type' => 'string', 'example' => '1', 'title' => ''], + 'ConfigIni' => ['description' => 'The content of the trial.ini configuration file. The actual value of sensitive data such as an AccessKey pair is replaced with asterisks (\\*).'."\n", 'type' => 'string', 'example' => '[odps_config]'."\n" + .'key1 = value1'."\n" + .'key2 = value2', 'title' => ''], + 'ConfigYml' => ['description' => 'The content of the exp.yml configuration file.'."\n", 'type' => 'string', 'example' => 'experimentName: dlc_oss_mnist'."\n" + .'experimentWorkingDirectory: ../expdir'."\n" + .'searchSpaceFile: search_space.json'."\n" + .'trialCommand: python3 -m hpo_tools.core.utils.run --config=./trial.ini'."\n" + .'trialConcurrency: 1'."\n" + .'maxTrialNumber: 4'."\n" + .'tuner:'."\n" + .' name: TPE'."\n" + .' classArgs:'."\n" + .' optimize_mode: maximize'."\n" + .'trainingService:'."\n" + .' platform: local'."\n" + .'assessor:'."\n" + .' name: PAIAssessor'."\n" + .' classArgs:'."\n" + .' optimize_mode: maximize'."\n" + .' start_step: 2', 'title' => ''], + 'GmtCreateTime' => ['title' => '', 'description' => 'The time at which the experiment was created.'."\n", 'type' => 'string', 'example' => '2023-03-31T10:29:30Z'], + 'GmtModifiedTime' => ['title' => '', 'description' => 'The time at which the experiment data was last modified.'."\n", 'type' => 'string', 'example' => '2022-10-27T00:55:54Z'], + 'WorkspaceId' => ['description' => 'The ID of the workspace.'."\n", 'type' => 'string', 'example' => 'default', 'title' => ''], + 'Accessibility' => ['description' => 'The visibility of the workspace. Select the type of the task. Valid values:'."\n" + ."\n" + .'* PRIVATE (default): The workspace is visible only to you and the administrator of the workspace.'."\n" + .'* PUBLIC: The workspace is visible to all users.'."\n", 'type' => 'string', 'example' => 'PUBLIC', 'title' => ''], + 'Description' => ['description' => 'PUBLIC: The workspace is visible to all users.'."\n", 'type' => 'string', 'example' => 'description', 'title' => ''], + 'TrialCount' => ['description' => 'The total number of trials of the experiment'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], + 'TrialStatus' => [ + 'description' => 'The information that contains the status of the trials and the trials in each state.'."\n", + 'type' => 'object', + 'additionalProperties' => ['type' => 'string', 'example' => '3', 'description' => 'FINISHED'."\n", 'title' => ''], + 'title' => '', 'example' => '', ], - 'Hyperparam' => [ - 'description' => 'The hyperparameter values of the trial.'."\n", - 'type' => 'string', - 'example' => '{"${centerCount}": 5, "${distanceType}": "cityblock"}', - ], - 'Status' => [ - 'description' => 'The status of the trial.'."\n", - 'type' => 'string', - 'example' => 'UNKNOWN, RUNNING, WAITING, EARLY_STOPPED, SUCCEEDED, FAILED, USER_CANCELED, SYS_CANCELED', - ], - 'Model' => [ - 'description' => 'The storage location of the model generated by the backend task to which the trial belongs.'."\n", - 'type' => 'string', - 'example' => ' pai_kmeans_test_output_model_sy9zkpvc_zleam', - ], - 'MetricName' => [ - 'description' => 'Not used.'."\n", - 'type' => 'string', + 'Deleted' => ['description' => 'Indicates whether the experiment is deleted.'."\n", 'type' => 'boolean', 'example' => '1', 'title' => ''], + 'Tags' => [ + 'description' => 'Tag system list', + 'type' => 'array', + 'items' => [ + 'description' => 'Tag list', + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'Tag key of the resource', 'type' => 'string', 'example' => 'group', 'title' => ''], + 'Value' => ['description' => 'Tag value.', 'type' => 'string', 'example' => 'group_name', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', 'example' => '', ], - 'Metric' => [ - 'description' => 'The array of the results of the calculated metrics of the trial. The array includes one or more temporary values generated during the calculation and the final value.'."\n", - 'type' => 'string', - 'example' => '[{"default":9999.2,"type":"PERIODICAL","vrc":9999.2}, {"default":9999.2,"type":"FINAL","vrc":9999.2}', - ], - 'JobMeta' => [ - 'description' => 'The meta information of the backend task to which the trial belongs. The value is in the JSON string format.'."\n", - 'type' => 'string', - 'example' => '{"nni_trial_id": "ZLeAM", "nni_exp_id": "sy9zkpvc", "nni_trial_sequence_id": 0}', - ], - 'FinalMetric' => [ - 'description' => 'The final metric value calculated by the backend task after the trial is completed. The value is the value of the default key in the metric item of the FINAL type in the metric array.'."\n", - 'type' => 'string', - 'example' => '9999.2', - ], - 'GmtCreateTime' => [ - 'description' => 'The time at which the trial was created. The time is in UTC.'."\n", - 'type' => 'string', - 'example' => '2023-06-07T13:17:13Z', - ], - 'GmtModifiedTime' => [ - 'description' => 'The time at which the trial was last modified. The time is in UTC.'."\n", - 'type' => 'string', - 'example' => '2023-02-27T07:01:12Z', - ], ], - 'example' => '{"key": "value"}', - ], - ], - 'AccessDeniedDetail' => [ - 'description' => 'The details about the access denial. This parameter is returned only if RAM permission verification failed.'."\n", - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'example' => '{'."\n" - .' "AuthPrincipalType": "sub",'."\n" - .' "PolicyType": "AccountLevelIdentityBasedPolicy",'."\n" - .' "NoPermissionType": "NoPermission"'."\n" - .'}'."\n", - 'description' => 'The details about the access denial.'."\n", + 'title' => '', + 'example' => '', ], + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3F190916-B3E5-5D1E-AD0C-35C0DF105F51\\",\\n \\"Code\\": \\"INVALID_USER_OR_EXP\\",\\n \\"Message\\": \\"Missing \'user_id\' in request.\\",\\n \\"TotalCount\\": 5,\\n \\"Trials\\": [\\n {\\n \\"TrialId\\": \\"asdf\\",\\n \\"ExperimentId\\": \\"abcde\\",\\n \\"ParameterId\\": 0,\\n \\"Hyperparam\\": \\"{\\\\\\"${centerCount}\\\\\\": 5, \\\\\\"${distanceType}\\\\\\": \\\\\\"cityblock\\\\\\"}\\",\\n \\"Status\\": \\"UNKNOWN, RUNNING, WAITING, EARLY_STOPPED, SUCCEEDED, FAILED, USER_CANCELED, SYS_CANCELED\\",\\n \\"Model\\": \\" pai_kmeans_test_output_model_sy9zkpvc_zleam\\",\\n \\"MetricName\\": \\"空字符串\\",\\n \\"Metric\\": \\"[{\\\\\\"default\\\\\\":9999.2,\\\\\\"type\\\\\\":\\\\\\"PERIODICAL\\\\\\",\\\\\\"vrc\\\\\\":9999.2}, {\\\\\\"default\\\\\\":9999.2,\\\\\\"type\\\\\\":\\\\\\"FINAL\\\\\\",\\\\\\"vrc\\\\\\":9999.2}\\",\\n \\"JobMeta\\": \\"{\\\\\\"nni_trial_id\\\\\\": \\\\\\"ZLeAM\\\\\\", \\\\\\"nni_exp_id\\\\\\": \\\\\\"sy9zkpvc\\\\\\", \\\\\\"nni_trial_sequence_id\\\\\\": 0}\\",\\n \\"FinalMetric\\": \\"9999.2\\",\\n \\"GmtCreateTime\\": \\"2023-06-07T13:17:13Z\\",\\n \\"GmtModifiedTime\\": \\"2023-02-27T07:01:12Z\\"\\n }\\n ],\\n \\"AccessDeniedDetail\\": {\\n \\"key\\": \\"{\\\\n \\\\\\"AuthPrincipalType\\\\\\": \\\\\\"sub\\\\\\",\\\\n \\\\\\"PolicyType\\\\\\": \\\\\\"AccountLevelIdentityBasedPolicy\\\\\\",\\\\n \\\\\\"NoPermissionType\\\\\\": \\\\\\"NoPermission\\\\\\"\\\\n}\\\\n\\"\\n }\\n}","type":"json"}]', - 'title' => 'ListHpoTrials', - 'translator' => 'machine', - ], - 'GetHpoTrial' => [ - 'summary' => 'Queries information about a trial in a hyperparameter optimization (HPO) experiment.', - 'path' => '/api/automl/v1/hpo/experiment/{ExperimentId}/trial/{TrialId}', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3F190916-B3E5-5D1E-AD0C-35C0DF105F51\\",\\n \\"Code\\": \\"INVALID_INPUT_PARAMS\\",\\n \\"Message\\": \\"Missing \'user_id\' in request.\\",\\n \\"AccessDeniedDetail\\": {\\n \\"key\\": \\"{\\\\n \\\\\\"AuthPrincipalType\\\\\\": \\\\\\"sub\\\\\\",\\\\n \\\\\\"PolicyType\\\\\\": \\\\\\"AccountLevelIdentityBasedPolicy\\\\\\",\\\\n \\\\\\"NoPermissionType\\\\\\": \\\\\\"NoPermission\\\\\\"\\\\n}\\"\\n },\\n \\"TotalCount\\": 5,\\n \\"Experiments\\": [\\n {\\n \\"ExperimentId\\": \\"sORVEck\\",\\n \\"Creator\\": \\"1049310008714189\\",\\n \\"SearchSpace\\": \\"{\'foo\':\'bar\'}\\",\\n \\"Name\\": \\"my experiment x\\",\\n \\"Status\\": \\"CREATED, RUNNING, FINISHED, FAILED, EARLY_STOPPED, USER_CANCELED, WAITING, NO_MORE_TRIAL, UNKNOWN\\",\\n \\"JobType\\": \\"1\\",\\n \\"ConfigIni\\": \\"[odps_config]\\\\nkey1 = value1\\\\nkey2 = value2\\",\\n \\"ConfigYml\\": \\"experimentName: dlc_oss_mnist\\\\nexperimentWorkingDirectory: ../expdir\\\\nsearchSpaceFile: search_space.json\\\\ntrialCommand: python3 -m hpo_tools.core.utils.run --config=./trial.ini\\\\ntrialConcurrency: 1\\\\nmaxTrialNumber: 4\\\\ntuner:\\\\n name: TPE\\\\n classArgs:\\\\n optimize_mode: maximize\\\\ntrainingService:\\\\n platform: local\\\\nassessor:\\\\n name: PAIAssessor\\\\n classArgs:\\\\n optimize_mode: maximize\\\\n start_step: 2\\",\\n \\"GmtCreateTime\\": \\"2023-03-31T10:29:30Z\\",\\n \\"GmtModifiedTime\\": \\"2022-10-27T00:55:54Z\\",\\n \\"WorkspaceId\\": \\"default\\",\\n \\"Accessibility\\": \\"PUBLIC\\",\\n \\"Description\\": \\"description\\",\\n \\"TrialCount\\": 20,\\n \\"TrialStatus\\": {\\n \\"key\\": \\"3\\"\\n },\\n \\"Deleted\\": true,\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"group\\",\\n \\"Value\\": \\"group_name\\"\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'ListHpoExperiments', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'paiautoml:ListHpoExperiments', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIAutoML', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'ListHpoTrialCommands' => [ + 'summary' => 'Queries the command output of a trial in a hyperparameter optimization (HPO) experiment. A trial of an HPO experiment runs one or more commands in sequence based on the command set specified in the configuration. You can call this API operation to obtain the output of these commands.', + 'path' => '/api/automl/v1/hpo/experiment/{ExperimentId}/trial/{TrialId}/commands', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '192107', - 'abilityTreeNodes' => [ - 'FEATURElearn0UHCCK', - ], + 'abilityTreeCode' => '190369', + 'abilityTreeNodes' => ['FEATURElearn0UHCCK'], ], 'parameters' => [ [ 'name' => 'ExperimentId', 'in' => 'path', - 'schema' => [ - 'title' => '实验id。', - 'description' => 'The ID of the experiment.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'abcde', - ], + 'schema' => ['description' => 'The ID of the HPO experiment.'."\n", 'type' => 'string', 'required' => false, 'example' => 'abcde', 'title' => ''], ], [ 'name' => 'TrialId', 'in' => 'path', - 'schema' => [ - 'description' => 'trial id'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'mf99W4', - ], + 'schema' => ['description' => 'The ID of the trial.'."\n", 'type' => 'string', 'required' => false, 'example' => 'zUEapH', 'title' => ''], ], ], 'responses' => [ @@ -2835,180 +1473,95 @@ 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the POP request.'."\n", - 'type' => 'string', - 'example' => '3F190916-B3E5-5D1E-AD0C-35C0DF105F51', - ], - 'Code' => [ - 'title' => '响应状态。', - 'description' => 'The internal error code. This parameter is returned if an exception occurred.'."\n", - 'type' => 'string', - 'example' => 'INVALID_INPUT_PARAMS', - ], - 'Message' => [ - 'title' => '响应错误信息。只在响应出错时被设置。', - 'description' => 'The error message. This parameter is returned if an exception occurred.'."\n", - 'type' => 'string', - 'example' => 'Missing \'user_id\' in request.', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '071A904D-5A49-597F-9F69-81C7701D04AC'], + 'Code' => ['description' => 'The internal error code. This parameter is returned if an exception occurred.'."\n", 'type' => 'string', 'example' => 'INVALID_USER_OR_EXP', 'title' => ''], + 'Message' => ['description' => 'The error message. This parameter is returned if an exception occurred.'."\n", 'type' => 'string', 'example' => 'Missing \'user_id\' in request.', 'title' => ''], 'AccessDeniedDetail' => [ - 'description' => 'The details about the access denial.'."\n", + 'description' => 'The details about the failed permission verification.'."\n", 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'example' => '{'."\n" - .' "AuthPrincipalType": "sub",'."\n" - .' "PolicyType": "AccountLevelIdentityBasedPolicy",'."\n" - .' "NoPermissionType": "NoPermission"'."\n" - .'}'."\n", - 'description' => 'The details about the access denial.'."\n", - ], - ], - 'TrialId' => [ - 'description' => 'The ID of the trial.'."\n", - 'type' => 'string', - 'example' => 'mf99W4', - ], - 'ExperimentId' => [ - 'description' => 'The ID of the HPO experiment.'."\n", - 'type' => 'string', - 'example' => 'abcde', - ], - 'Model' => [ - 'description' => 'The storage location of the model generated by the backend task to which the trial belongs.'."\n", - 'type' => 'string', - 'example' => 'model_table_name_foo', - ], - 'Hyperparam' => [ - 'description' => 'The hyperparameter values of the trial.'."\n", - 'type' => 'string', - 'example' => '{"${centerCount}": 5, "${distanceType}": "cosine"}', - ], - 'ParameterId' => [ - 'description' => 'The ID assigned by the backend task to which the trial belongs.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'Status' => [ - 'description' => 'The status of the trial.'."\n", - 'type' => 'string', - 'example' => 'FINISHED, FAILED, USER_CANCELED', - ], - 'MetricName' => [ - 'description' => 'The name of the metric. Not used.'."\n", - 'type' => 'string', - 'example' => 'AUC or F1, Accuracy etc.', - ], - 'Metric' => [ - 'description' => 'The array of the results of the calculated metrics of the trial. The array includes one or more temporary values generated during the calculation and the final value.'."\n", - 'type' => 'string', - 'example' => '[{"default":0.087745,"val_loss=([0-9\\\\\\\\.]+)":0.087745},'."\n" - .'{"default":1.085841,"val_loss=([0-9\\\\\\\\.]+)":0.085841},'."\n" - .'{"default":0.087745,"type":"FINAL","val_loss=([0-9\\\\\\\\.]+)":0.087745}]', - ], - 'JobMeta' => [ - 'description' => 'The meta information of the backend task to which the trial belongs. The value is in the JSON string format.'."\n", - 'type' => 'string', - 'example' => '{"nni_trial_id": "asdf", "nni_exp_id": "abcde", "nni_trial_sequence_id": 2}', - ], - 'FinalMetric' => [ - 'description' => 'The final metric value calculated by the backend task after the trial is completed. The value is the value of the default key in the metric item of the FINAL type in the metric array.'."\n", - 'type' => 'string', - 'example' => '{"default":0.087745,"type":"FINAL","val_loss=([0-9\\\\\\\\.]+)":0.087745}', - ], - 'GmtCreateTime' => [ - 'description' => 'The time at which the trial was created. The time is in UTC.'."\n", - 'type' => 'string', - 'example' => '2024-01-02 12:34:56', + 'additionalProperties' => ['type' => 'string', 'example' => '{'."\n" + .' "AuthPrincipalType": "sub",'."\n" + .' "PolicyType": "AccountLevelIdentityBasedPolicy",'."\n" + .' "NoPermissionType": "NoPermission"'."\n" + .'}'."\n", 'description' => 'The details about the failed permission verification.'."\n", 'title' => ''], + 'title' => '', + 'example' => '', ], - 'GmtModifiedTime' => [ - 'description' => 'The time at which the trial was last modified. The time is in UTC.'."\n", - 'type' => 'string', - 'example' => '2024-01-02 21:32:56', + 'Commands' => [ + 'description' => 'The commands.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The struct of the commands.'."\n", + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'The sequence number.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Command' => ['description' => 'The content of the command.'."\n", 'type' => 'string', 'example' => 'dlc submit pytorch --name=test_nni_foo_bar', 'title' => ''], + 'Output' => ['description' => 'The output of the command.'."\n", 'type' => 'string', 'example' => 'foo', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3F190916-B3E5-5D1E-AD0C-35C0DF105F51\\",\\n \\"Code\\": \\"INVALID_INPUT_PARAMS\\",\\n \\"Message\\": \\"Missing \'user_id\' in request.\\",\\n \\"AccessDeniedDetail\\": {\\n \\"key\\": \\"{\\\\n \\\\\\"AuthPrincipalType\\\\\\": \\\\\\"sub\\\\\\",\\\\n \\\\\\"PolicyType\\\\\\": \\\\\\"AccountLevelIdentityBasedPolicy\\\\\\",\\\\n \\\\\\"NoPermissionType\\\\\\": \\\\\\"NoPermission\\\\\\"\\\\n}\\\\n\\"\\n },\\n \\"TrialId\\": \\"mf99W4\\",\\n \\"ExperimentId\\": \\"abcde\\",\\n \\"Model\\": \\"model_table_name_foo\\",\\n \\"Hyperparam\\": \\"{\\\\\\"${centerCount}\\\\\\": 5, \\\\\\"${distanceType}\\\\\\": \\\\\\"cosine\\\\\\"}\\",\\n \\"ParameterId\\": 0,\\n \\"Status\\": \\"FINISHED, FAILED, USER_CANCELED\\",\\n \\"MetricName\\": \\"空字符串\\",\\n \\"Metric\\": \\"[{\\\\\\"default\\\\\\":0.087745,\\\\\\"val_loss=([0-9\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\.]+)\\\\\\":0.087745},\\\\n{\\\\\\"default\\\\\\":1.085841,\\\\\\"val_loss=([0-9\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\.]+)\\\\\\":0.085841},\\\\n{\\\\\\"default\\\\\\":0.087745,\\\\\\"type\\\\\\":\\\\\\"FINAL\\\\\\",\\\\\\"val_loss=([0-9\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\.]+)\\\\\\":0.087745}]\\",\\n \\"JobMeta\\": \\"{\\\\\\"nni_trial_id\\\\\\": \\\\\\"asdf\\\\\\", \\\\\\"nni_exp_id\\\\\\": \\\\\\"abcde\\\\\\", \\\\\\"nni_trial_sequence_id\\\\\\": 2}\\",\\n \\"FinalMetric\\": \\"{\\\\\\"default\\\\\\":0.087745,\\\\\\"type\\\\\\":\\\\\\"FINAL\\\\\\",\\\\\\"val_loss=([0-9\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\.]+)\\\\\\":0.087745}\\",\\n \\"GmtCreateTime\\": \\"2024-01-02 12:34:56\\",\\n \\"GmtModifiedTime\\": \\"2024-01-02 21:32:56\\"\\n}","type":"json"}]', - 'title' => 'GetHpoTrial', - ], - 'StopHpoTrials' => [ - 'summary' => 'Stops specific trials in a hyperparameter optimization (HPO) experiment and the backend tasks of the trials.', - 'path' => '/api/automl/v1/hpo/experiment/{ExperimentId}/stop_trials', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"071A904D-5A49-597F-9F69-81C7701D04AC\\",\\n \\"Code\\": \\"INVALID_USER_OR_EXP\\",\\n \\"Message\\": \\"Missing \'user_id\' in request.\\",\\n \\"AccessDeniedDetail\\": {\\n \\"key\\": \\"{\\\\n \\\\\\"AuthPrincipalType\\\\\\": \\\\\\"sub\\\\\\",\\\\n \\\\\\"PolicyType\\\\\\": \\\\\\"AccountLevelIdentityBasedPolicy\\\\\\",\\\\n \\\\\\"NoPermissionType\\\\\\": \\\\\\"NoPermission\\\\\\"\\\\n}\\\\n\\"\\n },\\n \\"Commands\\": [\\n {\\n \\"Id\\": 1,\\n \\"Command\\": \\"dlc submit pytorch --name=test_nni_foo_bar\\",\\n \\"Output\\": \\"foo\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'ListHpoTrialCommands', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'paiautoml:ListHpoTrialCommands', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIAutoML', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'ListHpoTrialLogNames' => [ + 'summary' => 'Lists the names of all log files of the specific trial in a specific hyperparameter optimization (HPO) experiment.', + 'path' => '/api/automl/v1/hpo/experiment/{ExperimentId}/trial/{TrialId}/lognames', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '168050', - 'abilityTreeNodes' => [ - 'FEATURElearn0UHCCK', - ], + 'abilityTreeCode' => '189971', + 'abilityTreeNodes' => ['FEATURElearn0UHCCK'], ], 'parameters' => [ [ 'name' => 'ExperimentId', 'in' => 'path', - 'schema' => [ - 'title' => '实验id。', - 'description' => 'The ID of the experiment.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'abcde', - ], + 'schema' => ['description' => 'The ID of the HPO experiment.'."\n", 'type' => 'string', 'required' => true, 'example' => 'abcde', 'title' => ''], ], [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'description' => 'The body of the request.'."\n", - 'type' => 'object', - 'properties' => [ - 'TrialIds' => [ - 'title' => '需要被停止的trial ids。不填则不会有任何trial被停止。', - 'description' => 'The IDs of the trials that you want to stop. If you leave this parameter empty, no trial is stopped.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'trial id'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '[xrYq99, xrYq9N]', - ], - 'required' => false, - ], - ], - 'required' => false, - ], + 'name' => 'TrialId', + 'in' => 'path', + 'schema' => ['description' => 'Trial id'."\n", 'type' => 'string', 'required' => true, 'example' => 'zUEapH', 'title' => ''], ], ], 'responses' => [ @@ -3018,132 +1571,100 @@ 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'Code' => [ - 'title' => '响应状态。', - 'description' => 'The internal error code. This parameter is returned if an exception occurred.'."\n", - 'type' => 'string', - 'example' => 'INVALID_USER_OR_EXP', - ], - 'Message' => [ - 'title' => '响应错误信息。只在响应出错时被设置。', - 'description' => 'The error message. This parameter is returned if an exception occurred.'."\n", - 'type' => 'string', - 'example' => 'failed to stop any trial', - ], - 'Results' => [ - 'title' => '(trial id: 停止操作结果) map。', - 'description' => 'The information that contains the IDs and the status of the trials.'."\n", - 'type' => 'object', - 'example' => '{'."\n" - .' \'xrYq99\':\'successfully stopped trial,\','."\n" - .' \'xrYq9N\':\'failed to stop trial,\''."\n" - .'}', - ], - 'RequestId' => [ - 'description' => 'The ID of the POP request.'."\n", - 'type' => 'string', - 'example' => '071A904D-5A49-597F-9F69-81C7701D04AC', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the POP request.'."\n", 'type' => 'string', 'example' => '3F190916-B3E5-5D1E-AD0C-35C0DF105F51'], + 'Code' => ['description' => 'The internal error code. This parameter is returned if an exception occurred.'."\n", 'type' => 'string', 'example' => 'INVALID_INPUT_PARAMS', 'title' => ''], + 'Message' => ['description' => 'The error message. This parameter is returned if an exception occurred.'."\n", 'type' => 'string', 'example' => 'Missing \'user_id\' in request.', 'title' => ''], 'AccessDeniedDetail' => [ - 'description' => 'The details about the failed permission verification.'."\n", + 'description' => 'The details about the access denial.'."\n", 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'example' => '{'."\n" - .' "AuthPrincipalType": "sub",'."\n" - .' "PolicyType": "AccountLevelIdentityBasedPolicy",'."\n" - .' "NoPermissionType": "NoPermission"'."\n" - .'}'."\n", - 'description' => 'The details about the failed permission verification.'."\n", - ], + 'additionalProperties' => ['type' => 'string', 'example' => '{'."\n" + .' "AuthPrincipalType": "sub",'."\n" + .' "PolicyType": "AccountLevelIdentityBasedPolicy",'."\n" + .' "NoPermissionType": "NoPermission"'."\n" + .'}'."\n", 'description' => 'The details about the access denial.'."\n", 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'LogNames' => [ + 'description' => 'The log file paths.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The full path of the trial log file.'."\n", 'type' => 'string', 'example' => 'oss;//foo/bar/trial.log', 'title' => ''], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"INVALID_USER_OR_EXP\\",\\n \\"Message\\": \\"failed to stop any trial\\",\\n \\"Results\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"RequestId\\": \\"071A904D-5A49-597F-9F69-81C7701D04AC\\",\\n \\"AccessDeniedDetail\\": {\\n \\"key\\": \\"{\\\\n \\\\\\"AuthPrincipalType\\\\\\": \\\\\\"sub\\\\\\",\\\\n \\\\\\"PolicyType\\\\\\": \\\\\\"AccountLevelIdentityBasedPolicy\\\\\\",\\\\n \\\\\\"NoPermissionType\\\\\\": \\\\\\"NoPermission\\\\\\"\\\\n}\\\\n\\"\\n }\\n}","type":"json"}]', - 'title' => 'StopHpoTrials', - ], - 'RestartHpoTrials' => [ - 'summary' => 'Restarts failed trials in an hyperparameter optimization (HPO) experiment. The system extracts the configuration of the hyperparameters of a specific trial. If none of the trials that use this configuration are successful in the experiment, the system restarts trials by using this configuration.', - 'path' => '/api/automl/v1/hpo/experiment/{ExperimentId}/restart_trials', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3F190916-B3E5-5D1E-AD0C-35C0DF105F51\\",\\n \\"Code\\": \\"INVALID_INPUT_PARAMS\\",\\n \\"Message\\": \\"Missing \'user_id\' in request.\\",\\n \\"AccessDeniedDetail\\": {\\n \\"key\\": \\"{\\\\n \\\\\\"AuthPrincipalType\\\\\\": \\\\\\"sub\\\\\\",\\\\n \\\\\\"PolicyType\\\\\\": \\\\\\"AccountLevelIdentityBasedPolicy\\\\\\",\\\\n \\\\\\"NoPermissionType\\\\\\": \\\\\\"NoPermission\\\\\\"\\\\n}\\\\n\\"\\n },\\n \\"LogNames\\": [\\n \\"oss;//foo/bar/trial.log\\"\\n ]\\n}","type":"json"}]', + 'title' => 'ListHpoTrialLogNames', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'paiautoml:ListHpoTrialLogNames', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIAutoML', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'ListHpoTrialLogs' => [ + 'summary' => 'Lists the content of a specific log file of a hyperparameter optimization (HPO) trial by pages.', + 'path' => '/api/automl/v1/hpo/experiment/{ExperimentId}/trial/{TrialId}/logs', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '181335', - 'abilityTreeNodes' => [ - 'FEATURElearn0UHCCK', - ], + 'abilityTreeCode' => '195654', + 'abilityTreeNodes' => ['FEATURElearn0UHCCK'], ], 'parameters' => [ [ 'name' => 'ExperimentId', 'in' => 'path', - 'schema' => [ - 'title' => '实验id。', - 'description' => 'The ID of the experiment.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'abcde', - ], + 'schema' => ['description' => 'The ID of the HPO experiment.'."\n", 'type' => 'string', 'required' => false, 'example' => 'abcde', 'title' => ''], ], [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'description' => 'The request body. You must specify one of the TrialIds and TrialHyperParameters parameters. If you leave both parameters empty, no operation is performed on the server. If you specify both parameters, the TrialIds parameter prevails.'."\n", - 'type' => 'object', - 'properties' => [ - 'TrialIds' => [ - 'title' => '需要重新运行的trial ids。不填则会包括所有符合重新运行条件的trial ids。', - 'description' => 'The IDs of the trials that you want to restart.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'hpo trial ids'."\n", - 'type' => 'string', - 'required' => false, - 'example' => ' [xrYq99, xrYq9N]', - ], - 'required' => false, - ], - 'TrialHyperParameters' => [ - 'description' => 'A new hyperparameter configuration of a trial. The system starts a new trial by using this configuration.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '‘{"${batch_size}": "32", "${lr}": "0.01"}\'', - ], - ], - 'required' => false, - ], + 'name' => 'TrialId', + 'in' => 'path', + 'schema' => ['description' => 'The ID of the trial.'."\n", 'type' => 'string', 'required' => false, 'example' => 'asdf', 'title' => ''], + ], + [ + 'name' => 'LogName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the log. Valid values: stderr, stdout, and trial.log.'."\n", 'type' => 'string', 'required' => false, 'example' => 'trial.log', 'title' => ''], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => 'The page number. Pages start from page 1. If you leave this parameter empty, all content in the log file is returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of log entries returned on each page. The value must be a positive integer. If you leave this parameter empty, all content in the log file is returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], ], 'responses' => [ @@ -3153,109 +1674,100 @@ 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the POP request.'."\n", - 'type' => 'string', - 'example' => '3F190916-B3E5-5D1E-AD0C-35C0DF105F51', - ], - 'Code' => [ - 'description' => 'The internal error code. This parameter is returned if an exception occurred.'."\n", - 'type' => 'string', - 'example' => 'INVALID_USER_OR_EXP', - ], - 'Message' => [ - 'title' => '响应错误信息。只在响应出错时被设置。', - 'description' => 'The error message. This parameter is returned if an exception occurred.'."\n", - 'type' => 'string', - 'example' => 'Missing \'user_id\' in request.', - ], - 'AccessDeniedDetail' => [ - 'description' => 'The details about the failed permission verification.'."\n", - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'example' => '{'."\n" - .' "AuthPrincipalType": "sub",'."\n" - .' "PolicyType": "AccountLevelIdentityBasedPolicy",'."\n" - .' "NoPermissionType": "NoPermission"'."\n" - .'}'."\n", - 'description' => 'The details about the failed permission verification.'."\n", - ], - ], - 'Results' => [ - 'title' => '(trial id: 重启状态) mapping。', - 'description' => 'The information that contains the trial ID and the trial status.'."\n", - 'type' => 'object', - 'example' => '{'."\n" - .'\'xrYq99\': TrialJobInfo text,'."\n" - .'\'xrYq9N\':TrialJobInfo text'."\n" - .'}', + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the POP request.'."\n", 'type' => 'string', 'example' => '3F190916-B3E5-5D1E-AD0C-35C0DF105F51'], + 'Code' => ['description' => 'The status code.'."\n", 'type' => 'string', 'example' => 'SUCCESS', 'title' => ''], + 'Message' => ['description' => 'Response error message.'."\n", 'type' => 'string', 'example' => 'Missing \'user_id\' in request.', 'title' => ''], + 'AccessDeniedDetail' => ['description' => 'The details about the failed permission verification.'."\n", 'type' => 'object', 'example' => '{'."\n" + .' "AuthPrincipalType": "sub",'."\n" + .' "PolicyType": "AccountLevelIdentityBasedPolicy",'."\n" + .' "NoPermissionType": "NoPermission"'."\n" + .'}', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of entries in the log file.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '123', 'title' => ''], + 'Logs' => [ + 'description' => 'The content of the log entry.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The content of the log entry.'."\n", 'type' => 'string', 'example' => '[2024-03-07 18:41:00] INFO (sys/MainThread) system_config loaded for region. cn-shanghai', 'title' => ''], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3F190916-B3E5-5D1E-AD0C-35C0DF105F51\\",\\n \\"Code\\": \\"INVALID_USER_OR_EXP\\",\\n \\"Message\\": \\"Missing \'user_id\' in request.\\",\\n \\"AccessDeniedDetail\\": {\\n \\"key\\": \\"{\\\\n \\\\\\"AuthPrincipalType\\\\\\": \\\\\\"sub\\\\\\",\\\\n \\\\\\"PolicyType\\\\\\": \\\\\\"AccountLevelIdentityBasedPolicy\\\\\\",\\\\n \\\\\\"NoPermissionType\\\\\\": \\\\\\"NoPermission\\\\\\"\\\\n}\\\\n\\"\\n },\\n \\"Results\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n}","type":"json"}]', - 'title' => 'RestartHpoTrials', - ], - 'ListHpoTrialLogNames' => [ - 'summary' => 'Lists the names of all log files of the specific trial in a specific hyperparameter optimization (HPO) experiment.', - 'path' => '/api/automl/v1/hpo/experiment/{ExperimentId}/trial/{TrialId}/lognames', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3F190916-B3E5-5D1E-AD0C-35C0DF105F51\\",\\n \\"Code\\": \\"SUCCESS\\",\\n \\"Message\\": \\"Missing \'user_id\' in request.\\",\\n \\"AccessDeniedDetail\\": {\\n \\"AuthPrincipalType\\": \\"sub\\",\\n \\"PolicyType\\": \\"AccountLevelIdentityBasedPolicy\\",\\n \\"NoPermissionType\\": \\"NoPermission\\"\\n },\\n \\"TotalCount\\": 123,\\n \\"Logs\\": [\\n \\"[2024-03-07 18:41:00] INFO (sys/MainThread) system_config loaded for region. cn-shanghai\\"\\n ]\\n}","type":"json"}]', + 'title' => 'ListHpoTrialLogs', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'paiautoml:ListHpoTrialLogs', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIAutoML', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'ListHpoTrials' => [ + 'summary' => 'Returns all the trials for the specified experiment ID.', + 'path' => '/api/automl/v1/hpo/experiment/{ExperimentId}/trials', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '189971', - 'abilityTreeNodes' => [ - 'FEATURElearn0UHCCK', - ], + 'abilityTreeCode' => '190695', + 'abilityTreeNodes' => ['FEATURElearn0UHCCK'], ], 'parameters' => [ [ 'name' => 'ExperimentId', 'in' => 'path', - 'schema' => [ - 'description' => 'The ID of the HPO experiment.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'abcde', - ], + 'schema' => ['description' => 'The ID of the HPO experiment.'."\n", 'type' => 'string', 'required' => false, 'example' => 'abcde', 'title' => ''], ], [ - 'name' => 'TrialId', - 'in' => 'path', - 'schema' => [ - 'description' => 'Trial id'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'zUEapH', - ], + 'name' => 'PageNumber', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => ['description' => 'The page number to return. Pages start from 1. You can use this parameter to search for HPO experiments.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => ['title' => '10', 'description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], + ], + [ + 'name' => 'SortBy', + 'in' => 'query', + 'schema' => ['description' => 'The basis for sorting.'."\n", 'type' => 'string', 'required' => false, 'example' => 'FINAL_METRIC 或着 CREATE_TIME', 'title' => ''], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => ['description' => 'The order of specific fields of results in a paged query (ascending or descending). Default value: ASC.'."\n" + ."\n" + .'* ASC Ascend'."\n" + .'* DESC Descend'."\n", 'type' => 'string', 'required' => false, 'example' => 'ASC', 'title' => ''], ], ], 'responses' => [ @@ -3265,141 +1777,122 @@ 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the POP request.'."\n", - 'type' => 'string', - 'example' => '3F190916-B3E5-5D1E-AD0C-35C0DF105F51', - ], - 'Code' => [ - 'description' => 'The internal error code. This parameter is returned if an exception occurred.'."\n", - 'type' => 'string', - 'example' => 'INVALID_INPUT_PARAMS', - ], - 'Message' => [ - 'description' => 'The error message. This parameter is returned if an exception occurred.'."\n", - 'type' => 'string', - 'example' => 'Missing \'user_id\' in request.', - ], - 'AccessDeniedDetail' => [ - 'description' => 'The details about the access denial.'."\n", - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'example' => '{'."\n" - .' "AuthPrincipalType": "sub",'."\n" - .' "PolicyType": "AccountLevelIdentityBasedPolicy",'."\n" - .' "NoPermissionType": "NoPermission"'."\n" - .'}'."\n", - 'description' => 'The details about the access denial.'."\n", - ], - ], - 'LogNames' => [ - 'description' => 'The log file paths.'."\n", + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '3F190916-B3E5-5D1E-AD0C-35C0DF105F51'], + 'Code' => ['description' => 'The internal error code. This parameter is returned if an exception occurred.'."\n", 'type' => 'string', 'example' => 'INVALID_USER_OR_EXP', 'title' => ''], + 'Message' => ['description' => 'The error message. This parameter is returned if an exception occurred.'."\n", 'type' => 'string', 'example' => 'Missing \'user_id\' in request.', 'title' => ''], + 'TotalCount' => ['title' => '', 'description' => 'The total number of entries returned. By default, this parameter is not returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '5'], + 'Trials' => [ + 'description' => 'Data structs of the trial.'."\n", 'type' => 'array', 'items' => [ - 'description' => 'The full path of the trial log file.'."\n", - 'type' => 'string', - 'example' => 'oss;//foo/bar/trial.log', + 'description' => 'The struct of the trial.'."\n", + 'type' => 'object', + 'properties' => [ + 'TrialId' => ['description' => 'The ID of the trial.'."\n", 'type' => 'string', 'example' => 'asdf', 'title' => ''], + 'ExperimentId' => ['description' => 'The ID of the HPO experiment.'."\n", 'type' => 'string', 'example' => 'abcde', 'title' => ''], + 'ParameterId' => ['description' => 'The ID assigned by the backend task to which the trial belongs.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '未使用。空字符串', 'title' => ''], + 'Hyperparam' => ['description' => 'The hyperparameter values of the trial.'."\n", 'type' => 'string', 'example' => '{"${centerCount}": 5, "${distanceType}": "cityblock"}', 'title' => ''], + 'Status' => ['description' => 'The status of the trial.'."\n", 'type' => 'string', 'example' => 'UNKNOWN, RUNNING, WAITING, EARLY_STOPPED, SUCCEEDED, FAILED, USER_CANCELED, SYS_CANCELED', 'title' => ''], + 'Model' => ['description' => 'The storage location of the model generated by the backend task to which the trial belongs.'."\n", 'type' => 'string', 'example' => ' pai_kmeans_test_output_model_sy9zkpvc_zleam', 'title' => ''], + 'MetricName' => ['description' => 'Not used.'."\n", 'type' => 'string', 'example' => '空字符串', 'title' => ''], + 'Metric' => ['description' => 'The array of the results of the calculated metrics of the trial. The array includes one or more temporary values generated during the calculation and the final value.'."\n", 'type' => 'string', 'example' => '[{"default":9999.2,"type":"PERIODICAL","vrc":9999.2}, {"default":9999.2,"type":"FINAL","vrc":9999.2}', 'title' => ''], + 'JobMeta' => ['description' => 'The meta information of the backend task to which the trial belongs. The value is in the JSON string format.'."\n", 'type' => 'string', 'example' => '{"nni_trial_id": "ZLeAM", "nni_exp_id": "sy9zkpvc", "nni_trial_sequence_id": 0}', 'title' => ''], + 'FinalMetric' => ['description' => 'The final metric value calculated by the backend task after the trial is completed. The value is the value of the default key in the metric item of the FINAL type in the metric array.'."\n", 'type' => 'string', 'example' => '9999.2', 'title' => ''], + 'GmtCreateTime' => ['description' => 'The time at which the trial was created. The time is in UTC.'."\n", 'type' => 'string', 'example' => '2023-06-07T13:17:13Z', 'title' => ''], + 'GmtModifiedTime' => ['description' => 'The time at which the trial was last modified. The time is in UTC.'."\n", 'type' => 'string', 'example' => '2023-02-27T07:01:12Z', 'title' => ''], + ], + 'example' => '{"key": "value"}', + 'title' => '', ], + 'title' => '', + 'example' => '', + ], + 'AccessDeniedDetail' => [ + 'description' => 'The details about the access denial. This parameter is returned only if RAM permission verification failed.'."\n", + 'type' => 'object', + 'additionalProperties' => ['type' => 'string', 'example' => '{'."\n" + .' "AuthPrincipalType": "sub",'."\n" + .' "PolicyType": "AccountLevelIdentityBasedPolicy",'."\n" + .' "NoPermissionType": "NoPermission"'."\n" + .'}'."\n", 'description' => 'The details about the access denial.'."\n", 'title' => ''], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3F190916-B3E5-5D1E-AD0C-35C0DF105F51\\",\\n \\"Code\\": \\"INVALID_INPUT_PARAMS\\",\\n \\"Message\\": \\"Missing \'user_id\' in request.\\",\\n \\"AccessDeniedDetail\\": {\\n \\"key\\": \\"{\\\\n \\\\\\"AuthPrincipalType\\\\\\": \\\\\\"sub\\\\\\",\\\\n \\\\\\"PolicyType\\\\\\": \\\\\\"AccountLevelIdentityBasedPolicy\\\\\\",\\\\n \\\\\\"NoPermissionType\\\\\\": \\\\\\"NoPermission\\\\\\"\\\\n}\\\\n\\"\\n },\\n \\"LogNames\\": [\\n \\"oss;//foo/bar/trial.log\\"\\n ]\\n}","type":"json"}]', - 'title' => 'ListHpoTrialLogNames', - ], - 'ListHpoTrialLogs' => [ - 'summary' => 'Lists the content of a specific log file of a hyperparameter optimization (HPO) trial by pages.', - 'path' => '/api/automl/v1/hpo/experiment/{ExperimentId}/trial/{TrialId}/logs', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3F190916-B3E5-5D1E-AD0C-35C0DF105F51\\",\\n \\"Code\\": \\"INVALID_USER_OR_EXP\\",\\n \\"Message\\": \\"Missing \'user_id\' in request.\\",\\n \\"TotalCount\\": 5,\\n \\"Trials\\": [\\n {\\n \\"TrialId\\": \\"asdf\\",\\n \\"ExperimentId\\": \\"abcde\\",\\n \\"ParameterId\\": 0,\\n \\"Hyperparam\\": \\"{\\\\\\"${centerCount}\\\\\\": 5, \\\\\\"${distanceType}\\\\\\": \\\\\\"cityblock\\\\\\"}\\",\\n \\"Status\\": \\"UNKNOWN, RUNNING, WAITING, EARLY_STOPPED, SUCCEEDED, FAILED, USER_CANCELED, SYS_CANCELED\\",\\n \\"Model\\": \\" pai_kmeans_test_output_model_sy9zkpvc_zleam\\",\\n \\"MetricName\\": \\"空字符串\\",\\n \\"Metric\\": \\"[{\\\\\\"default\\\\\\":9999.2,\\\\\\"type\\\\\\":\\\\\\"PERIODICAL\\\\\\",\\\\\\"vrc\\\\\\":9999.2}, {\\\\\\"default\\\\\\":9999.2,\\\\\\"type\\\\\\":\\\\\\"FINAL\\\\\\",\\\\\\"vrc\\\\\\":9999.2}\\",\\n \\"JobMeta\\": \\"{\\\\\\"nni_trial_id\\\\\\": \\\\\\"ZLeAM\\\\\\", \\\\\\"nni_exp_id\\\\\\": \\\\\\"sy9zkpvc\\\\\\", \\\\\\"nni_trial_sequence_id\\\\\\": 0}\\",\\n \\"FinalMetric\\": \\"9999.2\\",\\n \\"GmtCreateTime\\": \\"2023-06-07T13:17:13Z\\",\\n \\"GmtModifiedTime\\": \\"2023-02-27T07:01:12Z\\"\\n }\\n ],\\n \\"AccessDeniedDetail\\": {\\n \\"key\\": \\"{\\\\n \\\\\\"AuthPrincipalType\\\\\\": \\\\\\"sub\\\\\\",\\\\n \\\\\\"PolicyType\\\\\\": \\\\\\"AccountLevelIdentityBasedPolicy\\\\\\",\\\\n \\\\\\"NoPermissionType\\\\\\": \\\\\\"NoPermission\\\\\\"\\\\n}\\\\n\\"\\n }\\n}","type":"json"}]', + 'title' => 'ListHpoTrials', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'paiautoml:ListHpoTrials', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIAutoML', 'resourceType' => 'HpoExperiment', 'arn' => 'acs:paiautoml:{#regionId}:{#accountId}:hpoexperiment/{#HpoExperimentId}'], + ], + ], + ], ], + ], + 'RestartHpoTrials' => [ + 'summary' => 'Restarts failed trials in an hyperparameter optimization (HPO) experiment. The system extracts the configuration of the hyperparameters of a specific trial. If none of the trials that use this configuration are successful in the experiment, the system restarts trials by using this configuration.', + 'path' => '/api/automl/v1/hpo/experiment/{ExperimentId}/restart_trials', + 'methods' => ['put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '195654', - 'abilityTreeNodes' => [ - 'FEATURElearn0UHCCK', - ], + 'abilityTreeCode' => '181335', + 'abilityTreeNodes' => ['FEATURElearn0UHCCK'], ], 'parameters' => [ [ 'name' => 'ExperimentId', 'in' => 'path', - 'schema' => [ - 'description' => 'The ID of the HPO experiment.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'abcde', - ], - ], - [ - 'name' => 'TrialId', - 'in' => 'path', - 'schema' => [ - 'description' => 'The ID of the trial.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'asdf', - ], + 'schema' => ['title' => '', 'description' => 'The ID of the experiment.'."\n", 'type' => 'string', 'required' => false, 'example' => 'abcde'], ], [ - 'name' => 'LogName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the log. Valid values: stderr, stdout, and trial.log.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'trial.log', - ], - ], - [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => 'The page number. Pages start from page 1. If you leave this parameter empty, all content in the log file is returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - ], - [ - 'name' => 'PageSize', - 'in' => 'query', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => 'The number of log entries returned on each page. The value must be a positive integer. If you leave this parameter empty, all content in the log file is returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', + 'description' => 'The request body. You must specify one of the TrialIds and TrialHyperParameters parameters. If you leave both parameters empty, no operation is performed on the server. If you specify both parameters, the TrialIds parameter prevails.'."\n", + 'type' => 'object', + 'properties' => [ + 'TrialIds' => [ + 'title' => '', + 'description' => 'The IDs of the trials that you want to restart.'."\n", + 'type' => 'array', + 'items' => ['description' => 'hpo trial ids'."\n", 'type' => 'string', 'required' => false, 'example' => ' [xrYq99, xrYq9N]', 'title' => ''], + 'required' => false, + 'example' => '', + ], + 'TrialHyperParameters' => ['description' => 'A new hyperparameter configuration of a trial. The system starts a new trial by using this configuration.'."\n", 'type' => 'string', 'required' => false, 'example' => '‘{"${batch_size}": "32", "${lr}": "0.01"}\'', 'title' => ''], + ], 'required' => false, - 'example' => '10', + 'title' => '', + 'example' => '', ], ], ], @@ -3410,111 +1903,77 @@ 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the POP request.'."\n", - 'type' => 'string', - 'example' => '3F190916-B3E5-5D1E-AD0C-35C0DF105F51', - ], - 'Code' => [ - 'description' => 'The status code.'."\n", - 'type' => 'string', - 'example' => 'SUCCESS', - ], - 'Message' => [ - 'description' => 'Response error message.'."\n", - 'type' => 'string', - 'example' => 'Missing \'user_id\' in request.', - ], + 'RequestId' => ['description' => 'The ID of the POP request.'."\n", 'type' => 'string', 'example' => '3F190916-B3E5-5D1E-AD0C-35C0DF105F51', 'title' => ''], + 'Code' => ['description' => 'The internal error code. This parameter is returned if an exception occurred.'."\n", 'type' => 'string', 'example' => 'INVALID_USER_OR_EXP', 'title' => ''], + 'Message' => ['title' => '', 'description' => 'The error message. This parameter is returned if an exception occurred.'."\n", 'type' => 'string', 'example' => 'Missing \'user_id\' in request.'], 'AccessDeniedDetail' => [ 'description' => 'The details about the failed permission verification.'."\n", 'type' => 'object', - 'example' => '{'."\n" + 'additionalProperties' => ['type' => 'string', 'example' => '{'."\n" .' "AuthPrincipalType": "sub",'."\n" .' "PolicyType": "AccountLevelIdentityBasedPolicy",'."\n" .' "NoPermissionType": "NoPermission"'."\n" - .'}', - ], - 'TotalCount' => [ - 'description' => 'The total number of entries in the log file.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '123', - ], - 'Logs' => [ - 'description' => 'The content of the log entry.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The content of the log entry.'."\n", - 'type' => 'string', - 'example' => '[2024-03-07 18:41:00] INFO (sys/MainThread) system_config loaded for region. cn-shanghai', - ], - ], + .'}'."\n", 'description' => 'The details about the failed permission verification.'."\n", 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'Results' => ['title' => '', 'description' => 'The information that contains the trial ID and the trial status.'."\n", 'type' => 'object', 'example' => '{'."\n" + .'\'xrYq99\': TrialJobInfo text,'."\n" + .'\'xrYq9N\':TrialJobInfo text'."\n" + .'}'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3F190916-B3E5-5D1E-AD0C-35C0DF105F51\\",\\n \\"Code\\": \\"SUCCESS\\",\\n \\"Message\\": \\"Missing \'user_id\' in request.\\",\\n \\"AccessDeniedDetail\\": {\\n \\"AuthPrincipalType\\": \\"sub\\",\\n \\"PolicyType\\": \\"AccountLevelIdentityBasedPolicy\\",\\n \\"NoPermissionType\\": \\"NoPermission\\"\\n },\\n \\"TotalCount\\": 123,\\n \\"Logs\\": [\\n \\"[2024-03-07 18:41:00] INFO (sys/MainThread) system_config loaded for region. cn-shanghai\\"\\n ]\\n}","type":"json"}]', - 'title' => 'ListHpoTrialLogs', - ], - 'ListHpoTrialCommands' => [ - 'summary' => 'Queries the command output of a trial in a hyperparameter optimization (HPO) experiment. A trial of an HPO experiment runs one or more commands in sequence based on the command set specified in the configuration. You can call this API operation to obtain the output of these commands.', - 'path' => '/api/automl/v1/hpo/experiment/{ExperimentId}/trial/{TrialId}/commands', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3F190916-B3E5-5D1E-AD0C-35C0DF105F51\\",\\n \\"Code\\": \\"INVALID_USER_OR_EXP\\",\\n \\"Message\\": \\"Missing \'user_id\' in request.\\",\\n \\"AccessDeniedDetail\\": {\\n \\"key\\": \\"{\\\\n \\\\\\"AuthPrincipalType\\\\\\": \\\\\\"sub\\\\\\",\\\\n \\\\\\"PolicyType\\\\\\": \\\\\\"AccountLevelIdentityBasedPolicy\\\\\\",\\\\n \\\\\\"NoPermissionType\\\\\\": \\\\\\"NoPermission\\\\\\"\\\\n}\\\\n\\"\\n },\\n \\"Results\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n}","type":"json"}]', + 'title' => 'RestartHpoTrials', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'paiautoml:RestartHpoTrials', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIAutoML', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'StopHpoExperiment' => [ + 'summary' => 'Stops a hyperparameter optimization (HPO) experiment, including its trials and the backend tasks.', + 'path' => '/api/automl/v1/hpo/experiment/{ExperimentId}/stop', + 'methods' => ['put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '190369', - 'abilityTreeNodes' => [ - 'FEATURElearn0UHCCK', - ], + 'abilityTreeCode' => '162610', + 'abilityTreeNodes' => ['FEATURElearn0UHCCK'], ], 'parameters' => [ [ 'name' => 'ExperimentId', 'in' => 'path', - 'schema' => [ - 'description' => 'The ID of the HPO experiment.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'abcde', - ], - ], - [ - 'name' => 'TrialId', - 'in' => 'path', - 'schema' => [ - 'description' => 'The ID of the trial.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zUEapH', - ], + 'schema' => ['title' => '需要被停止的实验的id。', 'description' => 'The ID of the experiment that you want to stop.'."\n", 'type' => 'string', 'required' => true, 'example' => 'abcde'], ], ], 'responses' => [ @@ -3524,175 +1983,96 @@ 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '071A904D-5A49-597F-9F69-81C7701D04AC', - ], - 'Code' => [ - 'description' => 'The internal error code. This parameter is returned if an exception occurred.'."\n", - 'type' => 'string', - 'example' => 'INVALID_USER_OR_EXP', - ], - 'Message' => [ - 'description' => 'The error message. This parameter is returned if an exception occurred.'."\n", - 'type' => 'string', - 'example' => 'Missing \'user_id\' in request.', - ], + 'ExpId' => ['title' => '', 'description' => 'The ID of the experiment.'."\n", 'type' => 'string', 'example' => 'abcde'], + 'Code' => ['title' => '', 'description' => 'The internal error code. This parameter is returned if an exception occurred.'."\n", 'type' => 'string', 'example' => 'INVALID_INPUT_PARAMS'], + 'Message' => ['title' => '', 'description' => 'The error message. This parameter is returned if an exception occurred.'."\n", 'type' => 'string', 'example' => 'Missing \'user_id\' in request.'], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '071A904D-5A49-597F-9F69-81C7701D04AC', 'title' => ''], 'AccessDeniedDetail' => [ - 'description' => 'The details about the failed permission verification.'."\n", + 'description' => 'The details about the access denial.'."\n", 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'example' => '{'."\n" - .' "AuthPrincipalType": "sub",'."\n" - .' "PolicyType": "AccountLevelIdentityBasedPolicy",'."\n" - .' "NoPermissionType": "NoPermission"'."\n" - .'}'."\n", - 'description' => 'The details about the failed permission verification.'."\n", - ], - ], - 'Commands' => [ - 'description' => 'The commands.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The struct of the commands.'."\n", - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => 'The sequence number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Command' => [ - 'description' => 'The content of the command.'."\n", - 'type' => 'string', - 'example' => 'dlc submit pytorch --name=test_nni_foo_bar', - ], - 'Output' => [ - 'description' => 'The output of the command.'."\n", - 'type' => 'string', - 'example' => 'dlc job submitted.', - ], - ], - ], + 'additionalProperties' => ['type' => 'string', 'example' => '{'."\n" + .' "AuthPrincipalType": "sub",'."\n" + .' "PolicyType": "AccountLevelIdentityBasedPolicy",'."\n" + .' "NoPermissionType": "NoPermission"'."\n" + .'}'."\n", 'description' => 'The details about the access denial.'."\n", 'title' => ''], + 'title' => '', + 'example' => '', ], + 'Status' => ['description' => 'Current expriment status.', 'type' => 'string', 'example' => 'TERMINATING, USER_CANCELED', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"071A904D-5A49-597F-9F69-81C7701D04AC\\",\\n \\"Code\\": \\"INVALID_USER_OR_EXP\\",\\n \\"Message\\": \\"Missing \'user_id\' in request.\\",\\n \\"AccessDeniedDetail\\": {\\n \\"key\\": \\"{\\\\n \\\\\\"AuthPrincipalType\\\\\\": \\\\\\"sub\\\\\\",\\\\n \\\\\\"PolicyType\\\\\\": \\\\\\"AccountLevelIdentityBasedPolicy\\\\\\",\\\\n \\\\\\"NoPermissionType\\\\\\": \\\\\\"NoPermission\\\\\\"\\\\n}\\\\n\\"\\n },\\n \\"Commands\\": [\\n {\\n \\"Id\\": 1,\\n \\"Command\\": \\"dlc submit pytorch --name=test_nni_foo_bar\\",\\n \\"Output\\": \\"foo\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => 'ListHpoTrialCommands', - ], - 'CreateAutofeExperiment' => [ - 'summary' => 'CreateAutofeExperiment', - 'path' => '/api/automl/v1/autofe/experiment', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ExpId\\": \\"abcde\\",\\n \\"Code\\": \\"INVALID_INPUT_PARAMS\\",\\n \\"Message\\": \\"Missing \'user_id\' in request.\\",\\n \\"RequestId\\": \\"071A904D-5A49-597F-9F69-81C7701D04AC\\",\\n \\"AccessDeniedDetail\\": {\\n \\"key\\": \\"{\\\\n \\\\\\"AuthPrincipalType\\\\\\": \\\\\\"sub\\\\\\",\\\\n \\\\\\"PolicyType\\\\\\": \\\\\\"AccountLevelIdentityBasedPolicy\\\\\\",\\\\n \\\\\\"NoPermissionType\\\\\\": \\\\\\"NoPermission\\\\\\"\\\\n}\\\\n\\"\\n },\\n \\"Status\\": \\"TERMINATING, USER_CANCELED\\"\\n}","type":"json"}]', + 'title' => 'StopHpoExperiment', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'paiautoml:StopHpoExperiment', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIAutoML', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'StopHpoTrials' => [ + 'summary' => 'Stops specific trials in a hyperparameter optimization (HPO) experiment and the backend tasks of the trials.', + 'path' => '/api/automl/v1/hpo/experiment/{ExperimentId}/stop_trials', + 'methods' => ['put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '162654', - 'abilityTreeNodes' => [ - 'FEATURElearn0UHCCK', - ], + 'abilityTreeCode' => '168050', + 'abilityTreeNodes' => ['FEATURElearn0UHCCK'], ], 'parameters' => [ [ + 'name' => 'ExperimentId', + 'in' => 'path', + 'schema' => ['title' => '', 'description' => 'The ID of the experiment.'."\n", 'type' => 'string', 'required' => false, 'example' => 'abcde'], + ], + [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => 'The request body.'."\n", + 'description' => 'The body of the request.'."\n", 'type' => 'object', 'properties' => [ - 'Name' => [ - 'description' => 'The name of the experiment.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'my experiment x', - ], - 'AutofeExperimentConfiguration' => [ - 'description' => 'The AutoFE experiment required configurations.', - 'required' => false, - '$ref' => '#/components/schemas/AutofeExperimentConfiguration', - ], - 'Description' => [ - 'description' => 'The description of the experiment.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'This is an AutoFE experiment.', - ], - 'Accessibility' => [ - 'description' => 'The visibility of the experiment in the workspace. Valid values:'."\n" - ."\n" - .'* PRIVATE: The experiment is visible only to you and the administrator of the workspace.'."\n" - .'* PUBLIC: The experiment is public in the workspace.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'PUBLIC', - ], - 'WorkspaceId' => [ - 'description' => 'The workspace ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '283301', - ], - 'Tag' => [ + 'TrialIds' => [ + 'title' => '', + 'description' => 'The IDs of the trials that you want to stop. If you leave this parameter empty, no trial is stopped.'."\n", 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'type' => 'string', - 'required' => false, - 'description' => 'The key of the tag.'."\n", - 'example' => 'group', - ], - 'Value' => [ - 'type' => 'string', - 'required' => false, - 'description' => 'The value of the tag.', - 'example' => 'group_name', - ], - ], - 'required' => false, - 'description' => 'The tag list.', - ], + 'items' => ['description' => 'trial id'."\n", 'type' => 'string', 'required' => false, 'example' => '[xrYq99, xrYq9N]', 'title' => ''], 'required' => false, - 'maxItems' => 20, - 'description' => 'The list of tags. You can specify a maximum of 20 tags.'."\n", + 'example' => '', ], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], @@ -3700,229 +2080,421 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'Message' => [ - 'description' => 'The error message. This parameter is returned if an exception occurred.'."\n", - 'type' => 'string', - 'example' => 'Missing \'user_id\' in request.', - ], - 'Code' => [ - 'description' => 'The internal error code. This parameter is returned if an exception occurred.'."\n", - 'type' => 'string', - 'example' => 'INVALID_INPUT_PARAMS', - ], - 'ExperimentId' => [ - 'description' => 'The ID of the experiment.'."\n", - 'type' => 'string', - 'example' => 't8cNdMO', - ], - 'RequestId' => [ - 'description' => 'The ID of the POP request.'."\n", - 'type' => 'string', - 'example' => '22A1EC4E-15A2-51FF-BFA3-10D6735BAA69', - ], - 'Detail' => [ - 'description' => 'The detailed information about the request error.'."\n", + 'Code' => ['title' => '', 'description' => 'The internal error code. This parameter is returned if an exception occurred.'."\n", 'type' => 'string', 'example' => 'INVALID_USER_OR_EXP'], + 'Message' => ['title' => '', 'description' => 'The error message. This parameter is returned if an exception occurred.'."\n", 'type' => 'string', 'example' => 'failed to stop any trial'], + 'Results' => ['title' => '', 'description' => 'The information that contains the IDs and the status of the trials.'."\n", 'type' => 'object', 'example' => '{'."\n" + .' \'xrYq99\':\'successfully stopped trial,\','."\n" + .' \'xrYq9N\':\'failed to stop trial,\''."\n" + .'}'], + 'RequestId' => ['description' => 'The ID of the POP request.'."\n", 'type' => 'string', 'example' => '071A904D-5A49-597F-9F69-81C7701D04AC', 'title' => ''], + 'AccessDeniedDetail' => [ + 'description' => 'The details about the failed permission verification.'."\n", 'type' => 'object', - 'example' => '{}', + 'additionalProperties' => ['type' => 'string', 'example' => '{'."\n" + .' "AuthPrincipalType": "sub",'."\n" + .' "PolicyType": "AccountLevelIdentityBasedPolicy",'."\n" + .' "NoPermissionType": "NoPermission"'."\n" + .'}'."\n", 'description' => 'The details about the failed permission verification.'."\n", 'title' => ''], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"Missing \'user_id\' in request.\\",\\n \\"Code\\": \\"INVALID_INPUT_PARAMS\\",\\n \\"ExperimentId\\": \\"t8cNdMO\\",\\n \\"RequestId\\": \\"22A1EC4E-15A2-51FF-BFA3-10D6735BAA69\\",\\n \\"Detail\\": {}\\n}","type":"json"}]', - 'title' => 'CreateAutofeExperiment', - 'translator' => 'machine', - ], - 'GetAutofeExperiment' => [ - 'summary' => 'Get AutoFE Experiment', - 'path' => '/api/automl/v1/autofe/experiment/{ExperimentId}', - 'methods' => [ - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"INVALID_USER_OR_EXP\\",\\n \\"Message\\": \\"failed to stop any trial\\",\\n \\"Results\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"RequestId\\": \\"071A904D-5A49-597F-9F69-81C7701D04AC\\",\\n \\"AccessDeniedDetail\\": {\\n \\"key\\": \\"{\\\\n \\\\\\"AuthPrincipalType\\\\\\": \\\\\\"sub\\\\\\",\\\\n \\\\\\"PolicyType\\\\\\": \\\\\\"AccountLevelIdentityBasedPolicy\\\\\\",\\\\n \\\\\\"NoPermissionType\\\\\\": \\\\\\"NoPermission\\\\\\"\\\\n}\\\\n\\"\\n }\\n}","type":"json"}]', + 'title' => 'StopHpoTrials', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'paiautoml:StopHpoTrials', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIAutoML', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'UpdateHpoExperiment' => [ + 'summary' => 'Updates the configurations of a running hyperparameter optimization (HPO) experiment. After you update the experiment, the experiment continues to run based on the new configurations.', + 'path' => '/api/automl/v1/hpo/experiment/{ExperimentId}/update', + 'methods' => ['put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '162733', - 'abilityTreeNodes' => [ - 'FEATURElearn0UHCCK', - ], + 'abilityTreeCode' => '195655', + 'abilityTreeNodes' => ['FEATURElearn0UHCCK'], ], 'parameters' => [ [ 'name' => 'ExperimentId', 'in' => 'path', - 'schema' => [ - 'description' => 'Experiment ID', - 'type' => 'string', - 'required' => true, - 'example' => 'tfKs0Ds', - ], + 'schema' => ['title' => 'A short description of struct', 'description' => 'The ID of the HPO experiment.'."\n", 'type' => 'string', 'required' => false, 'example' => 'abcde'], ], - ], - 'responses' => [ - 200 => [ + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ + 'description' => 'The request body.'."\n", 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'Internal error code. Set only when the response has error.', - 'type' => 'string', - 'example' => 'INVALID_USER_OR_EXP', - ], - 'Message' => [ - 'description' => 'Response error message. Set only when the response has error.', - 'type' => 'string', - 'example' => 'Missing \'user_id\' in request.', - ], - 'RequestId' => [ - 'description' => 'POP request ID', - 'type' => 'string', - 'example' => '071A904D-5A49-597F-9F69-81C7701D04AC', - ], - 'Detail' => [ - 'description' => 'Detailed information of the error.', - 'type' => 'object', - ], - 'ExperimentId' => [ - 'description' => 'Experiment ID.', - 'type' => 'string', - 'example' => 'tfKs0Ds', - ], - 'Creator' => [ - 'description' => 'User ID of the experiment creator', - 'type' => 'string', - 'example' => '266977839132045194', - ], - 'Name' => [ - 'description' => 'Experiment name', - 'type' => 'string', - 'example' => 'autofe experiment name', - ], - 'JobMeta' => [ - 'description' => 'Basic information about the experiment running status, including the number of subtasks, URLs corresponding to each task, etc.', - 'type' => 'string', - 'example' => '{"action": "fs_train", "request_id": "6B6D4FB6-87AA-5C0E-94AB-E0F830955D1E", "job_num": 7, "job_runs": [{"job_url": "https://pai.console.aliyun.com/?projectId=®ionId=cn-beijing#/studio/task/detail/flow-fqlk86bvk68", "duration": 181, "finish_at": 1719158854000, "create_time": "2024-06-23T16:04:31.000Z", "status": "Succeeded"}, {"job_url": "https://pai.console.aliyun.com/?projectId=®ionId=cn-beijing#/studio/task/detail/flow-q18k5jo66h3k", "duration": 233, "finish_at": 1719159106000, "create_time": "2024-06-23T16:07:51.000Z", "status": "Succeeded"}, {"job_url": "https://pai.console.aliyun.com/?projectId=®ionId=cn-beijing#/studio/task/detail/flow-g7b38dmqes0nm4le", "duration": 173, "finish_at": 1719159306000, "create_time": "2024-06-23T16:12:12.000Z", "status": "Succeeded"}, {"job_url": "https://pai.console.aliyun.com/?projectId=®ionId=cn-beijing#/studio/task/detail/flow-524dab97aazs3jmc", "duration": 199, "finish_at": 1719159527000, "create_time": "2024-06-23T16:15:28.000Z", "status": "Succeeded"}, {"job_url": "https://pai.console.aliyun.com/?projectId=®ionId=cn-beijing#/studio/task/detail/flow-a8z56wy2ppwmxx04", "duration": 197, "finish_at": 1719159747000, "create_time": "2024-06-23T16:19:08.000Z", "status": "Succeeded"}, {"job_url": "https://pai.console.aliyun.com/?projectId=®ionId=cn-beijing#/studio/task/detail/flow-2cgsbxzzzma1j", "duration": 210, "finish_at": 1719159982000, "create_time": "2024-06-23T16:22:51.000Z", "status": "Succeeded"}, {"job_url": "https://pai.console.aliyun.com/?projectId=®ionId=cn-beijing#/studio/task/detail/flow-3cgsvf3ien1cw7", "duration": 184, "finish_at": 1719160188000, "create_time": "2024-06-23T16:26:43.000Z", "status": "Succeeded"}], "workspace_id": "86006"}{"action": "fs_train", "request_id": "6B6D4FB6-87AA-5C0E-94AB-E0F830955D1E", "job_num": 7, "job_runs": [{"job_url": "https://pai.console.aliyun.com/?projectId=®ionId=cn-beijing#/studio/task/detail/flow-fqlk86betchc69vk68", "duration": 181, "finish_at": 1719158854000, "create_time": "2024-06-23T16:04:31.000Z", "status": "Succeeded"}, {"job_url": "https://pai.console.aliyun.com/?projectId=®ionId=cn-beijing#/studio/task/detail/flow-q18ijqak558jo66h3k", "duration": 233, "finish_at": 1719159106000, "create_time": "2024-06-23T16:07:51.000Z", "status": "Succeeded"}, {"job_url": "https://pai.console.aliyun.com/?projectId=®ionId=cn-beijing#/studio/task/detail/flow-g7b38df7mqes0nm4le", "duration": 173, "finish_at": 1719159306000, "create_time": "2024-06-23T16:12:12.000Z", "status": "Succeeded"}, {"job_url": "https://pai.console.aliyun.com/?projectId=®ionId=cn-beijing#/studio/task/detail/flow-524zedab97aazs3jmc", "duration": 199, "finish_at": 1719159527000, "create_time": "2024-06-23T16:15:28.000Z", "status": "Succeeded"}, {"job_url": "https://pai.console.aliyun.com/?projectId=®ionId=cn-beijing#/studio/task/detail/flow-a8z56wy2ppm6wmxx04", "duration": 197, "finish_at": 1719159747000, "create_time": "2024-06-23T16:19:08.000Z", "status": "Succeeded"}, {"job_url": "https://pai.console.aliyun.com/?projectId=®ionId=cn-beijing#/studio/task/detail/flow-2cgsbxzx9i35zzma1j", "duration": 210, "finish_at": 1719159982000, "create_time": "2024-06-23T16:22:51.000Z", "status": "Succeeded"}, {"job_url": "https://pai.console.aliyun.com/?projectId=®ionId=cn-beijing#/studio/task/detail/flow-3cgsvf3bprlien1cw7", "duration": 184, "finish_at": 1719160188000, "create_time": "2024-06-23T16:26:43.000Z", "status": "Succeeded"}], "workspace_id": "86006"}', - ], - 'GmtCreateTime' => [ - 'description' => 'Experiment creation time.', - 'type' => 'string', - 'example' => '2023-08-18T09:41:01Z', - ], - 'GmtModifiedTime' => [ - 'description' => 'Latest update time of experiment data.', - 'type' => 'string', - 'example' => '2023-11-30T02:05:34.000Z', - ], - 'Status' => [ - 'description' => 'Experiment status', - 'type' => 'string', - 'example' => 'FINISHED, FAILED, USER_CANCELED', - ], - 'SelectedFeatures' => [ - 'description' => 'Original features selected for feature engineering.', - 'type' => 'string', - 'example' => 'age,sex,education', - ], - 'Description' => [ - 'description' => 'Experiment description information', - 'type' => 'string', - 'example' => 'My first experiment.', - ], - 'Accessibility' => [ - 'description' => 'Workspace visibility, possible values are:'."\n" - .'- PRIVATE: Visible only to you and administrators within this workspace.'."\n" - .'- PUBLIC: Visible to everyone within this workspace.', - 'type' => 'string', - 'enumValueTitles' => [ - 'PUBLIC' => 'PUBLIC', - 'PRIVATE' => 'PRIVATE', - ], - 'example' => 'PRIVATE', - ], - 'Tags' => [ + 'HpoExperimentConfiguration' => ['description' => 'The parameter struct of the HPO experiment configuration.'."\n", 'required' => false, '$ref' => '#/components/schemas/HpoExperimentConfig', 'title' => '', 'example' => ''], + 'Description' => ['description' => 'The description of the experiment.'."\n", 'type' => 'string', 'required' => false, 'example' => 'This is an AutoML HPO experiment.', 'title' => ''], + 'Accessibility' => ['description' => 'The visibility of the experiment in the workspace. Valid values:'."\n" + ."\n" + .'* PRIVATE: The experiment is visible only to you and the administrator of the workspace.'."\n" + .'* PUBLIC: The experiment is public in the workspace.'."\n", 'type' => 'string', 'required' => false, 'example' => 'PRIVATE', 'title' => ''], + 'Name' => ['description' => 'The name of the experiment.'."\n", 'type' => 'string', 'required' => false, 'example' => 'my experiment x', 'title' => ''], + 'WorkspaceId' => ['description' => 'The workspace ID.'."\n", 'type' => 'string', 'required' => false, 'example' => '12345', 'title' => ''], + 'Tag' => [ + 'description' => 'Tag information.', 'type' => 'array', 'items' => [ + 'description' => 'Tag information.', 'type' => 'object', 'properties' => [ - 'Key' => [ - 'type' => 'string', - 'description' => 'The tag key.'."\n", - 'example' => 'group', - ], - 'Value' => [ - 'type' => 'string', - 'description' => 'The tag value.'."\n", - 'example' => 'group_name', - ], + 'Key' => ['description' => 'Tag name', 'type' => 'string', 'required' => false, 'example' => 'group', 'title' => ''], + 'Value' => ['description' => 'Tag value', 'type' => 'string', 'required' => false, 'example' => 'group_name', 'title' => ''], ], - 'description' => 'The tag list.', + 'required' => false, + 'title' => '', + 'example' => '', ], - 'description' => 'The list of tags.'."\n", + 'required' => false, + 'title' => '', + 'example' => '', ], ], + 'required' => false, + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the POP request.'."\n", 'type' => 'string', 'example' => '3F190916-B3E5-5D1E-AD0C-35C0DF105F51'], + 'Code' => ['description' => 'The status code.'."\n", 'type' => 'string', 'example' => 'SUCCESS', 'title' => ''], + 'Message' => ['description' => 'The error message. This parameter is returned if an exception occurred.'."\n", 'type' => 'string', 'example' => 'Missing \'user_id\' in request.', 'title' => ''], + 'AccessDeniedDetail' => ['description' => 'The details about the access denial.'."\n", 'type' => 'object', 'example' => '{'."\n" + .' "AuthPrincipalType": "sub",'."\n" + .' "PolicyType": "AccountLevelIdentityBasedPolicy",'."\n" + .' "NoPermissionType": "NoPermission"'."\n" + .'}'."\n", 'title' => ''], + ], + 'example' => '', + ], + ], ], + 'staticInfo' => ['returnType' => 'synchronous'], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"INVALID_USER_OR_EXP\\",\\n \\"Message\\": \\"Missing \'user_id\' in request.\\",\\n \\"RequestId\\": \\"071A904D-5A49-597F-9F69-81C7701D04AC\\",\\n \\"Detail\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"ExperimentId\\": \\"tfKs0Ds\\",\\n \\"Creator\\": \\"266977839132045194\\",\\n \\"Name\\": \\"自动特征工程实验\\",\\n \\"JobMeta\\": \\"{\\\\\\"action\\\\\\": \\\\\\"fs_train\\\\\\", \\\\\\"request_id\\\\\\": \\\\\\"6B6D4FB6-87AA-5C0E-94AB-E0F830955D1E\\\\\\", \\\\\\"job_num\\\\\\": 7, \\\\\\"job_runs\\\\\\": [{\\\\\\"job_url\\\\\\": \\\\\\"https://pai.console.aliyun.com/?projectId=®ionId=cn-beijing#/studio/task/detail/flow-fqlk86bvk68\\\\\\", \\\\\\"duration\\\\\\": 181, \\\\\\"finish_at\\\\\\": 1719158854000, \\\\\\"create_time\\\\\\": \\\\\\"2024-06-23T16:04:31.000Z\\\\\\", \\\\\\"status\\\\\\": \\\\\\"Succeeded\\\\\\"}, {\\\\\\"job_url\\\\\\": \\\\\\"https://pai.console.aliyun.com/?projectId=®ionId=cn-beijing#/studio/task/detail/flow-q18k5jo66h3k\\\\\\", \\\\\\"duration\\\\\\": 233, \\\\\\"finish_at\\\\\\": 1719159106000, \\\\\\"create_time\\\\\\": \\\\\\"2024-06-23T16:07:51.000Z\\\\\\", \\\\\\"status\\\\\\": \\\\\\"Succeeded\\\\\\"}, {\\\\\\"job_url\\\\\\": \\\\\\"https://pai.console.aliyun.com/?projectId=®ionId=cn-beijing#/studio/task/detail/flow-g7b38dmqes0nm4le\\\\\\", \\\\\\"duration\\\\\\": 173, \\\\\\"finish_at\\\\\\": 1719159306000, \\\\\\"create_time\\\\\\": \\\\\\"2024-06-23T16:12:12.000Z\\\\\\", \\\\\\"status\\\\\\": \\\\\\"Succeeded\\\\\\"}, {\\\\\\"job_url\\\\\\": \\\\\\"https://pai.console.aliyun.com/?projectId=®ionId=cn-beijing#/studio/task/detail/flow-524dab97aazs3jmc\\\\\\", \\\\\\"duration\\\\\\": 199, \\\\\\"finish_at\\\\\\": 1719159527000, \\\\\\"create_time\\\\\\": \\\\\\"2024-06-23T16:15:28.000Z\\\\\\", \\\\\\"status\\\\\\": \\\\\\"Succeeded\\\\\\"}, {\\\\\\"job_url\\\\\\": \\\\\\"https://pai.console.aliyun.com/?projectId=®ionId=cn-beijing#/studio/task/detail/flow-a8z56wy2ppwmxx04\\\\\\", \\\\\\"duration\\\\\\": 197, \\\\\\"finish_at\\\\\\": 1719159747000, \\\\\\"create_time\\\\\\": \\\\\\"2024-06-23T16:19:08.000Z\\\\\\", \\\\\\"status\\\\\\": \\\\\\"Succeeded\\\\\\"}, {\\\\\\"job_url\\\\\\": \\\\\\"https://pai.console.aliyun.com/?projectId=®ionId=cn-beijing#/studio/task/detail/flow-2cgsbxzzzma1j\\\\\\", \\\\\\"duration\\\\\\": 210, \\\\\\"finish_at\\\\\\": 1719159982000, \\\\\\"create_time\\\\\\": \\\\\\"2024-06-23T16:22:51.000Z\\\\\\", \\\\\\"status\\\\\\": \\\\\\"Succeeded\\\\\\"}, {\\\\\\"job_url\\\\\\": \\\\\\"https://pai.console.aliyun.com/?projectId=®ionId=cn-beijing#/studio/task/detail/flow-3cgsvf3ien1cw7\\\\\\", \\\\\\"duration\\\\\\": 184, \\\\\\"finish_at\\\\\\": 1719160188000, \\\\\\"create_time\\\\\\": \\\\\\"2024-06-23T16:26:43.000Z\\\\\\", \\\\\\"status\\\\\\": \\\\\\"Succeeded\\\\\\"}], \\\\\\"workspace_id\\\\\\": \\\\\\"86006\\\\\\"}{\\\\\\"action\\\\\\": \\\\\\"fs_train\\\\\\", \\\\\\"request_id\\\\\\": \\\\\\"6B6D4FB6-87AA-5C0E-94AB-E0F830955D1E\\\\\\", \\\\\\"job_num\\\\\\": 7, \\\\\\"job_runs\\\\\\": [{\\\\\\"job_url\\\\\\": \\\\\\"https://pai.console.aliyun.com/?projectId=®ionId=cn-beijing#/studio/task/detail/flow-fqlk86betchc69vk68\\\\\\", \\\\\\"duration\\\\\\": 181, \\\\\\"finish_at\\\\\\": 1719158854000, \\\\\\"create_time\\\\\\": \\\\\\"2024-06-23T16:04:31.000Z\\\\\\", \\\\\\"status\\\\\\": \\\\\\"Succeeded\\\\\\"}, {\\\\\\"job_url\\\\\\": \\\\\\"https://pai.console.aliyun.com/?projectId=®ionId=cn-beijing#/studio/task/detail/flow-q18ijqak558jo66h3k\\\\\\", \\\\\\"duration\\\\\\": 233, \\\\\\"finish_at\\\\\\": 1719159106000, \\\\\\"create_time\\\\\\": \\\\\\"2024-06-23T16:07:51.000Z\\\\\\", \\\\\\"status\\\\\\": \\\\\\"Succeeded\\\\\\"}, {\\\\\\"job_url\\\\\\": \\\\\\"https://pai.console.aliyun.com/?projectId=®ionId=cn-beijing#/studio/task/detail/flow-g7b38df7mqes0nm4le\\\\\\", \\\\\\"duration\\\\\\": 173, \\\\\\"finish_at\\\\\\": 1719159306000, \\\\\\"create_time\\\\\\": \\\\\\"2024-06-23T16:12:12.000Z\\\\\\", \\\\\\"status\\\\\\": \\\\\\"Succeeded\\\\\\"}, {\\\\\\"job_url\\\\\\": \\\\\\"https://pai.console.aliyun.com/?projectId=®ionId=cn-beijing#/studio/task/detail/flow-524zedab97aazs3jmc\\\\\\", \\\\\\"duration\\\\\\": 199, \\\\\\"finish_at\\\\\\": 1719159527000, \\\\\\"create_time\\\\\\": \\\\\\"2024-06-23T16:15:28.000Z\\\\\\", \\\\\\"status\\\\\\": \\\\\\"Succeeded\\\\\\"}, {\\\\\\"job_url\\\\\\": \\\\\\"https://pai.console.aliyun.com/?projectId=®ionId=cn-beijing#/studio/task/detail/flow-a8z56wy2ppm6wmxx04\\\\\\", \\\\\\"duration\\\\\\": 197, \\\\\\"finish_at\\\\\\": 1719159747000, \\\\\\"create_time\\\\\\": \\\\\\"2024-06-23T16:19:08.000Z\\\\\\", \\\\\\"status\\\\\\": \\\\\\"Succeeded\\\\\\"}, {\\\\\\"job_url\\\\\\": \\\\\\"https://pai.console.aliyun.com/?projectId=®ionId=cn-beijing#/studio/task/detail/flow-2cgsbxzx9i35zzma1j\\\\\\", \\\\\\"duration\\\\\\": 210, \\\\\\"finish_at\\\\\\": 1719159982000, \\\\\\"create_time\\\\\\": \\\\\\"2024-06-23T16:22:51.000Z\\\\\\", \\\\\\"status\\\\\\": \\\\\\"Succeeded\\\\\\"}, {\\\\\\"job_url\\\\\\": \\\\\\"https://pai.console.aliyun.com/?projectId=®ionId=cn-beijing#/studio/task/detail/flow-3cgsvf3bprlien1cw7\\\\\\", \\\\\\"duration\\\\\\": 184, \\\\\\"finish_at\\\\\\": 1719160188000, \\\\\\"create_time\\\\\\": \\\\\\"2024-06-23T16:26:43.000Z\\\\\\", \\\\\\"status\\\\\\": \\\\\\"Succeeded\\\\\\"}], \\\\\\"workspace_id\\\\\\": \\\\\\"86006\\\\\\"}\\",\\n \\"GmtCreateTime\\": \\"2023-08-18T09:41:01Z\\",\\n \\"GmtModifiedTime\\": \\"2023-11-30T02:05:34.000Z\\",\\n \\"Status\\": \\"FINISHED, FAILED, USER_CANCELED\\",\\n \\"SelectedFeatures\\": \\"age,sex,education\\",\\n \\"Description\\": \\"我的实验\\",\\n \\"Accessibility\\": \\"PRIVATE\\",\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"group\\",\\n \\"Value\\": \\"group_name\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => 'Get AutoFE Experiment Information', - 'translator' => 'machine', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3F190916-B3E5-5D1E-AD0C-35C0DF105F51\\",\\n \\"Code\\": \\"SUCCESS\\",\\n \\"Message\\": \\"Missing \'user_id\' in request.\\",\\n \\"AccessDeniedDetail\\": {\\n \\"AuthPrincipalType\\": \\"sub\\",\\n \\"PolicyType\\": \\"AccountLevelIdentityBasedPolicy\\",\\n \\"NoPermissionType\\": \\"NoPermission\\"\\n }\\n}","type":"json"}]', + 'title' => 'UpdateHpoExperiment', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'paiautoml:UpdateHpoExperiment', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIAutoML', 'resourceType' => 'HpoExperiment', 'arn' => 'acs:paiautoml:{#regionId}:{#accountId}:hpoexperiment/{#HpoExperimentId}'], + ], + ], + ], + ], ], ], 'endpoints' => [ - [ - 'regionId' => 'cn-hangzhou', - 'endpoint' => 'paiautoml.cn-hangzhou.aliyuncs.com', - ], - [ - 'regionId' => 'cn-beijing', - 'endpoint' => 'paiautoml.cn-beijing.aliyuncs.com', - ], - [ - 'regionId' => 'cn-shenzhen', - 'endpoint' => 'paiautoml.cn-shenzhen.aliyuncs.com', - ], - [ - 'regionId' => 'cn-shanghai', - 'endpoint' => 'paiautoml.cn-shanghai.aliyuncs.com', - ], - [ - 'regionId' => 'cn-hongkong', - 'endpoint' => 'paiautoml.cn-hongkong.aliyuncs.com', + ['regionId' => 'cn-shenzhen', 'regionName' => 'China (Shenzhen)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'paiautoml.cn-shenzhen.aliyuncs.com', 'endpoint' => 'paiautoml.cn-shenzhen.aliyuncs.com', 'vpc' => 'paiautoml-vpc.cn-shenzhen.aliyuncs.com'], + ['regionId' => 'cn-wulanchabu', 'regionName' => 'China (Ulanqab)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'paiautoml.cn-wulanchabu.aliyuncs.com', 'endpoint' => 'paiautoml.cn-wulanchabu.aliyuncs.com', 'vpc' => 'paiautoml-vpc.cn-wulanchabu.aliyuncs.com'], + ['regionId' => 'cn-beijing', 'regionName' => 'China (Beijing)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'paiautoml.cn-beijing.aliyuncs.com', 'endpoint' => 'paiautoml.cn-beijing.aliyuncs.com', 'vpc' => 'paiautoml-vpc.cn-beijing.aliyuncs.com'], + ['regionId' => 'cn-shanghai', 'regionName' => 'China (Shanghai)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'paiautoml.cn-shanghai.aliyuncs.com', 'endpoint' => 'paiautoml.cn-shanghai.aliyuncs.com', 'vpc' => 'paiautoml-vpc.cn-shanghai.aliyuncs.com'], + ['regionId' => 'cn-hongkong', 'regionName' => 'China (Hong Kong)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'paiautoml.cn-hongkong.aliyuncs.com', 'endpoint' => 'paiautoml.cn-hongkong.aliyuncs.com', 'vpc' => 'paiautoml-vpc.cn-hongkong.aliyuncs.com'], + ['regionId' => 'cn-hangzhou', 'regionName' => 'China (Hangzhou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'paiautoml.cn-hangzhou.aliyuncs.com', 'endpoint' => 'paiautoml.cn-hangzhou.aliyuncs.com', 'vpc' => 'paiautoml-vpc.cn-hangzhou.aliyuncs.com'], + ], + 'errorCodes' => [], + 'changeSet' => [], + 'ram' => [ + 'productCode' => 'PAIAutoML', + 'productName' => 'Platform for AI', + 'ramCodes' => ['paiautoml'], + 'ramLevel' => 'RESOURCE', + 'ramConditions' => [], + 'ramActions' => [ + [ + 'apiName' => 'ListHpoTrialLogNames', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'paiautoml:ListHpoTrialLogNames', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIAutoML', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListHpoTrials', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'paiautoml:ListHpoTrials', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIAutoML', 'resourceType' => 'HpoExperiment', 'arn' => 'acs:paiautoml:{#regionId}:{#accountId}:hpoexperiment/{#HpoExperimentId}'], + ], + ], + ], + [ + 'apiName' => 'GetServiceIdentityRole', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'paiautoml:GetServiceIdentityRole', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIAutoML', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListHpoExperiments', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'paiautoml:ListHpoExperiments', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIAutoML', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DeleteHpoExperiment', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'paiautoml:DeleteHpoExperiment', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIAutoML', 'resourceType' => 'HpoExperiment', 'arn' => 'acs:paiautoml:{#regionId}:{#accountId}:hpoexperiment/{#HpoExperimentId}'], + ], + ], + ], + [ + 'apiName' => 'UpdateHpoExperiment', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'paiautoml:UpdateHpoExperiment', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIAutoML', 'resourceType' => 'HpoExperiment', 'arn' => 'acs:paiautoml:{#regionId}:{#accountId}:hpoexperiment/{#HpoExperimentId}'], + ], + ], + ], + [ + 'apiName' => 'GetHpoTrial', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'paiautoml:GetHpoTrial', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIAutoML', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetHpoExperiment', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'paiautoml:GetHpoExperiment', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIAutoML', 'resourceType' => 'HpoExperiment', 'arn' => 'acs:paiautoml:{#regionId}:{#accountId}:hpoexperiment/{#HpoExperimentId}'], + ], + ], + ], + [ + 'apiName' => 'RestartHpoTrials', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'paiautoml:RestartHpoTrials', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIAutoML', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetAutofeExperiment', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'paiautoml:GetAutofeExperiment', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIAutoML', 'resourceType' => 'AutofeExperiment', 'arn' => 'acs:paiautoml:{#regionId}:{#accountId}:autofeexperiment/{#AutofeExperimentId}'], + ], + ], + ], + [ + 'apiName' => 'ListHpoExperimentLogs', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'paiautoml:ListHpoExperimentLogs', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIAutoML', 'resourceType' => 'HpoExperiment', 'arn' => 'acs:paiautoml:{#regionId}:{#accountId}:hpoexperiment/{#HpoExperimentId}'], + ], + ], + ], + [ + 'apiName' => 'CreateHpoExperiment', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'paiautoml:CreateHpoExperiment', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIAutoML', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListHpoTrialCommands', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'paiautoml:ListHpoTrialCommands', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIAutoML', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'StopHpoExperiment', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'paiautoml:StopHpoExperiment', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIAutoML', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListHpoTrialLogs', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'paiautoml:ListHpoTrialLogs', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIAutoML', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'StopHpoTrials', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'paiautoml:StopHpoTrials', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIAutoML', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateServiceIdentityRole', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'paiautoml:CreateServiceIdentityRole', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIAutoML', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateAutofeExperiment', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'paiautoml:CreateAutofeExperiment', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIAutoML', 'resourceType' => 'AutofeExperiment', 'arn' => 'acs:paiautoml:{#regionId}:{#accountId}:autofeexperiment/*'], + ], + ], + ], ], - [ - 'regionId' => 'cn-wulanchabu', - 'endpoint' => 'paiautoml.cn-wulanchabu.aliyuncs.com', + 'resourceTypes' => [ + ['validationType' => 'always', 'resourceType' => 'HpoExperiment', 'arn' => 'acs:paiautoml:{#regionId}:{#accountId}:hpoexperiment/{#HpoExperimentId}'], + ['validationType' => 'always', 'resourceType' => 'AutofeExperiment', 'arn' => 'acs:paiautoml:{#regionId}:{#accountId}:autofeexperiment/{#AutofeExperimentId}'], + ['validationType' => 'always', 'resourceType' => 'AutofeExperiment', 'arn' => 'acs:paiautoml:{#regionId}:{#accountId}:autofeexperiment/*'], ], ], ]; |