submission.proto

/* Copyright 2019 The Waymo Open Dataset Authors.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
==============================================================================*/

syntax = "proto2";

package waymo.open_dataset;

import "waymo_open_dataset/label.proto";
import "waymo_open_dataset/protos/metrics.proto";

// If your inference results are too large to fit in one proto, you can shard
// them to multiple files by sharding the inference_results field.
// Next ID: 17.
message Submission {
  // These values correspond to the tasks on the waymo.com/open site.
  enum Task {
    UNKNOWN = 0;
    DETECTION_2D = 1;
    DETECTION_3D = 2;
    TRACKING_2D = 3;
    TRACKING_3D = 4;
    DOMAIN_ADAPTATION = 5;
    CAMERA_ONLY_DETECTION_3D = 6;
  }

  enum SensorType {
    INVALID = 0;
    LIDAR_ALL = 1;
    LIDAR_TOP = 2;
    CAMERA_ALL = 3;
    CAMERA_LIDAR_TOP = 4;
    CAMERA_LIDAR_ALL = 5;
  }

  // This specifies which task this submission is for.
  optional Task task = 1;

  // This must be set as the full email used to register at waymo.com/open.
  optional string account_name = 13;
  // This name needs to be short, descriptive and unique. Only the latest result
  // of the method from a user will show up on the leaderboard.
  optional string unique_method_name = 2;
  repeated string authors = 3;
  optional string affiliation = 4;
  optional string description = 5;

  // Link to paper or other link that describes the method.
  optional string method_link = 6;

  // Link to the latency submission Docker image stored in Google Storage bucket
  // or pushed to Google Container/Artifact Registry.
  // Google Storage bucket example:
  //   gs://example_bucket_name/example_folder/example_docker_image.tar.gz
  // Google Container/Artifact Registry example:
  //   us-west1-docker.pkg.dev/example-registry-name/example-folder/example-image@sha256:example-sha256-hash
  // Follow latency/README.md to create a docker file.
  optional string docker_image_source = 16;

  optional SensorType sensor_type = 12;
  // Number of frames used.
  optional int32 number_past_frames_exclude_current = 9;
  optional int32 number_future_frames_exclude_current = 10;

  // Inference results.
  optional Objects inference_results = 11;

  // Object types this submission contains. By default, we assume all types.
  repeated Label.Type object_types = 14;

  // Self-reported end to end inference latency in seconds. This is NOT shown on
  // the leaderboard for now. But it is still recommended to set this. Do not
  // confuse this with the `docker_image_source` field above. That is needed to
  // evaluate your model latency on our server.
  optional float latency_second = 15;
  reserved 7, 8;
}