Default package

Get desktop application:
View/edit binary Protocol Buffers messages

Used in: TrainingRunData

• optional string source = 1

Used in: TrainingRunData

• optional int32 sort = 1

• optional bool default_show = 2

Used in: Prior

• optional double shape_a = 1

• optional double shape_b = 2

Used in: ExperimentParameter, ExperimentThreshold

• optional double minimum = 1

• optional double maximum = 2

Used in: CategoricalHyperparameters

• optional string parameter_name = 1

• repeated double length_list = 2

Used in: MultimetricHyperparameterValue

• optional double hyperparameter_alpha = 1

• repeated CategoricalHyperparameterLengths hyperparameter_lengths = 2

• optional double hyperparameter_tikhonov = 3

• optional double task_length = 4

• repeated ObservationValue values = 1

• optional google.protobuf.Struct metadata = 2

Used in: Parent

• optional double value = 1

• optional string name = 2

• optional Child recursive = 3

• optional int64 date_created = 1

• optional bool deleted = 2

• optional ClientSecurity client_security = 3

Used in: ClientMeta

• optional bool allow_users_to_see_experiments_by_others = 1

Used in: TagData

• required int32 red = 1

• required int32 green = 2

• required int32 blue = 3

Used in: TrainingRunData

(message has no fields)

Used in: ExperimentParameter

• optional string name = 1

• optional int32 enum_index = 2

• optional bool deleted = 3

Used in: ExperimentMeta

• optional string name = 1

• repeated ExperimentConditionalValue values = 2

• optional double replacement_value_if_missing = 3

  This is needed to make ExperimentConditionals look like ExperimentParameters for the purposes of reading from the assignments map. This is plausibly useful, if we ever allow deleting / adding conditionals, but we do not allow it now

Used in: ExperimentConditional

• optional string name = 1

• optional int32 enum_index = 2

Used in: ExperimentMeta

• optional string type = 1

• repeated Term terms = 2

• optional double rhs = 3

• repeated ExperimentParameter all_parameters_unsorted = 1

• optional ExperimentMeta.ExperimentType experiment_type = 2

• optional string client_provided_data = 3

• optional int32 observation_budget = 4

• optional bool development = 5

• repeated ExperimentMetric metrics = 6

• repeated ExperimentConstraint constraints = 7

• optional int32 num_solutions = 8

• optional bool force_hitandrun_sampling = 9

• repeated ExperimentConditional conditionals = 10

• optional int32 parallel_bandwidth = 11

• repeated Task tasks = 12

• map<string, MetricImportanceMap> importance_maps = 13

• optional bool runs_only = 14

• optional int64 unused_int64_key_for_testing = 999

Used in: ExperimentMeta

• OFFLINE = 0

  normal sigopt experiment

• RANDOM = 1

• GRID = 2

Used in: ExperimentMeta

• optional string name = 1

• optional MetricObjective objective = 2

• optional double threshold = 3

• optional ExperimentMetric.MetricStrategy strategy = 4

Used in: ExperimentMetric

• OPTIMIZE = 0

• STORE = 1

• CONSTRAINT = 2

Used in: ExperimentMeta

• optional string name = 1

• optional Bounds bounds = 2

• optional ExperimentParameterType param_type = 3

• repeated ExperimentCategoricalValue all_categorical_values = 4

• optional bool deleted = 5

• optional double replacement_value_if_missing = 6

• optional bool ignore_default = 7

• repeated double grid_values = 8

  Follows the same convention as ObservationParam, where categoricals are represented by their enum index

• repeated ParameterCondition conditions = 9

• optional Prior prior = 10

• optional ExperimentParameter.Transformation transformation = 11

Used in: ExperimentParameter

• TRANSFORMATION_NONE = 0

• TRANSFORMATION_LOG = 1

Used in: ExperimentParameter

• PARAMETER_DOUBLE = 0

• PARAMETER_INT = 1

• PARAMETER_CATEGORICAL = 2

• optional string name = 1

• optional Bounds bounds = 2

Used in: SysMetadata

• map<string, float> scores = 1

• optional string type = 2

• optional int64 content_length = 1

• optional bytes content_md5 = 2

• optional string content_type = 3

• oneof storage_method

  • S3StorageMethod s3 = 4

• optional int64 experiment_id = 1

• optional bool force = 2

Used in: Prior

• optional double mean = 1

• optional double scale = 2

Used in: TrainingRunData

• optional string content = 1

• optional string message_type = 1

• optional bytes serialized_body = 2

• optional int64 enqueue_time = 3

Used in: MetricImportanceMap

• optional double importance = 1

Used in: ExperimentMeta

• map<string, MetricImportance> importances = 1

Used in: ExperimentMetric

• MAXIMIZE = 0

• MINIMIZE = 1

Used in: MultimetricHyperparameters

• optional string metric_name = 1

• optional CategoricalHyperparameters categorical_hyperparameters = 2

• repeated MultimetricHyperparameterValue multimetric_hyperparameter_value = 1

• optional int64 experiment_id = 1

• optional bool force = 2

• optional int32 count = 3

Used in: Prior

• optional double mean = 1

• optional double scale = 2

(message has no fields)

• optional int64 timestamp = 1

• optional bool reported_failure = 2

• optional string client_provided_data = 3

• optional bool deleted = 4

• repeated ObservationValue values = 5

• optional ObservationMetrics metrics = 6

• map<string, double> assignments_map = 7

• optional Task task = 8

Used in: ObservationData

• optional int64 suggestion_observation_time = 12

• optional int64 num_open_suggestions = 13

Used in: CheckpointData, ObservationData

• optional string name = 1

• optional double value = 2

• optional double value_var = 3

• optional int64 experiment_id = 1

