ListHpoExperiments - Platform For AI - Alibaba Cloud Documentation Center

This topic is generated by a machine translation engine without any human intervention. ALIBABA CLOUD DOES NOT GUARANTEE THE ACCURACY OF MACHINE TRANSLATED CONTENT. To request a human-translated version of this topic or provide feedback on this translation, please include it in the feedback form.

Queries information about a hyperparameter optimization (HPO) experiment that meets specific requirements.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
paiautoml:ListHpoExperiments	list	All Resources ``	none	none

Request syntax

GET /api/automl/v1/hpo/experiments HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
Name	string	No	The keyword of the name of the experiment.	my_hpo_exp_1
Creator	string	No	The ID of the user who created the experiment.	266977839132045194
PageNumber	integer	No	The page number. Pages start from page 1. Default value: 1.	1
PageSize	integer	No	The number of entries per page.	10
MinCreateTime	string	No	The earliest experiment creation time.	Format: yyyy-mm-dd hh:mm:ss or yyyy-mm-dd. Example: 2023-03-31 10:29:30
MaxCreateTime	string	No	The latest experiment creation time.	Format: yyyy-mm-dd hh:mm:ss or yyyy-mm-dd. Example: 2023-03-31 10:29:30
Status	string	No	The status of the experiment.	CREATED, RUNNING, FINISHED, FAILED, EARLY_STOPPED, USER_CANCELED, SYS_CANCELED, WAITING, NO_MORE_TRIAL, UNKNOWN
WorkspaceId	string	No	The workspace ID.	default
Accessibility	string	No	The visibility of the workspace. PRIVATE: The workspace is visible only to you and the administrator of the workspace. PUBLIC: The workspace is visible to all users.	PRIVATE
IncludeConfigData	string	No	Specifies whether to include experiment configuration data in the response.	True, False
SortBy	string	No	The filter that is used to sort experiments.	GmtCreateTime
Order	string	No	The sorting order. Specify this parameter together with the SortBy parameter. Valid values: DESC: in descending order. This is the default value. ASC: in ascending order.	ASC, DESC.
Tag	array<object>	No	Resource tags.
	object	No	List of tags. Query filter conditions. Up to 20 tags can be specified.
Key	string	No	The tag key of the resource	group
Value	string	No	Tag value. A tag value can contain up to 128 characters, and it cannot start with `aliyun` or `acs:`. It should not include `http://` or `https://`. Up to 20 tag values are supported in a single request.	group_name

Response parameters

Parameter	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	3F190916-B3E5-5D1E-AD0C-35C0DF105F51
Code	string	The internal error code. This parameter is returned if an exception occurred.	INVALID_INPUT_PARAMS
Message	string	The error message. This parameter is returned if an exception occurred.	Missing 'user_id' in request.
AccessDeniedDetail	object	The information about the request denial.
	string	The information about the request denial.	{ "AuthPrincipalType": "sub", "PolicyType": "AccountLevelIdentityBasedPolicy", "NoPermissionType": "NoPermission" }
TotalCount	integer	The total number of experiments returned.	5
Experiments	array<object>	The experiments that meet the requirements.
experiments	object	The struct of the experiment data.
ExperimentId	string	The ID of the experiment.	sORVEck
Creator	string	The ID of the user who created the experiment.	1049310008714189
SearchSpace	string	The SearchSpace property in the experiment configuration.	{'foo':'bar'}
Name	string	The name of the experiment.	my experiment x
Status	string	The status of the experiment.	CREATED, RUNNING, FINISHED, FAILED, EARLY_STOPPED, USER_CANCELED, SYS_CANCELED, WAITING, NO_MORE_TRIAL, UNKNOWN
JobType	string	The type of the experiment. For HPO experiments, the value of this parameter is 1.	1
ConfigIni	string	The content of the trial.ini configuration file. The actual value of sensitive data such as an AccessKey pair is replaced with asterisks (*).	[odps_config] key1 = value1 key2 = value2
ConfigYml	string	The content of the exp.yml configuration file.	experimentName: dlc_oss_mnist experimentWorkingDirectory: ../expdir searchSpaceFile: search_space.json trialCommand: python3 -m hpo_tools.core.utils.run --config=./trial.ini trialConcurrency: 1 maxTrialNumber: 4 tuner: name: TPE classArgs: optimize_mode: maximize trainingService: platform: local assessor: name: PAIAssessor classArgs: optimize_mode: maximize start_step: 2
GmtCreateTime	string	The time at which the experiment was created.	2023-03-31T10:29:30Z
GmtModifiedTime	string	The time at which the experiment data was last modified.	2022-10-27T00:55:54Z
WorkspaceId	string	The ID of the workspace.	foo
Accessibility	string	The visibility of the workspace. Select the type of the task. Valid values: PRIVATE (default): The workspace is visible only to you and the administrator of the workspace. PUBLIC: The workspace is visible to all users.	PUBLIC
Description	string	PUBLIC: The workspace is visible to all users.	desc
TrialCount	integer	The total number of trials of the experiment	20
TrialStatus	object	The information that contains the status of the trials and the trials in each state.
	string	FINISHED	3
Deleted	boolean	Indicates whether the experiment is deleted.	1
Tags	array<object>	Tag system list
tags	object	Tag list
Key	string	Tag key of the resource	group
Value	string	Tag value.	group_name

Examples

Sample success responses

JSONformat

{
  "RequestId": "3F190916-B3E5-5D1E-AD0C-35C0DF105F51",
  "Code": "INVALID_INPUT_PARAMS",
  "Message": "Missing 'user_id' in request.",
  "AccessDeniedDetail": {
    "key": {
      "AuthPrincipalType": "sub",
      "PolicyType": "AccountLevelIdentityBasedPolicy",
      "NoPermissionType": "NoPermission"
    }
  },
  "TotalCount": 5,
  "Experiments": [
    {
      "ExperimentId": "sORVEck",
      "Creator": 1049310008714189,
      "SearchSpace": "{'foo':'bar'}",
      "Name": "my experiment x",
      "Status": "CREATED, RUNNING, FINISHED, FAILED, EARLY_STOPPED, USER_CANCELED, SYS_CANCELED, WAITING, NO_MORE_TRIAL, UNKNOWN",
      "JobType": 1,
      "ConfigIni": "[odps_config]\nkey1 = value1\nkey2 = value2",
      "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",
      "GmtCreateTime": "2023-03-31T10:29:30Z",
      "GmtModifiedTime": "2022-10-27T00:55:54Z",
      "WorkspaceId": "foo",
      "Accessibility": "PUBLIC",
      "Description": "desc",
      "TrialCount": 20,
      "TrialStatus": {
        "key": 3
      },
      "Deleted": true,
      "Tags": [
        {
          "Key": "group",
          "Value": "group_name"
        }
      ]
    }
  ]
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2024-10-21	The response structure of the API has changed	View Change Details