Katib

    This is the legacy gRPC API reference for Katib v1alpha3 version. Corresponding Katib documentation can be found in 1.0 Kubeflow documentation.

    Katib API v1alpha3

    AlgorithmSpec

    FieldTypeLabelDescription
    algorithm_name
    algorithm_settingAlgorithmSettingrepeated
    early_stopping_spec

    DeleteObservationLogReply

    DeleteObservationLogRequest

    FieldTypeLabelDescription
    trial_namestring

    EarlyStoppingSpec

    TODO: This feature is not yet fully implemented.

    Experiment

    FieldTypeLabelDescription
    nameName of Experiment. This is unique in DB.
    specExperimentSpec

    ExperimentSpec

    Spec of a Experiment. Experiment represents a single optimization run over a feasible space. Each Experiment contains a configuration describing the feasible space, as well as a set of Trials. It is assumed that objective function f(x) does not change in the course of a Experiment.

    FieldTypeLabelDescription
    parameter_specsExperimentSpec.ParameterSpecs
    objective
    algorithmAlgorithmSpec
    trial_template
    metrics_collector_specstring
    parallel_trial_count
    max_trial_countint32
    nas_config

    ExperimentSpec.ParameterSpecs

    List of ParameterSpec

    FieldTypeLabelDescription
    parametersrepeated

    FeasibleSpace

    Feasible space for optimization. Int and Double type use Max/Min. Discrete and Categorical type use List.

    FieldTypeLabelDescription
    maxMax Value
    minstringMinimum Value
    listrepeatedList of Values.
    stepstringStep for double or int parameter

    GetObservationLogReply

    FieldTypeLabelDescription
    observation_logObservationLog

    GetObservationLogRequest

    FieldTypeLabelDescription
    trial_namestring
    metric_name
    start_timestringThe start of the time range. RFC3339 format
    end_timeThe end of the time range. RFC3339 format

    GetSuggestionsReply

    FieldTypeLabelDescription
    parameter_assignmentsrepeated
    algorithmAlgorithmSpec

    GetSuggestionsReply.ParameterAssignments

    FieldTypeLabelDescription
    assignmentsParameterAssignmentrepeated
    FieldTypeLabelDescription
    experiment
    trialsTrialrepeatedall completed trials owned by the experiment.
    request_numberThe number of Suggestion you request at one time. When you set 3 to request_number, you can get three Suggestions at one time.

    GraphConfig

    GraphConfig contains a config of DAG

    Metric

    FieldTypeLabelDescription
    namestring
    value

    MetricLog

    FieldTypeLabelDescription
    time_stampRFC3339 format
    metricMetric

    NasConfig

    NasConfig contains a config of NAS job

    FieldTypeLabelDescription
    graph_configGraphConfigConfig of DAG
    operationsList of Operation

    NasConfig.Operations

    FieldTypeLabelDescription
    operationrepeated

    ObjectiveSpec

    FieldTypeLabelDescription
    type
    goaldouble
    objective_metric_name
    additional_metric_namesstringrepeatedThis can be empty if we only care about the objective metric.

    Observation

    FieldTypeLabelDescription
    metricsMetricrepeated

    ObservationLog

    FieldTypeLabelDescription
    metric_logsMetricLogrepeated

    Operation

    Config for operations in DAG

    FieldTypeLabelDescription
    operation_typestringType of operation in DAG
    parameter_specs

    Operation.ParameterSpecs

    List of ParameterSpec

    FieldTypeLabelDescription
    parametersrepeated

    ParameterAssignment

    FieldTypeLabelDescription
    name
    valuestring

    ParameterSpec

    Config for a Hyper parameter. Katib will create each Hyper parameter from this config.

    FieldTypeLabelDescription
    namestringName of the parameter.
    parameter_typeType of the parameter.
    feasible_spaceFeasibleSpaceFeasibleSpace for the parameter.

    ReportObservationLogRequest

    Trial

    FieldTypeLabelDescription
    name
    specTrialSpec
    status

    TrialSpec

    FieldTypeLabelDescription
    experiment_name
    objectiveObjectiveSpec
    parameter_assignments
    run_specstring
    metrics_collector_spec

    TrialSpec.ParameterAssignments

    List of ParameterAssignment

    FieldTypeLabelDescription
    assignmentsrepeated

    TrialStatus

    FieldTypeLabelDescription
    start_timeRFC3339 format
    completion_timestringRFC3339 format
    condition
    observationObservationThe best observation in logs.

    ValidateAlgorithmSettingsReply

    Return INVALID_ARGUMENT Error if Algorithm Settings are not Valid

    ValidateAlgorithmSettingsRequest

    FieldTypeLabelDescription
    experiment

    ObjectiveType

    Direction of optimization. Minimize or Maximize.

    NameNumberDescription
    UNKNOWN0Undefined type and not used.
    MINIMIZE1Minimize
    MAXIMIZE2Maximize

    ParameterType

    Types of value for HyperParameter.

    NameNumberDescription
    UNKNOWN_TYPE0Undefined type and not used.
    DOUBLE1Double float type. Use “Max/Min”.
    INT2Int type. Use “Max/Min”.
    DISCRETE3Discrete number type. Use “List” as float.
    CATEGORICAL4Categorical type. Use “List” as string.

    TrialStatus.TrialConditionType

    NameNumberDescription
    CREATED0
    RUNNING1
    SUCCEEDED2
    KILLED3
    FAILED4
    UNKNOWN5

    EarlyStopping

    TODO: This feature is not yet fully implemented.

    Method NameRequest TypeResponse TypeDescription

    Manager

    Method NameRequest TypeResponse TypeDescription
    ReportObservationLogReportObservationLogReplyReport a log of Observations for a Trial. The log consists of timestamp and value of metric. Katib store every log of metrics. You can see accuracy curve or other metric logs on UI.
    GetObservationLogGetObservationLogReplyGet all log of Observations for a Trial.
    DeleteObservationLogDeleteObservationLogReplyDelete all log of Observations for a Trial.
    Method NameRequest TypeResponse TypeDescription
    GetSuggestionsGetSuggestionsReply
    ValidateAlgorithmSettingsValidateAlgorithmSettingsReply