You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/source/project_structure.md
+5-3Lines changed: 5 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -126,11 +126,13 @@ All filenames follow a key-value pair convention, similar to the [BIDS standard]
126
126
127
127
## Label format
128
128
129
-
* Labels (also referred to as annotations) are only included in the `Train` split, and **must** be stored as JSON files in the same folder as the corresponding frames or clips.
129
+
* Labels (also referred to as annotations) are only included in the `Train` split, and *must* be stored in the same folder as the corresponding frames or clips.
130
130
* Annotations *must* be stored in [COCO keypoints format](https://cocodataset.org/), with some additional requirements described below. Each label file is a JSON file with `images`, `annotations`, and `categories` arrays. Image, annotation and category `id` values *must* be unique integers within a label file.
131
131
132
132
:::{note}
133
-
Annotation and category `id` values *should* be 1-indexed. This convention follows sleap-io's [`save_coco`](https://io.sleap.ai/latest/reference/sleap_io/io/coco/) function and avoids conflicts with models that treat category `0` as background. Image `id` indexing differs between frame and clip labels — see below for details.
133
+
Annotation and category `id` values *should* be 1-indexed. This convention follows sleap-io's [`save_coco`](https://io.sleap.ai/latest/reference/sleap_io/io/coco/) function and avoids conflicts with models that treat category `0` as background.
134
+
135
+
Image `id` indexing differs between frame and clip labels — see below for details.
134
136
:::
135
137
136
138
### Frame labels (`framelabels.json`)
@@ -159,7 +161,7 @@ Here each `id` is the frame index in the session video (matching the `<frameID>`
159
161
160
162
### Clip labels (`cliplabels.json`)
161
163
162
-
* There *must* be one `cliplabels.json` per clip (in the `Train` split only).
164
+
* There *must* be one `cliplabels.json` per clip.
163
165
* The `images` array *must* contain an entry for every frame in the clip, in consecutive, monotonically increasing order (covering the entire clip duration).
164
166
* Clip labels follow the same COCO keypoints format as frame labels, but with different conventions for image `id` and `file_name` values:
165
167
* Each image `id`*must* be the **0-based index of the frame within the clip** (i.e. `0`, `1`, `2`, ...), not the index in the session video.
0 commit comments