CounterStrike-1K-sample / schema /sample_metadata.json
ArnieRamesh's picture
Upload CounterStrike-1K sample package
eb6bf10 verified
{
"schema_name": "sample_metadata_json",
"schema_version": 4,
"artifact_suffix": ".json",
"format": "json",
"row_grain": "one metadata sidecar per WebDataset sample",
"description": "Minimal public metadata needed to identify, align, mask, and filter one WebDataset sample. Detailed action/state/event field contracts live in schema/actions_bin.json, schema/state_bin.json, and schema/events.json.",
"privacy_boundary": {
"contains_steam_ids": false,
"contains_online_account_ids": false,
"raw_demo_files_redistributed": false,
"contains_player_names": false,
"player_reference": "pov_idx is stable only within a match_id and is not stable across matches"
},
"required_fields": [
"metadata_schema_version",
"actions_schema_version",
"state_schema_version",
"events_schema_version",
"postprocess_version",
"sample_key",
"match_id",
"round_idx",
"round_id",
"pov_idx",
"team_side",
"map_slug",
"resolution",
"video_width",
"video_height",
"clip_start_tick",
"clip_end_tick",
"round_start_tick",
"round_decision_tick",
"round_stop_tick",
"round_winner",
"round_end_reason",
"pov_round_result",
"frame0_tick",
"frame_tick_stride",
"frames",
"fps",
"duration_s",
"tick_rate",
"alive_start_tick",
"alive_end_tick",
"alive_start_frame",
"alive_end_frame",
"alive_frames",
"alive_duration_s",
"survival_fraction",
"has_full_round",
"ended_by",
"primary_weapon_id",
"weapon_ids_present"
],
"fields": [
{
"name": "metadata_schema_version",
"type": "int32",
"description": "Version of this metadata sidecar contract."
},
{
"name": "actions_schema_version",
"type": "int32",
"description": "Expected actions_bin schema version."
},
{
"name": "state_schema_version",
"type": "int32",
"description": "Expected state_bin schema version."
},
{
"name": "events_schema_version",
"type": "int32",
"description": "Expected sample events JSON schema version."
},
{
"name": "sample_key",
"type": "string",
"description": "Shared WebDataset member prefix: match_{match_id}__r{round_idx:03d}__p{pov_idx:02d}."
},
{
"name": "match_id",
"type": "string",
"description": "Release match-map id, normally a 12-character hash prefix."
},
{
"name": "round_idx",
"type": "int32",
"description": "Zero-indexed round number within match_id."
},
{
"name": "round_id",
"type": "string",
"description": "Stable join id for all POV samples belonging to the same round: match_{match_id}__r{round_idx:03d}."
},
{
"name": "pov_idx",
"type": "int32",
"description": "Anonymized player POV id, stable within match_id."
},
{
"name": "team_side",
"type": "enum<T,CT,empty>",
"description": "Player side at clip_start_tick."
},
{
"name": "map_slug",
"type": "enum<anubis,ancient,dust2,inferno,mirage,nuke,overpass,empty>",
"description": "Stable map enum. Human-readable display names live in schema/maps.json."
},
{
"name": "resolution",
"type": "enum<720p,360p,empty>",
"description": "Release media profile label. Exact dimensions are video_width/video_height."
},
{
"name": "video_width",
"type": "int32",
"description": "Decoded video width in pixels. Must match schema/media.json for resolution."
},
{
"name": "video_height",
"type": "int32",
"description": "Decoded video height in pixels. Must match schema/media.json for resolution."
},
{
"name": "clip_start_tick",
"type": "int64",
"description": "Inclusive sample start tick."
},
{
"name": "clip_end_tick",
"type": "int64",
"description": "Exclusive sample end tick."
},
{
"name": "round_start_tick",
"type": "int64",
"description": "Canonical round start tick, normally round_freeze_end."
},
{
"name": "round_decision_tick",
"type": "int64",
"description": "Tick at which the round outcome was decided, normally round_end."
},
{
"name": "round_stop_tick",
"type": "int64",
"description": "Round window stop tick after post-round buffer, normally round_officially_ended when available."
},
{
"name": "round_winner",
"type": "enum<T,CT,empty>",
"description": "Team that won the round, from round_end.winner."
},
{
"name": "round_end_reason",
"type": "string",
"description": "Sanitized round_end.reason value when available."
},
{
"name": "pov_round_result",
"type": "enum<win,loss,unknown,empty>",
"description": "Result of this POV's team in the round, derived from team_side and round_winner."
},
{
"name": "frame0_tick",
"type": "int64",
"description": "Demo tick aligned to decoded video frame 0."
},
{
"name": "frame_tick_stride",
"type": "int32",
"description": "Tick stride per video frame. Current release target is 2 for 64 Hz ticks at 32 FPS."
},
{
"name": "frames",
"type": "int32",
"description": "Decoded video frame count and expected actions.bin/state.bin record count."
},
{
"name": "fps",
"type": "float32",
"description": "Video frame rate. Current release target is 32."
},
{
"name": "duration_s",
"type": "float32",
"description": "Sample duration in seconds."
},
{
"name": "tick_rate",
"type": "int32",
"description": "Demo tick rate. Current release target is 64."
},
{
"name": "alive_start_tick",
"type": "int64",
"description": "First tick in the sample where this POV is considered alive."
},
{
"name": "alive_end_tick",
"type": "int64",
"description": "Exclusive alive boundary for this POV. For deaths, this is the death tick; for surviving POVs, this is clip_end_tick or round_stop_tick."
},
{
"name": "alive_start_frame",
"type": "int32",
"description": "First frame where player_alive is true."
},
{
"name": "alive_end_frame",
"type": "int32",
"description": "Exclusive end frame where player_alive is true."
},
{
"name": "alive_frames",
"type": "int32",
"description": "alive_end_frame - alive_start_frame."
},
{
"name": "alive_duration_s",
"type": "float32",
"description": "Alive tick window duration in seconds."
},
{
"name": "survival_fraction",
"type": "float32",
"description": "alive_frames / frames."
},
{
"name": "has_full_round",
"type": "bool",
"description": "Whether this POV sample reaches round_stop_tick."
},
{
"name": "ended_by",
"type": "enum<death,round_stop,clip_end,unknown,empty>",
"description": "Reason this POV sample ended. round_stop means the POV survived to the canonical round window stop."
},
{
"name": "media_truncated",
"type": "bool",
"description": "True when the corrected round/death-tail window extends beyond the rendered MP4 and v12 sidecars were clipped to the available media. Filter this out for strict full-round training."
},
{
"name": "intended_clip_end_tick",
"type": "int64|null",
"description": "Corrected exclusive clip end tick before clipping to rendered media. Present only when media_truncated is true."
},
{
"name": "primary_weapon_id",
"type": "int32",
"description": "Most frequent non-unknown active_weapon_id in the sample."
},
{
"name": "weapon_ids_present",
"type": "list<int32>",
"description": "Sorted unique non-unknown active_weapon_id values present in the sample."
},
{
"name": "postprocess_version",
"type": "string",
"description": "Post-processor version that produced this sidecar and paired binary artifacts. v12 splits controls into actions.bin and state into state.bin."
},
{
"name": "death_tick",
"type": "int64|null",
"description": "POV death tick when ended_by is death; absent/null for surviving POVs."
},
{
"name": "death_frame",
"type": "int32|null",
"description": "Video frame aligned to death_tick when death_tick is inside the sample frame window."
},
{
"name": "round_number_in_match",
"type": "int32",
"description": "One-indexed round number within match_id."
},
{
"name": "half_idx",
"type": "int32",
"description": "0 for first half, 1 for second half, and higher values for overtime blocks."
},
{
"name": "is_first_round",
"type": "bool",
"description": "True for round_idx == 0."
},
{
"name": "is_pistol_round",
"type": "bool",
"description": "True for regulation pistol rounds and overtime pistol-reset rounds."
},
{
"name": "t_score_start",
"type": "int32",
"description": "T-side score at the start of the sample/round."
},
{
"name": "ct_score_start",
"type": "int32",
"description": "CT-side score at the start of the sample/round."
},
{
"name": "score_diff_start",
"type": "int32",
"description": "t_score_start - ct_score_start."
},
{
"name": "primary_weapon_category",
"type": "string",
"description": "Most frequent coarse active weapon category in the sample."
},
{
"name": "weapon_categories_present",
"type": "list<string>",
"description": "Sorted unique coarse weapon categories present in the sample."
},
{
"name": "start_weapon_id",
"type": "int32",
"description": "active_weapon_id on the first frame."
},
{
"name": "start_weapon_category",
"type": "string",
"description": "Coarse active weapon category on the first frame."
},
{
"name": "start_health",
"type": "int32",
"description": "Health on the first frame."
},
{
"name": "start_armor",
"type": "int32",
"description": "Armor value on the first frame."
},
{
"name": "start_has_helmet",
"type": "bool",
"description": "Whether the POV has helmet armor on the first frame."
},
{
"name": "start_has_defuser",
"type": "bool",
"description": "Whether the POV has a defuse kit on the first frame."
},
{
"name": "start_balance",
"type": "int32",
"description": "Player money on the first frame when available."
},
{
"name": "start_has_bomb",
"type": "bool",
"description": "Whether the POV is carrying C4 on the first frame."
},
{
"name": "has_awp",
"type": "bool",
"description": "True if the AWP appears as active_weapon_id at any frame in the sample."
},
{
"name": "has_sniper",
"type": "bool",
"description": "True if any sniper-category weapon appears in the sample."
},
{
"name": "has_rifle",
"type": "bool",
"description": "True if any rifle-category weapon appears in the sample."
},
{
"name": "contains_bomb_plant",
"type": "bool",
"description": "True if the sample event sidecar contains a bomb_planted event."
},
{
"name": "contains_bomb_defuse",
"type": "bool",
"description": "True if the sample event sidecar contains a bomb_defused event."
},
{
"name": "contains_bomb_explosion",
"type": "bool",
"description": "True if the sample event sidecar contains a bomb_exploded event."
},
{
"name": "contains_player_death",
"type": "bool",
"description": "True if the sample event sidecar contains at least one player_death event."
},
{
"name": "sample_kills_total",
"type": "int32",
"description": "Number of player_death events in this sample."
},
{
"name": "sample_headshots_total",
"type": "int32",
"description": "Number of headshot player_death events in this sample."
},
{
"name": "pov_kills",
"type": "int32",
"description": "Kills credited to this POV within the sample event window."
},
{
"name": "pov_deaths",
"type": "int32",
"description": "Deaths of this POV within the sample event window."
},
{
"name": "pov_assists",
"type": "int32",
"description": "Assists credited to this POV within the sample event window."
},
{
"name": "pov_blinds_caused",
"type": "int32",
"description": "Blind events caused by this POV within the sample event window."
},
{
"name": "pov_blinded",
"type": "int32",
"description": "Blind events affecting this POV within the sample event window."
}
],
"validation": [
"metadata_schema_version == 4",
"actions_schema_version == 9",
"state_schema_version == 1",
"events_schema_version == 3",
"sample_key matches match_{match_id}__r{round_idx:03d}__p{pov_idx:02d}",
"round_id matches match_{match_id}__r{round_idx:03d}",
"resolution is 720p or 360p for final release shards",
"video_width/video_height match schema/media.json for resolution",
"clip_start_tick < clip_end_tick",
"round_start_tick <= round_decision_tick <= round_stop_tick",
"frame0_tick == clip_start_tick for the v1 release",
"frame_tick_stride == 2 for final release shards",
"frames > 0",
"duration_s > 0",
"fps == 32 for final release shards",
"tick_rate == 64 for final release shards",
"clip_start_tick <= alive_start_tick <= alive_end_tick <= clip_end_tick",
"media_truncated == false implies intended_clip_end_tick is absent/null",
"media_truncated == true implies clip_end_tick < intended_clip_end_tick",
"0 <= alive_start_frame <= alive_end_frame <= frames",
"alive_frames == alive_end_frame - alive_start_frame",
"has_full_round == (clip_end_tick >= round_stop_tick)",
"pov_round_result is win/loss when team_side and round_winner are known",
"ended_by is one of death, round_stop, clip_end, unknown, or empty",
"no top-level field is named clip_id, start_tick, end_tick, map, player_id, player_name, actions_bin, state_bin, or events_json",
"no serialized field value contains steamid, xuid, accountid, profile URL, hltv_match_id, raw demo path, raw demo URL, event name, or team names"
]
}