offline-sketch-evidence.schema.json

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "ASAPPlanner offline sketch evidence v1",
  "description": "Offline observations only. Runtime validation additionally checks duplicate IDs, validity intervals, finite numbers, sample cardinalities and contextual applicability.",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "schema_version": {
      "const": 1
    },
    "benchmark_version": {
      "type": "string",
      "minLength": 1
    },
    "model_version": {
      "const": "empirical-update-cpu-v1"
    },
    "records": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/record"
      }
    }
  },
  "required": [
    "schema_version",
    "benchmark_version",
    "model_version",
    "records"
  ],
  "$defs": {
    "measurement": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "value": {
          "type": "number",
          "minimum": 0
        },
        "stddev": {
          "anyOf": [
            {
              "type": "number",
              "minimum": 0
            },
            {
              "type": "null"
            }
          ]
        },
        "samples": {
          "type": "integer",
          "minimum": 1
        },
        "method": {
          "anyOf": [
            {
              "type": "string",
              "minLength": 1
            },
            {
              "type": "null"
            }
          ]
        }
      },
      "required": [
        "value",
        "samples"
      ]
    },
    "distribution": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "string",
          "minLength": 1
        },
        "family": {
          "type": "string",
          "minLength": 1
        },
        "sample_count": {
          "type": "integer",
          "minimum": 1
        },
        "distinct_count": {
          "anyOf": [
            {
              "type": "integer",
              "minimum": 0
            },
            {
              "type": "null"
            }
          ]
        },
        "parameters": {
          "type": "object"
        }
      },
      "required": [
        "id",
        "family",
        "sample_count",
        "parameters"
      ]
    },
    "environment": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "string",
          "minLength": 1
        },
        "cpu": {
          "type": "string",
          "minLength": 1
        },
        "os": {
          "type": "string",
          "minLength": 1
        },
        "runtime": {
          "type": "string",
          "minLength": 1
        },
        "implementation": {
          "type": "string",
          "minLength": 1
        },
        "implementation_version": {
          "type": "string",
          "minLength": 1
        }
      },
      "required": [
        "id",
        "cpu",
        "os",
        "runtime",
        "implementation",
        "implementation_version"
      ]
    },
    "provenance": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "command": {
          "type": "string",
          "minLength": 1
        },
        "dataset": {
          "type": "string",
          "minLength": 1
        },
        "source_revision": {
          "type": "string",
          "minLength": 1
        },
        "repetitions": {
          "type": "integer",
          "minimum": 1
        }
      },
      "required": [
        "command",
        "dataset",
        "source_revision",
        "repetitions"
      ]
    },
    "metrics": {
      "description": "Flat v1 wire representation of shared PhysicalResources<MeasuredCpu, Measurement>; internal resource nesting does not change this JSON layout.",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "build_cpu_ns": {
          "description": "Empty sketch construction CPU nanoseconds; full snapshot build additionally charges sample_count times update_cpu_ns.",
          "anyOf": [
            {
              "$ref": "#/$defs/measurement"
            },
            {
              "type": "null"
            }
          ]
        },
        "update_cpu_ns": {
          "anyOf": [
            {
              "$ref": "#/$defs/measurement"
            },
            {
              "type": "null"
            }
          ]
        },
        "merge_cpu_ns": {
          "anyOf": [
            {
              "$ref": "#/$defs/measurement"
            },
            {
              "type": "null"
            }
          ]
        },
        "read_cpu_ns": {
          "anyOf": [
            {
              "$ref": "#/$defs/measurement"
            },
            {
              "type": "null"
            }
          ]
        },
        "prepare_cpu_ns": {
          "description": "Optional measured preparation CPU nanoseconds. Omitted when unavailable by the compatibility serializer.",
          "anyOf": [
            {
              "$ref": "#/$defs/measurement"
            },
            {
              "type": "null"
            }
          ]
        },
        "retained_bytes": {
          "anyOf": [
            {
              "$ref": "#/$defs/measurement"
            },
            {
              "type": "null"
            }
          ]
        },
        "peak_bytes": {
          "anyOf": [
            {
              "$ref": "#/$defs/measurement"
            },
            {
              "type": "null"
            }
          ]
        },
        "serialized_bytes": {
          "anyOf": [
            {
              "$ref": "#/$defs/measurement"
            },
            {
              "type": "null"
            }
          ]
        },
        "scan_bytes": {
          "description": "Optional bytes read by scan operations; distinct from retained memory and allocated disk space. Omitted when unavailable by the compatibility serializer.",
          "anyOf": [
            {
              "$ref": "#/$defs/measurement"
            },
            {
              "type": "null"
            }
          ]
        },
        "disk_bytes": {
          "anyOf": [
            {
              "$ref": "#/$defs/measurement"
            },
            {
              "type": "null"
            }
          ]
        }
      },
      "required": []
    },
    "error": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "metric": {
          "type": "string",
          "minLength": 1
        },
        "mean": {
          "anyOf": [
            {
              "type": "number",
              "minimum": 0
            },
            {
              "type": "null"
            }
          ]
        },
        "max": {
          "anyOf": [
            {
              "type": "number",
              "minimum": 0
            },
            {
              "type": "null"
            }
          ]
        },
        "trials": {
          "type": "integer",
          "minimum": 1
        },
        "ground_truth_method": {
          "type": "string",
          "minLength": 1
        },
        "query": {}
      },
      "required": [
        "metric",
        "trials",
        "ground_truth_method",
        "query"
      ]
    },
    "record": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "string",
          "minLength": 1
        },
        "algorithm": {
          "enum": [
            "Kll",
            "Cms",
            "Hll",
            "DDSketch",
            "CmsWithHeap",
            "Kmv",
            "Theta",
            "CountSketch",
            "CountSketchWithHeap"
          ]
        },
        "params": {
          "oneOf": [
            {
              "type": "object",
              "additionalProperties": false,
              "properties": {
                "Kll": {
                  "type": "object",
                  "additionalProperties": false,
                  "properties": {
                    "k": {
                      "type": "integer",
                      "minimum": 1
                    }
                  },
                  "required": [
                    "k"
                  ]
                }
              },
              "required": [
                "Kll"
              ]
            },
            {
              "type": "object",
              "additionalProperties": false,
              "properties": {
                "Cms": {
                  "type": "object",
                  "additionalProperties": false,
                  "properties": {
                    "width": {
                      "type": "integer",
                      "minimum": 1
                    },
                    "depth": {
                      "type": "integer",
                      "minimum": 1
                    }
                  },
                  "required": [
                    "width",
                    "depth"
                  ]
                }
              },
              "required": [
                "Cms"
              ]
            },
            {
              "type": "object",
              "additionalProperties": false,
              "properties": {
                "Hll": {
                  "type": "object",
                  "additionalProperties": false,
                  "properties": {
                    "precision": {
                      "type": "integer",
                      "minimum": 4,
                      "maximum": 18
                    }
                  },
                  "required": [
                    "precision"
                  ]
                }
              },
              "required": [
                "Hll"
              ]
            },
            {
              "type": "object",
              "additionalProperties": false,
              "properties": {
                "DDSketch": {
                  "type": "object",
                  "additionalProperties": false,
                  "properties": {
                    "alpha": {
                      "type": "number",
                      "exclusiveMinimum": 0,
                      "exclusiveMaximum": 1
                    }
                  },
                  "required": [
                    "alpha"
                  ]
                }
              },
              "required": [
                "DDSketch"
              ]
            },
            {
              "type": "object",
              "additionalProperties": false,
              "properties": {
                "CmsWithHeap": {
                  "type": "object",
                  "additionalProperties": false,
                  "properties": {
                    "width": {
                      "type": "integer",
                      "minimum": 1
                    },
                    "depth": {
                      "type": "integer",
                      "minimum": 1
                    },
                    "heap_size": {
                      "type": "integer",
                      "minimum": 1
                    }
                  },
                  "required": [
                    "width",
                    "depth",
                    "heap_size"
                  ]
                }
              },
              "required": [
                "CmsWithHeap"
              ]
            },
            {
              "type": "object",
              "additionalProperties": false,
              "properties": {
                "Kmv": {
                  "type": "object",
                  "additionalProperties": false,
                  "properties": {
                    "k": {
                      "type": "integer",
                      "minimum": 1
                    }
                  },
                  "required": [
                    "k"
                  ]
                }
              },
              "required": [
                "Kmv"
              ]
            },
            {
              "type": "object",
              "additionalProperties": false,
              "properties": {
                "Theta": {
                  "type": "object",
                  "additionalProperties": false,
                  "properties": {
                    "k": {
                      "type": "integer",
                      "minimum": 1
                    }
                  },
                  "required": [
                    "k"
                  ]
                }
              },
              "required": [
                "Theta"
              ]
            },
            {
              "type": "object",
              "additionalProperties": false,
              "properties": {
                "CountSketch": {
                  "type": "object",
                  "additionalProperties": false,
                  "properties": {
                    "width": {
                      "type": "integer",
                      "minimum": 1
                    },
                    "depth": {
                      "type": "integer",
                      "minimum": 1
                    }
                  },
                  "required": [
                    "width",
                    "depth"
                  ]
                }
              },
              "required": [
                "CountSketch"
              ]
            },
            {
              "type": "object",
              "additionalProperties": false,
              "properties": {
                "CountSketchWithHeap": {
                  "type": "object",
                  "additionalProperties": false,
                  "properties": {
                    "width": {
                      "type": "integer",
                      "minimum": 1
                    },
                    "depth": {
                      "type": "integer",
                      "minimum": 1
                    },
                    "heap_size": {
                      "type": "integer",
                      "minimum": 1
                    }
                  },
                  "required": [
                    "width",
                    "depth",
                    "heap_size"
                  ]
                }
              },
              "required": [
                "CountSketchWithHeap"
              ]
            }
          ]
        },
        "distribution": {
          "$ref": "#/$defs/distribution"
        },
        "environment": {
          "$ref": "#/$defs/environment"
        },
        "measured_at_unix_seconds": {
          "type": "integer",
          "minimum": 0
        },
        "valid_until_unix_seconds": {
          "type": "integer",
          "minimum": 0
        },
        "provenance": {
          "$ref": "#/$defs/provenance"
        },
        "metrics": {
          "$ref": "#/$defs/metrics"
        },
        "error": {
          "anyOf": [
            {
              "$ref": "#/$defs/error"
            },
            {
              "type": "null"
            }
          ]
        }
      },
      "required": [
        "id",
        "algorithm",
        "params",
        "distribution",
        "environment",
        "measured_at_unix_seconds",
        "valid_until_unix_seconds",
        "provenance",
        "metrics"
      ],
      "allOf": [
        {
          "if": {
            "properties": {
              "algorithm": {
                "const": "Kll"
              }
            }
          },
          "then": {
            "properties": {
              "params": {
                "required": [
                  "Kll"
                ]
              }
            }
          }
        },
        {
          "if": {
            "properties": {
              "algorithm": {
                "const": "Cms"
              }
            }
          },
          "then": {
            "properties": {
              "params": {
                "required": [
                  "Cms"
                ]
              }
            }
          }
        },
        {
          "if": {
            "properties": {
              "algorithm": {
                "const": "Hll"
              }
            }
          },
          "then": {
            "properties": {
              "params": {
                "required": [
                  "Hll"
                ]
              }
            }
          }
        },
        {
          "if": {
            "properties": {
              "algorithm": {
                "const": "DDSketch"
              }
            }
          },
          "then": {
            "properties": {
              "params": {
                "required": [
                  "DDSketch"
                ]
              }
            }
          }
        },
        {
          "if": {
            "properties": {
              "algorithm": {
                "const": "CmsWithHeap"
              }
            }
          },
          "then": {
            "properties": {
              "params": {
                "required": [
                  "CmsWithHeap"
                ]
              }
            }
          }
        },
        {
          "if": {
            "properties": {
              "algorithm": {
                "const": "Kmv"
              }
            }
          },
          "then": {
            "properties": {
              "params": {
                "required": [
                  "Kmv"
                ]
              }
            }
          }
        },
        {
          "if": {
            "properties": {
              "algorithm": {
                "const": "Theta"
              }
            }
          },
          "then": {
            "properties": {
              "params": {
                "required": [
                  "Theta"
                ]
              }
            }
          }
        },
        {
          "if": {
            "properties": {
              "algorithm": {
                "const": "CountSketch"
              }
            }
          },
          "then": {
            "properties": {
              "params": {
                "required": [
                  "CountSketch"
                ]
              }
            }
          }
        },
        {
          "if": {
            "properties": {
              "algorithm": {
                "const": "CountSketchWithHeap"
              }
            }
          },
          "then": {
            "properties": {
              "params": {
                "required": [
                  "CountSketchWithHeap"
                ]
              }
            }
          }
        }
      ]
    }
  }
}