Update HPO

patch https://api.myst.ai/v1alpha2/projects/{project_uuid}/hpos/{uuid}

Updates an HPO in the project.

Path Params

project_uuid

uuid

required

uuid

required

Body Params

object

string

The field representing the type of object this resource is. Must be HPO.

title

string

length between 1 and 80

The title of the HPO.

model

uuid

The model that this HPO will use.

search_space

object

Represents a search space, or a mapping from parameters to sampling functions.

test_start_time

string

The start of the test period.

test_end_time

string

The end of the test period.

fit_start_timing

A timing to determine the start of each predict period relative to a fit reference time. offset must be negative and frequency and time_zone must be left unset or set to null.

fit_end_timing

A timing to determine the end of each fit period relative to a fit reference time. If a RelativeTiming is used, offset must be negative and frequency and time_zone must be left unset or set to null.

fit_reference_timing

A timing to determine the frequency and reference time of each fit.

predict_start_timing

A timing to determine the start of each predict period relative to a predict reference time. offset must be positive and frequency and time_zone must be left unset or set to null.

predict_end_timing

A timing to determine the start of each predict period relative to a predict reference time. offset must be positive and frequency and time_zone must be left unset or set to null.

predict_reference_timing

object

Cron timing schema for create requests.

search_algorithm

object

Hyperopt search algorithm schema for create requests.

See https://hyperopt.github.io/hyperopt/ for hyperopt reference.

description

string | null

The description of the HPO.

Responses

Response body

object

string

required

The field representing the type of object this resource is. Must be HPO.

HPO

uuid

required

The identifier of the resource. Output only.

create_time

string

required

The time when the resource was created. Output only.

update_time

string

The time when the resource was last updated. Output only.

title

string

required

length between 1 and 80

The title of the HPO.

description

string | null

The description of the HPO.

project

uuid

required

The project that this HPO belongs to.

model

uuid

required

The model that this HPO will use.

creator

uuid

required

The creator of the HPO. Output only.

search_space

object

required

Represents a search space, or a mapping from parameters to sampling functions.

Has additional fields

search_algorithm

object

required

Hyperopt search algorithm schema for get responses.

See https://hyperopt.github.io/hyperopt/ for hyperopt reference.

object

string

Defaults to SearchAlgorithm

The field representing the type of object this resource is. Must be SearchAlgorithm.

SearchAlgorithm

type

string

Defaults to Hyperopt

The type of search algorithm.

Hyperopt

metric

string

required

Supported HPO metrics.

Represents a metric to be optimized for.

mae mape mean_negative_log_likelihood mean_pinball_loss mse rmse

num_trials

integer

required

1 to 150

The number of trials to run.

max_concurrent_trials

integer

required

1 to 5

The maximum number of trials to run concurrently.

algorithm

string

required

The hyperopt-specific algorithm to use.

TPE

n_startup_jobs

integer

required

The number of random trials to schedule first. Must be a positive integer, and less than or equal to num_trials. If not provided, defaults to floor(num_trials / 2). Only supported if algorithm is TPE.

test_start_time

string

The start of the test period.

test_end_time

string

The end of the test period.

fit_start_timing

required

A timing to determine the start of each predict period relative to a fit reference time. offset must be negative and frequency and time_zone must be left unset or set to null.

fit_end_timing

required

fit_reference_timing

A timing to determine the frequency and reference time of each fit.

predict_start_timing

required

A timing to determine the start of each predict period relative to a predict reference time. offset must be positive and frequency and time_zone must be left unset or set to null.

predict_end_timing

required

A timing to determine the start of each predict period relative to a predict reference time. offset must be positive and frequency and time_zone must be left unset or set to null.

predict_reference_timing

object

Cron timing schema for get responses.

object

string

required

The field representing the type of object this resource is. Must be Timing.

Timing

type

string

required

The field representing the specific timing type of this resource. Must be CronTiming.

CronTiming

cron_expression

string

required

The string representing the timing's cron expression.

time_zone

string

required

The IANA time zone to use convert time in this timing.

Language

Credentials

Bearer


xxxxxxxxxx
41
1
curl --request PATCH \
2
     --url https://api.myst.ai/v1alpha2/projects/project_uuid/hpos/uuid \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "fit_start_timing": {
8
    "object": "Timing",
9
    "type": "AbsoluteTiming"
10
  },
11
  "fit_end_timing": {
12
    "object": "Timing",
13
    "type": "AbsoluteTiming"
14
  },
15
  "fit_reference_timing": {
16
    "object": "Timing",
17
    "type": "AbsoluteTiming"
18
  },
19
  "predict_start_timing": {
20
    "object": "Timing",
21
    "type": "AbsoluteTiming"
22
  },

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Successful Response

403Forbidden

404Not Found

422Unprocessable Entity