/docs/reference/katib/v1alpha3/ Recent content in Katib v1alpha3 on Kubeflow Hugo -- gohugo.io en-us /docs/reference/katib/v1alpha3/katib/ Mon, 01 Jan 0001 00:00:00 +0000 /docs/reference/katib/v1alpha3/katib/ <h2 id="table-of-contents">Table of Contents</h2> <ul> <li> <p><a href="#apiproto">api.proto</a></p> <ul> <li><a href="#algorithmsetting">AlgorithmSetting</a></li> <li><a href="#algorithmspec">AlgorithmSpec</a></li> <li><a href="#deleteobservationlogreply">DeleteObservationLogReply</a></li> <li><a href="#deleteobservationlogrequest">DeleteObservationLogRequest</a></li> <li><a href="#earlystoppingspec">EarlyStoppingSpec</a></li> <li><a href="#experiment">Experiment</a></li> <li><a href="#experimentspec">ExperimentSpec</a></li> <li><a href="#experimentspecparameterspecs">ExperimentSpec.ParameterSpecs</a></li> <li><a href="#feasiblespace">FeasibleSpace</a></li> <li><a href="#getobservationlogreply">GetObservationLogReply</a></li> <li><a href="#getobservationlogrequest">GetObservationLogRequest</a></li> <li><a href="#getsuggestionsreply">GetSuggestionsReply</a></li> <li><a href="#getsuggestionsreplyparameterassignments">GetSuggestionsReply.ParameterAssignments</a></li> <li><a href="#getsuggestionsrequest">GetSuggestionsRequest</a></li> <li><a href="#graphconfig">GraphConfig</a></li> <li><a href="#metric">Metric</a></li> <li><a href="#metriclog">MetricLog</a></li> <li><a href="#nasconfig">NasConfig</a></li> <li><a href="#nasconfigoperations">NasConfig.Operations</a></li> <li><a href="#objectivespec">ObjectiveSpec</a></li> <li><a href="#observation">Observation</a></li> <li><a href="#observationlog">ObservationLog</a></li> <li><a href="#operation">Operation</a></li> <li><a href="#operationparameterspecs">Operation.ParameterSpecs</a></li> <li><a href="#parameterassignment">ParameterAssignment</a></li> <li><a href="#parameterspec">ParameterSpec</a></li> <li><a href="#reportobservationlogreply">ReportObservationLogReply</a></li> <li><a href="#reportobservationlogrequest">ReportObservationLogRequest</a></li> <li><a href="#trial">Trial</a></li> <li><a href="#trialspec">TrialSpec</a></li> <li><a href="#trialspecparameterassignments">TrialSpec.ParameterAssignments</a></li> <li><a href="#trialstatus">TrialStatus</a></li> <li><a href="#validatealgorithmsettingsreply">ValidateAlgorithmSettingsReply</a></li> <li><a href="#validatealgorithmsettingsrequest">ValidateAlgorithmSettingsRequest</a></li> <li><a href="#objectivetype">ObjectiveType</a></li> <li><a href="#parametertype">ParameterType</a></li> <li><a href="#trialstatustrialconditiontype">TrialStatus.TrialConditionType</a></li> <li><a href="#earlystopping">EarlyStopping</a></li> <li><a href="#manager">Manager</a></li> <li><a href="#suggestion">Suggestion</a></li> </ul> </li> <li> <p><a href="#scalar-value-types">Scalar Value Types</a></p> <ul> <li> <p><a href="#api.v1.alpha3.ObjectiveType">ObjectiveType</a></p> </li> <li> <p><a href="#api.v1.alpha3.ParameterType">ParameterType</a></p> </li> <li> <p><a href="#api.v1.alpha3.TrialStatus.TrialConditionType">TrialStatus.TrialConditionType</a></p> </li> <li> <p><a href="#api.v1.alpha3.EarlyStopping">EarlyStopping</a></p> </li> <li> <p><a href="#api.v1.alpha3.Manager">Manager</a></p> </li> <li> <p><a href="#api.v1.alpha3.Suggestion">Suggestion</a></p> </li> </ul> </li> <li> <p><a href="#scalar-value-types">Scalar Value Types</a></p> </li> </ul> <p><a name="api.proto"></a></p> <p align="right"><a href="#top">Top</a></p> <h2 id="apiproto">api.proto</h2> <p>Katib API v1alpha3</p> <p><a name="api.v1.alpha3.AlgorithmSetting"></a></p> <h3 id="algorithmsetting">AlgorithmSetting</h3> <table> <thead> <tr> <th>Field</th> <th>Type</th> <th>Label</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td>name</td> <td><a href="#string">string</a></td> <td></td> <td></td> </tr> <tr> <td>value</td> <td><a href="#string">string</a></td> <td></td> <td></td> </tr> </tbody> </table> <p><a name="api.v1.alpha3.AlgorithmSpec"></a></p> <h3 id="algorithmspec">AlgorithmSpec</h3> <table> <thead> <tr> <th>Field</th> <th>Type</th> <th>Label</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td>algorithm_name</td> <td><a href="#string">string</a></td> <td></td> <td></td> </tr> <tr> <td>algorithm_setting</td> <td><a href="#api.v1.alpha3.AlgorithmSetting">AlgorithmSetting</a></td> <td>repeated</td> <td></td> </tr> <tr> <td>early_stopping_spec</td> <td><a href="#api.v1.alpha3.EarlyStoppingSpec">EarlyStoppingSpec</a></td> <td></td> <td></td> </tr> </tbody> </table> <p><a name="api.v1.alpha3.DeleteObservationLogReply"></a></p> <h3 id="deleteobservationlogreply">DeleteObservationLogReply</h3> <p><a name="api.v1.alpha3.DeleteObservationLogRequest"></a></p> <h3 id="deleteobservationlogrequest">DeleteObservationLogRequest</h3> <table> <thead> <tr> <th>Field</th> <th>Type</th> <th>Label</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td>trial_name</td> <td><a href="#string">string</a></td> <td></td> <td></td> </tr> </tbody> </table> <p><a name="api.v1.alpha3.EarlyStoppingSpec"></a></p> <h3 id="earlystoppingspec">EarlyStoppingSpec</h3> <p>TODO: This feature is not yet fully implemented.</p> <p><a name="api.v1.alpha3.Experiment"></a></p> <h3 id="experiment">Experiment</h3> <table> <thead> <tr> <th>Field</th> <th>Type</th> <th>Label</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td>name</td> <td><a href="#string">string</a></td> <td></td> <td>Name of Experiment. This is unique in DB.</td> </tr> <tr> <td>spec</td> <td><a href="#api.v1.alpha3.ExperimentSpec">ExperimentSpec</a></td> <td></td> <td></td> </tr> </tbody> </table> <p><a name="api.v1.alpha3.ExperimentSpec"></a></p> <h3 id="experimentspec">ExperimentSpec</h3> <p>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.</p> <table> <thead> <tr> <th>Field</th> <th>Type</th> <th>Label</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td>parameter_specs</td> <td><a href="#api.v1.alpha3.ExperimentSpec.ParameterSpecs">ExperimentSpec.ParameterSpecs</a></td> <td></td> <td></td> </tr> <tr> <td>objective</td> <td><a href="#api.v1.alpha3.ObjectiveSpec">ObjectiveSpec</a></td> <td></td> <td></td> </tr> <tr> <td>algorithm</td> <td><a href="#api.v1.alpha3.AlgorithmSpec">AlgorithmSpec</a></td> <td></td> <td></td> </tr> <tr> <td>trial_template</td> <td><a href="#string">string</a></td> <td></td> <td></td> </tr> <tr> <td>metrics_collector_spec</td> <td><a href="#string">string</a></td> <td></td> <td></td> </tr> <tr> <td>parallel_trial_count</td> <td><a href="#int32">int32</a></td> <td></td> <td></td> </tr> <tr> <td>max_trial_count</td> <td><a href="#int32">int32</a></td> <td></td> <td></td> </tr> <tr> <td>nas_config</td> <td><a href="#api.v1.alpha3.NasConfig">NasConfig</a></td> <td></td> <td></td> </tr> </tbody> </table> <p><a name="api.v1.alpha3.ExperimentSpec.ParameterSpecs"></a></p> <h3 id="experimentspecparameterspecs">ExperimentSpec.ParameterSpecs</h3> <p>List of ParameterSpec</p> <table> <thead> <tr> <th>Field</th> <th>Type</th> <th>Label</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td>parameters</td> <td><a href="#api.v1.alpha3.ParameterSpec">ParameterSpec</a></td> <td>repeated</td> <td></td> </tr> </tbody> </table> <p><a name="api.v1.alpha3.FeasibleSpace"></a></p> <h3 id="feasiblespace">FeasibleSpace</h3> <p>Feasible space for optimization. Int and Double type use Max/Min. Discrete and Categorical type use List.</p> <table> <thead> <tr> <th>Field</th> <th>Type</th> <th>Label</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td>max</td> <td><a href="#string">string</a></td> <td></td> <td>Max Value</td> </tr> <tr> <td>min</td> <td><a href="#string">string</a></td> <td></td> <td>Minimum Value</td> </tr> <tr> <td>list</td> <td><a href="#string">string</a></td> <td>repeated</td> <td>List of Values.</td> </tr> <tr> <td>step</td> <td><a href="#string">string</a></td> <td></td> <td>Step for double or int parameter</td> </tr> </tbody> </table> <p><a name="api.v1.alpha3.GetObservationLogReply"></a></p> <h3 id="getobservationlogreply">GetObservationLogReply</h3> <table> <thead> <tr> <th>Field</th> <th>Type</th> <th>Label</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td>observation_log</td> <td><a href="#api.v1.alpha3.ObservationLog">ObservationLog</a></td> <td></td> <td></td> </tr> </tbody> </table> <p><a name="api.v1.alpha3.GetObservationLogRequest"></a></p> <h3 id="getobservationlogrequest">GetObservationLogRequest</h3> <table> <thead> <tr> <th>Field</th> <th>Type</th> <th>Label</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td>trial_name</td> <td><a href="#string">string</a></td> <td></td> <td></td> </tr> <tr> <td>metric_name</td> <td><a href="#string">string</a></td> <td></td> <td></td> </tr> <tr> <td>start_time</td> <td><a href="#string">string</a></td> <td></td> <td>The start of the time range. RFC3339 format</td> </tr> <tr> <td>end_time</td> <td><a href="#string">string</a></td> <td></td> <td>The end of the time range. RFC3339 format</td> </tr> </tbody> </table> <p><a name="api.v1.alpha3.GetSuggestionsReply"></a></p> <h3 id="getsuggestionsreply">GetSuggestionsReply</h3> <table> <thead> <tr> <th>Field</th> <th>Type</th> <th>Label</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td>parameter_assignments</td> <td><a href="#api.v1.alpha3.GetSuggestionsReply.ParameterAssignments">GetSuggestionsReply.ParameterAssignments</a></td> <td>repeated</td> <td></td> </tr> <tr> <td>algorithm</td> <td><a href="#api.v1.alpha3.AlgorithmSpec">AlgorithmSpec</a></td> <td></td> <td></td> </tr> </tbody> </table> <p><a name="api.v1.alpha3.GetSuggestionsReply.ParameterAssignments"></a></p> <h3 id="getsuggestionsreplyparameterassignments">GetSuggestionsReply.ParameterAssignments</h3> <table> <thead> <tr> <th>Field</th> <th>Type</th> <th>Label</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td>assignments</td> <td><a href="#api.v1.alpha3.ParameterAssignment">ParameterAssignment</a></td> <td>repeated</td> <td></td> </tr> </tbody> </table> <p><a name="api.v1.alpha3.GetSuggestionsRequest"></a></p> <h3 id="getsuggestionsrequest">GetSuggestionsRequest</h3> <table> <thead> <tr> <th>Field</th> <th>Type</th> <th>Label</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td>experiment</td> <td><a href="#api.v1.alpha3.Experiment">Experiment</a></td> <td></td> <td></td> </tr> <tr> <td>trials</td> <td><a href="#api.v1.alpha3.Trial">Trial</a></td> <td>repeated</td> <td>all completed trials owned by the experiment.</td> </tr> <tr> <td>request_number</td> <td><a href="#int32">int32</a></td> <td></td> <td>The number of Suggestion you request at one time. When you set 3 to request_number, you can get three Suggestions at one time.</td> </tr> </tbody> </table> <p><a name="api.v1.alpha3.GraphConfig"></a></p> <h3 id="graphconfig">GraphConfig</h3> <p>GraphConfig contains a config of DAG</p> <table> <thead> <tr> <th>Field</th> <th>Type</th> <th>Label</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td>num_layers</td> <td><a href="#int32">int32</a></td> <td></td> <td>Number of layers</td> </tr> <tr> <td>input_sizes</td> <td><a href="#int32">int32</a></td> <td>repeated</td> <td>Dimensions of input size</td> </tr> <tr> <td>output_sizes</td> <td><a href="#int32">int32</a></td> <td>repeated</td> <td>Dimensions of output size</td> </tr> </tbody> </table> <p><a name="api.v1.alpha3.Metric"></a></p> <h3 id="metric">Metric</h3> <table> <thead> <tr> <th>Field</th> <th>Type</th> <th>Label</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td>name</td> <td><a href="#string">string</a></td> <td></td> <td></td> </tr> <tr> <td>value</td> <td><a href="#string">string</a></td> <td></td> <td></td> </tr> </tbody> </table> <p><a name="api.v1.alpha3.MetricLog"></a></p> <h3 id="metriclog">MetricLog</h3> <table> <thead> <tr> <th>Field</th> <th>Type</th> <th>Label</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td>time_stamp</td> <td><a href="#string">string</a></td> <td></td> <td>RFC3339 format</td> </tr> <tr> <td>metric</td> <td><a href="#api.v1.alpha3.Metric">Metric</a></td> <td></td> <td></td> </tr> </tbody> </table> <p><a name="api.v1.alpha3.NasConfig"></a></p> <h3 id="nasconfig">NasConfig</h3> <p>NasConfig contains a config of NAS job</p> <table> <thead> <tr> <th>Field</th> <th>Type</th> <th>Label</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td>graph_config</td> <td><a href="#api.v1.alpha3.GraphConfig">GraphConfig</a></td> <td></td> <td>Config of DAG</td> </tr> <tr> <td>operations</td> <td><a href="#api.v1.alpha3.NasConfig.Operations">NasConfig.Operations</a></td> <td></td> <td>List of Operation</td> </tr> </tbody> </table> <p><a name="api.v1.alpha3.NasConfig.Operations"></a></p> <h3 id="nasconfigoperations">NasConfig.Operations</h3> <table> <thead> <tr> <th>Field</th> <th>Type</th> <th>Label</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td>operation</td> <td><a href="#api.v1.alpha3.Operation">Operation</a></td> <td>repeated</td> <td></td> </tr> </tbody> </table> <p><a name="api.v1.alpha3.ObjectiveSpec"></a></p> <h3 id="objectivespec">ObjectiveSpec</h3> <table> <thead> <tr> <th>Field</th> <th>Type</th> <th>Label</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td>type</td> <td><a href="#api.v1.alpha3.ObjectiveType">ObjectiveType</a></td> <td></td> <td></td> </tr> <tr> <td>goal</td> <td><a href="#double">double</a></td> <td></td> <td></td> </tr> <tr> <td>objective_metric_name</td> <td><a href="#string">string</a></td> <td></td> <td></td> </tr> <tr> <td>additional_metric_names</td> <td><a href="#string">string</a></td> <td>repeated</td> <td>This can be empty if we only care about the objective metric.</td> </tr> </tbody> </table> <p><a name="api.v1.alpha3.Observation"></a></p> <h3 id="observation">Observation</h3> <table> <thead> <tr> <th>Field</th> <th>Type</th> <th>Label</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td>metrics</td> <td><a href="#api.v1.alpha3.Metric">Metric</a></td> <td>repeated</td> <td></td> </tr> </tbody> </table> <p><a name="api.v1.alpha3.ObservationLog"></a></p> <h3 id="observationlog">ObservationLog</h3> <table> <thead> <tr> <th>Field</th> <th>Type</th> <th>Label</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td>metric_logs</td> <td><a href="#api.v1.alpha3.MetricLog">MetricLog</a></td> <td>repeated</td> <td></td> </tr> </tbody> </table> <p><a name="api.v1.alpha3.Operation"></a></p> <h3 id="operation">Operation</h3> <p>Config for operations in DAG</p> <table> <thead> <tr> <th>Field</th> <th>Type</th> <th>Label</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td>operation_type</td> <td><a href="#string">string</a></td> <td></td> <td>Type of operation in DAG</td> </tr> <tr> <td>parameter_specs</td> <td><a href="#api.v1.alpha3.Operation.ParameterSpecs">Operation.ParameterSpecs</a></td> <td></td> <td></td> </tr> </tbody> </table> <p><a name="api.v1.alpha3.Operation.ParameterSpecs"></a></p> <h3 id="operationparameterspecs">Operation.ParameterSpecs</h3> <p>List of ParameterSpec</p> <table> <thead> <tr> <th>Field</th> <th>Type</th> <th>Label</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td>parameters</td> <td><a href="#api.v1.alpha3.ParameterSpec">ParameterSpec</a></td> <td>repeated</td> <td></td> </tr> </tbody> </table> <p><a name="api.v1.alpha3.ParameterAssignment"></a></p> <h3 id="parameterassignment">ParameterAssignment</h3> <table> <thead> <tr> <th>Field</th> <th>Type</th> <th>Label</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td>name</td> <td><a href="#string">string</a></td> <td></td> <td></td> </tr> <tr> <td>value</td> <td><a href="#string">string</a></td> <td></td> <td></td> </tr> </tbody> </table> <p><a name="api.v1.alpha3.ParameterSpec"></a></p> <h3 id="parameterspec">ParameterSpec</h3> <p>Config for a Hyper parameter. Katib will create each Hyper parameter from this config.</p> <table> <thead> <tr> <th>Field</th> <th>Type</th> <th>Label</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td>name</td> <td><a href="#string">string</a></td> <td></td> <td>Name of the parameter.</td> </tr> <tr> <td>parameter_type</td> <td><a href="#api.v1.alpha3.ParameterType">ParameterType</a></td> <td></td> <td>Type of the parameter.</td> </tr> <tr> <td>feasible_space</td> <td><a href="#api.v1.alpha3.FeasibleSpace">FeasibleSpace</a></td> <td></td> <td>FeasibleSpace for the parameter.</td> </tr> </tbody> </table> <p><a name="api.v1.alpha3.ReportObservationLogReply"></a></p> <h3 id="reportobservationlogreply">ReportObservationLogReply</h3> <p><a name="api.v1.alpha3.ReportObservationLogRequest"></a></p> <h3 id="reportobservationlogrequest">ReportObservationLogRequest</h3> <table> <thead> <tr> <th>Field</th> <th>Type</th> <th>Label</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td>trial_name</td> <td><a href="#string">string</a></td> <td></td> <td></td> </tr> <tr> <td>observation_log</td> <td><a href="#api.v1.alpha3.ObservationLog">ObservationLog</a></td> <td></td> <td></td> </tr> </tbody> </table> <p><a name="api.v1.alpha3.Trial"></a></p> <h3 id="trial">Trial</h3> <table> <thead> <tr> <th>Field</th> <th>Type</th> <th>Label</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td>name</td> <td><a href="#string">string</a></td> <td></td> <td></td> </tr> <tr> <td>spec</td> <td><a href="#api.v1.alpha3.TrialSpec">TrialSpec</a></td> <td></td> <td></td> </tr> <tr> <td>status</td> <td><a href="#api.v1.alpha3.TrialStatus">TrialStatus</a></td> <td></td> <td></td> </tr> </tbody> </table> <p><a name="api.v1.alpha3.TrialSpec"></a></p> <h3 id="trialspec">TrialSpec</h3> <table> <thead> <tr> <th>Field</th> <th>Type</th> <th>Label</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td>experiment_name</td> <td><a href="#string">string</a></td> <td></td> <td></td> </tr> <tr> <td>objective</td> <td><a href="#api.v1.alpha3.ObjectiveSpec">ObjectiveSpec</a></td> <td></td> <td></td> </tr> <tr> <td>parameter_assignments</td> <td><a href="#api.v1.alpha3.TrialSpec.ParameterAssignments">TrialSpec.ParameterAssignments</a></td> <td></td> <td></td> </tr> <tr> <td>run_spec</td> <td><a href="#string">string</a></td> <td></td> <td></td> </tr> <tr> <td>metrics_collector_spec</td> <td><a href="#string">string</a></td> <td></td> <td></td> </tr> </tbody> </table> <p><a name="api.v1.alpha3.TrialSpec.ParameterAssignments"></a></p> <h3 id="trialspecparameterassignments">TrialSpec.ParameterAssignments</h3> <p>List of ParameterAssignment</p> <table> <thead> <tr> <th>Field</th> <th>Type</th> <th>Label</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td>assignments</td> <td><a href="#api.v1.alpha3.ParameterAssignment">ParameterAssignment</a></td> <td>repeated</td> <td></td> </tr> </tbody> </table> <p><a name="api.v1.alpha3.TrialStatus"></a></p> <h3 id="trialstatus">TrialStatus</h3> <table> <thead> <tr> <th>Field</th> <th>Type</th> <th>Label</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td>start_time</td> <td><a href="#string">string</a></td> <td></td> <td>RFC3339 format</td> </tr> <tr> <td>completion_time</td> <td><a href="#string">string</a></td> <td></td> <td>RFC3339 format</td> </tr> <tr> <td>condition</td> <td><a href="#api.v1.alpha3.TrialStatus.TrialConditionType">TrialStatus.TrialConditionType</a></td> <td></td> <td></td> </tr> <tr> <td>observation</td> <td><a href="#api.v1.alpha3.Observation">Observation</a></td> <td></td> <td>The best observation in logs.</td> </tr> </tbody> </table> <p><a name="api.v1.alpha3.ValidateAlgorithmSettingsReply"></a></p> <h3 id="validatealgorithmsettingsreply">ValidateAlgorithmSettingsReply</h3> <p>Return INVALID_ARGUMENT Error if Algorithm Settings are not Valid</p> <p><a name="api.v1.alpha3.ValidateAlgorithmSettingsRequest"></a></p> <h3 id="validatealgorithmsettingsrequest">ValidateAlgorithmSettingsRequest</h3> <table> <thead> <tr> <th>Field</th> <th>Type</th> <th>Label</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td>experiment</td> <td><a href="#api.v1.alpha3.Experiment">Experiment</a></td> <td></td> <td></td> </tr> </tbody> </table> <p><a name="api.v1.alpha3.ObjectiveType"></a></p> <h3 id="objectivetype">ObjectiveType</h3> <p>Direction of optimization. Minimize or Maximize.</p> <table> <thead> <tr> <th>Name</th> <th>Number</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td>UNKNOWN</td> <td>0</td> <td>Undefined type and not used.</td> </tr> <tr> <td>MINIMIZE</td> <td>1</td> <td>Minimize</td> </tr> <tr> <td>MAXIMIZE</td> <td>2</td> <td>Maximize</td> </tr> </tbody> </table> <p><a name="api.v1.alpha3.ParameterType"></a></p> <h3 id="parametertype">ParameterType</h3> <p>Types of value for HyperParameter.</p> <table> <thead> <tr> <th>Name</th> <th>Number</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td>UNKNOWN_TYPE</td> <td>0</td> <td>Undefined type and not used.</td> </tr> <tr> <td>DOUBLE</td> <td>1</td> <td>Double float type. Use &quot;Max/Min&quot;.</td> </tr> <tr> <td>INT</td> <td>2</td> <td>Int type. Use &quot;Max/Min&quot;.</td> </tr> <tr> <td>DISCRETE</td> <td>3</td> <td>Discrete number type. Use &quot;List&quot; as float.</td> </tr> <tr> <td>CATEGORICAL</td> <td>4</td> <td>Categorical type. Use &quot;List&quot; as string.</td> </tr> </tbody> </table> <p><a name="api.v1.alpha3.TrialStatus.TrialConditionType"></a></p> <h3 id="trialstatustrialconditiontype">TrialStatus.TrialConditionType</h3> <table> <thead> <tr> <th>Name</th> <th>Number</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td>CREATED</td> <td>0</td> <td></td> </tr> <tr> <td>RUNNING</td> <td>1</td> <td></td> </tr> <tr> <td>SUCCEEDED</td> <td>2</td> <td></td> </tr> <tr> <td>KILLED</td> <td>3</td> <td></td> </tr> <tr> <td>FAILED</td> <td>4</td> <td></td> </tr> <tr> <td>UNKNOWN</td> <td>5</td> <td></td> </tr> </tbody> </table> <p><a name="api.v1.alpha3.EarlyStopping"></a></p> <h3 id="earlystopping">EarlyStopping</h3> <p>TODO: This feature is not yet fully implemented.</p> <table> <thead> <tr> <th>Method Name</th> <th>Request Type</th> <th>Response Type</th> <th>Description</th> </tr> </thead> </table> <p><a name="api.v1.alpha3.Manager"></a></p> <h3 id="manager">Manager</h3> <p>Service for Main API for Katib For each RPC service, we define mapping to HTTP REST API method. The mapping includes the URL path, query parameters and request body. <a href="https://cloud.google.com/service-infrastructure/docs/service-management/reference/rpc/google.api#http">https://cloud.google.com/service-infrastructure/docs/service-management/reference/rpc/google.api#http</a></p> <table> <thead> <tr> <th>Method Name</th> <th>Request Type</th> <th>Response Type</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td>ReportObservationLog</td> <td><a href="#api.v1.alpha3.ReportObservationLogRequest">ReportObservationLogRequest</a></td> <td><a href="#api.v1.alpha3.ReportObservationLogReply">ReportObservationLogReply</a></td> <td>Report 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.</td> </tr> <tr> <td>GetObservationLog</td> <td><a href="#api.v1.alpha3.GetObservationLogRequest">GetObservationLogRequest</a></td> <td><a href="#api.v1.alpha3.GetObservationLogReply">GetObservationLogReply</a></td> <td>Get all log of Observations for a Trial.</td> </tr> <tr> <td>DeleteObservationLog</td> <td><a href="#api.v1.alpha3.DeleteObservationLogRequest">DeleteObservationLogRequest</a></td> <td><a href="#api.v1.alpha3.DeleteObservationLogReply">DeleteObservationLogReply</a></td> <td>Delete all log of Observations for a Trial.</td> </tr> </tbody> </table> <p><a name="api.v1.alpha3.Suggestion"></a></p> <h3 id="suggestion">Suggestion</h3> <table> <thead> <tr> <th>Method Name</th> <th>Request Type</th> <th>Response Type</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td>GetSuggestions</td> <td><a href="#api.v1.alpha3.GetSuggestionsRequest">GetSuggestionsRequest</a></td> <td><a href="#api.v1.alpha3.GetSuggestionsReply">GetSuggestionsReply</a></td> <td></td> </tr> <tr> <td>ValidateAlgorithmSettings</td> <td><a href="#api.v1.alpha3.ValidateAlgorithmSettingsRequest">ValidateAlgorithmSettingsRequest</a></td> <td><a href="#api.v1.alpha3.ValidateAlgorithmSettingsReply">ValidateAlgorithmSettingsReply</a></td> <td></td> </tr> </tbody> </table> <h2 id="scalar-value-types">Scalar Value Types</h2> <table> <thead> <tr> <th>.proto Type</th> <th>Notes</th> <th>C++ Type</th> <th>Java Type</th> <th>Python Type</th> </tr> </thead> <tbody> <tr> <td><a name="double" /> double</td> <td></td> <td>double</td> <td>double</td> <td>float</td> </tr> <tr> <td><a name="float" /> float</td> <td></td> <td>float</td> <td>float</td> <td>float</td> </tr> <tr> <td><a name="int32" /> int32</td> <td>Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead.</td> <td>int32</td> <td>int</td> <td>int</td> </tr> <tr> <td><a name="int64" /> int64</td> <td>Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead.</td> <td>int64</td> <td>long</td> <td>int/long</td> </tr> <tr> <td><a name="uint32" /> uint32</td> <td>Uses variable-length encoding.</td> <td>uint32</td> <td>int</td> <td>int/long</td> </tr> <tr> <td><a name="uint64" /> uint64</td> <td>Uses variable-length encoding.</td> <td>uint64</td> <td>long</td> <td>int/long</td> </tr> <tr> <td><a name="sint32" /> sint32</td> <td>Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s.</td> <td>int32</td> <td>int</td> <td>int</td> </tr> <tr> <td><a name="sint64" /> sint64</td> <td>Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s.</td> <td>int64</td> <td>long</td> <td>int/long</td> </tr> <tr> <td><a name="fixed32" /> fixed32</td> <td>Always four bytes. More efficient than uint32 if values are often greater than 2^28.</td> <td>uint32</td> <td>int</td> <td>int</td> </tr> <tr> <td><a name="fixed64" /> fixed64</td> <td>Always eight bytes. More efficient than uint64 if values are often greater than 2^56.</td> <td>uint64</td> <td>long</td> <td>int/long</td> </tr> <tr> <td><a name="sfixed32" /> sfixed32</td> <td>Always four bytes.</td> <td>int32</td> <td>int</td> <td>int</td> </tr> <tr> <td><a name="sfixed64" /> sfixed64</td> <td>Always eight bytes.</td> <td>int64</td> <td>long</td> <td>int/long</td> </tr> <tr> <td><a name="bool" /> bool</td> <td></td> <td>bool</td> <td>boolean</td> <td>boolean</td> </tr> <tr> <td><a name="string" /> string</td> <td>A string must always contain UTF-8 encoded or 7-bit ASCII text.</td> <td>string</td> <td>String</td> <td>str/unicode</td> </tr> <tr> <td><a name="bytes" /> bytes</td> <td>May contain any arbitrary sequence of bytes.</td> <td>string</td> <td>ByteString</td> <td>str</td> </tr> </tbody> </table>