Skip to content

Commit 094b436

Browse files
committed
remove a few redundant phrases
1 parent e0022ed commit 094b436

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

docs/source/project_structure.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -126,11 +126,13 @@ All filenames follow a key-value pair convention, similar to the [BIDS standard]
126126

127127
## Label format
128128

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.
130130
* 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.
131131

132132
:::{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.
134136
:::
135137

136138
### Frame labels (`framelabels.json`)
@@ -159,7 +161,7 @@ Here each `id` is the frame index in the session video (matching the `<frameID>`
159161

160162
### Clip labels (`cliplabels.json`)
161163

162-
* There *must* be one `cliplabels.json` per clip (in the `Train` split only).
164+
* There *must* be one `cliplabels.json` per clip.
163165
* The `images` array *must* contain an entry for every frame in the clip, in consecutive, monotonically increasing order (covering the entire clip duration).
164166
* Clip labels follow the same COCO keypoints format as frame labels, but with different conventions for image `id` and `file_name` values:
165167
* 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

Comments
 (0)