Obtaining Supported Hyperparameter Search Algorithms

Function

This API is used to query all hyperparameter search algorithms supported by the system.

This API is used when you need to know the hyperparameter search algorithms supported by the system. Before using this API, ensure that you have the access permission. After the query, the API returns the list of hyperparameter search algorithms supported by the system. If you do not have the permission to perform operations, the API will return an error message.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
If you are using identity policy-based authorization, no identity policy-based permission required for calling this API.

URI

GET /v2/{project_id}/search-algorithms

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition: Project ID. For details, see Obtaining a Project ID and Name. Constraints: The value can contain 1 to 64 characters. Letters, digits, and hyphens (-) are allowed. Range: N/A Default Value: N/A

Request Parameters

None

Response Parameters

Status code: 200

**Table 2** Response body parameters
Parameter	Type	Description
search_algo_count	Integer	Definition: Number of hyperparameter search algorithms. Range: N/A
search_algo_list	Array of search_algo_list objects	Definition: List of all hyperparameter search algorithms.

**Table 3** search_algo_list
Parameter	Type	Description
name	String	Definition: Name of the hyperparameter search algorithm. Range: N/A
params	Array of params objects	Definition: Parameter list of the hyperparameter search algorithm.
description	String	Definition: Description of the hyperparameter search algorithm. Range: N/A

**Table 4** params
Parameter	Type	Description
key	String	Definition: Parameter name of the hyperparameter search algorithm. Range: N/A
value	String	Definition: Parameter value of the hyperparameter search algorithm. Range: N/A
type	String	Definition: Parameter type of the hyperparameter search algorithm. Constraints: N/A. Range Integer: Integer Float: Floating point number String: String List: List Default Value: N/A.

Example Requests

The following shows how to query information about the search algorithms supported by coding-free hyperparameter search.

GET https://endpoint/v2/{project_id}/search-algorithms

Example Responses

Status code: 200

{
  "search_algo_count" : 3,
  "search_algo_list" : [ {
    "name" : "bayes_opt_search",
    "params" : [ {
      "key" : "kind",
      "value" : "ucb",
      "type" : "String"
    }, {
      "key" : "kappa",
      "value" : "2.5",
      "type" : "Float"
    }, {
      "key" : "xi",
      "value" : "0.0",
      "type" : "Float"
    }, {
      "key" : "num_samples",
      "value" : "20",
      "type" : "Integer"
    }, {
      "key" : "seed",
      "value" : "1",
      "type" : "Integer"
    } ],
    "description" : "Hyperparameter search using Gaussian process."
  }, {
    "name" : "tpe_search",
    "params" : [ {
      "key" : "gamma",
      "value" : "0.25",
      "type" : "Float"
    }, {
      "key" : "n_initial_points",
      "value" : "20",
      "type" : "Integer"
    }, {
      "key" : "num_samples",
      "value" : "20",
      "type" : "Integer"
    }, {
      "key" : "seed",
      "value" : "1",
      "type" : "Integer"
    } ],
    "description" : "Hyperparameter search using the tree-structured Parzen estimator algorithm."
  }, {
    "name" : "anneal_search",
    "params" : [ {
      "key" : "avg_best_idx",
      "value" : "2.0",
      "type" : "Float"
    }, {
      "key" : "shrink_coef",
      "value" : "0.1",
      "type" : "Float"
    }, {
      "key" : "num_samples",
      "value" : "20",
      "type" : "Integer"
    }, {
      "key" : "seed",
      "value" : "1",
      "type" : "Integer"
    } ],
    "description" : "Hyperparameter search using simulated annealing algorithm."
  } ]
}