• optional bool force = 2

• optional bool academic = 1

• repeated string email_domains = 2

• optional bool allow_signup_from_email_domains = 3

• optional int64 client_for_email_signup = 4

• repeated PagingSymbol symbols = 1

Used in: PagingMarker

• oneof type

  • double double_value = 1

  • int64 int_value = 2

  • PagingSymbol.NullValue null_value = 3

  • string string_value = 4

  • bool bool_value = 5

  • google.protobuf.Timestamp timestamp_value = 6

Used in: PagingSymbol

• NULL_VALUE = 0

Used in: ExperimentParameter

• optional string name = 1

• repeated double values = 2

• optional double optional_double_field = 1

• optional string optional_string_field = 2

• optional Child optional_composite_field = 3

• optional Parent optional_recursive_field = 4

• repeated double repeated_double_field = 5

• repeated string repeated_string_field = 6

• repeated Child repeated_composite_field = 7

• repeated Parent repeated_recursive_field = 8

• optional string variable_name = 9

• optional Parent variable_recursive_field = 10

• map<string, double> map_field = 11

• map<string, Parent> recursive_map_field = 12

Used in: TokenMeta

• NONE = 0

• READ = 1

• WRITE = 2

• ADMIN = 3

• optional bool can_admin = 1

• optional bool can_write = 2

• optional bool can_read = 3

• optional bool can_see_experiments_by_others = 4

Used in: ExperimentParameter

• oneof prior

  • NormalPrior normal_prior = 1

  • LaplacePrior laplace_prior = 2

  • BetaPrior beta_prior = 3

• optional Prior.PriorType prior_type = 4

Used in: Prior

• NORMAL = 0

• LAPLACE = 1

• BETA = 2

• optional string client_provided_data = 1

• optional google.protobuf.Struct metadata = 1

• required SuggestionData suggestion_data = 1

• optional bool deleted = 2

Used in: FileData

• required string key = 1

• repeated string to = 1

• optional string from_address = 2

• optional string subject = 3

• optional string body_html = 4

• optional bool bypass_list_management = 5

Used in: TrainingRunData

• optional string content = 1

• optional string hash = 2

Used in: QueuedSuggestionMeta, SuggestionMeta

• map<string, double> assignments_map = 1

• optional Task task = 2

• optional SuggestionData suggestion_data = 1

• optional bool deleted = 2

Used in: TrainingRunData

• optional FeatureImportances feature_importances = 1

• required Color color = 1

Used in: ExperimentMeta, ObservationData, SuggestionData

• optional string name = 1

• optional double cost = 2

Used in: ExperimentConstraint

• optional string name = 1

• optional double coeff = 2

• optional int64 creating_user_id = 1

• optional int64 guest_experiment_id = 2

• optional int64 date_created = 3

• optional Permission guest_permissions = 4

• optional bool lasts_forever = 5

• optional TokenMeta.Scope scope = 6

  A Scope can be set on a token, and then only Handlers which permit that Scope can be called. Used to create a token that can only call a subset of endpoints

• optional int64 ttl_seconds = 7

• optional int64 guest_training_run_id = 8

• optional int64 date_renewed = 9

• optional bool can_renew = 10

Used in: TokenMeta

• ALL_ENDPOINTS = 0

• SHARED_EXPERIMENT_SCOPE = 1

  Scope used for tokens in "Share Experiment" URLs. Should only have access to endpoints needed to show read-only experiment page.

• SIGNUP_SCOPE = 2

  Anonymous token to read org information before signup. Used when generating signup links that are tied to a specific organization.

• optional google.protobuf.Struct metadata = 1

• map<string, Dataset> datasets = 2

• optional SourceCode source_code = 3

• map<string, Log> logs = 4

• optional google.protobuf.Struct assignments_struct = 5

  Unfortunately, we can't reuse assignments / values here from observations, because we don't have the list of categorical values we would need to rebuild the categorical value from the double value TODO: Think about the best data model here

• map<string, TrainingRunValue> values_map = 6

  NOTE: This also deviates from how we store values on other objects. This is so we can enable filtering by values. If that's not necessary, we could consider rethinking how we store this

• optional TrainingRunData.TrainingRunState state = 7

• optional string name = 8

• optional TrainingRunModel training_run_model = 9

• optional bool favorite = 10

• map<int64, bool> tags = 11

• map<int64, bool> files = 12

• optional SysMetadata sys_metadata = 13

• optional google.protobuf.Struct dev_metadata = 14

• map<string, AssignmentsRunMeta> assignments_meta = 15

• map<string, AssignmentsSources> assignments_sources = 16

  Note: map<SOURCE_NAME, AssignmentsSources> - this is metadata about the source

Used in: TrainingRunData

• ACTIVE = 0

• COMPLETED = 1

• FAILED = 2

Used in: TrainingRunData

• optional string type = 1

TODO: Should this just be ObservationValue? Since we are already storing in a different format below, may be an appropriate opportunity to use a more terse struct with slimmer JSON keys and no `name` field

Used in: TrainingRunData

• optional double value = 1

• optional double value_var = 2

Used in: UserMeta

• optional bool track = 1

• optional bool optimize = 2

• optional bool has_verified_email = 1

• optional int64 date_created = 2

• optional bool educational_user = 3

• optional int64 password_reset_timestamp = 4

• optional int64 email_verification_timestamp = 5

• optional bool needs_password_reset = 6

• optional bool deleted = 7

• optional string hashed_password_reset_code = 8

• optional string pending_client_name = 9

• optional int64 date_deleted = 10

• optional string hashed_email_verification_code = 11

• optional string public_cert = 12

• optional int64 pending_client_id = 13

• optional Usage planned_usage = 16

• optional bool show_welcome = 17