فهرست منبع

Add data description separately

sfmig 1 سال پیش
والد
کامیت
ff3f2b8ee8
2فایلهای تغییر یافته به همراه55 افزوده شده و 53 حذف شده
  1. 2 53
      README.md
  2. 53 0
      test_data/DATA_DESCRIPTION.md

+ 2 - 53
README.md

@@ -2,6 +2,8 @@
 
 Test data for the ethology Python package.
 
+For a description of the available test data, please see the [DATA_DESCRIPTION.md](test_data/DATA_DESCRIPTION.md) file.
+
 ## Adding or editing data
 
 ### Folder structure
@@ -40,56 +42,3 @@ gin upload <path-to-edited-or-updated-file> file-registry.txt
 For more details on how to work with GIN data repositories, please see the [GIN HowTo guide](https://howto.neuroinformatics.dev/open_science/GIN-repositories.html).
 
 
-## Available data
-
-The test data is organised under subdirectories that match the tested modules in the `ethology` package.
-
-### Test data for `ethology.annotations`
-
-#### `medium_bboxes_dataset_VIA`
-A medium size bounding boxess dataset in VIA format.
-
-| File name | Type | Format | N annotations | N images | Comments |
-| --- | --- | --- | --- | --- | --- |
-| `VIA_JSON_sample_1.json` | bboxes | VIA | 4440 | 50 | Category ID is a string ("crab"). |
-| `VIA_JSON_sample_2.json` | bboxes | VIA | 3977 | 50 | Category ID is a string ("crab").|
-
-
-#### `medium_bboxes_dataset_COCO`
-A medium size bounding boxess dataset in COCO format.
-
-| File name | Type | Format | N annotations | N images | Comments |
-| --- | --- | --- | --- | --- | --- |
-| `COCO_JSON_sample_1.json` | bboxes | COCO | 4344 | 100 | Category ID is a number (1). |
-| `COCO_JSON_sample_2.json` | bboxes | COCO | 4618 | 100 | Category ID is a number (1).|
-
-
-#### `small_bboxes_dataset`
-A small size bounding boxess dataset in VIA, COCO and VIA-CSV formats.
-
-| File name | Type | Format | N annotations | N images | Comments |
-| --- | --- | --- | --- | --- | --- |
-| `via_project_30Jan2025_15h15m.json` | bboxes | VIA | 3 | 3 | One bounding box per frame. |
-| `via_project_30Jan2025_15h15m_coco.json` | bboxes | COCO | 3 | 3 | One bounding box per frame. |
-| `via_project_30Jan2025_15h15m_csv.json` | bboxes | VIA-CSV | 3 | 3 |  One bounding box per frame. |
-
-
-#### `small_bboxes_dataset_duplicates`
-A small size bounding boxess dataset in VIA, COCO and VIA-CSV formats with duplicate annotations.
-
-| File name | Type | Format | N annotations | N images | Comments |
-| --- | --- | --- | --- | --- | --- |
-| `via_project_30Jan2025_15h15m.json` | bboxes | VIA | 4 | 3 | Duplicate annotation in frame 0, one annotation per frame in the rest of frames. |
-| `via_project_30Jan2025_15h15m_coco.json` | bboxes | COCO | 4 | 3 |  Duplicate annotation in frame 0, one annotation per frame in the rest of frames.|
-| `via_project_30Jan2025_15h15m_csv.json` | bboxes | VIA-CSV | 4 | 3 | Duplicate annotation in frame 0, one annotation per frame in the rest of frames. |
-
-
-#### `small_bboxes_dataset_no_categories`
-A small size bounding boxess dataset in VIA, COCO and VIA-CSV formats without categories.
-
-| File name | Type | Format | N annotations | N images | Comments |
-| --- | --- | --- | --- | --- | --- |
-| `via_project_30Jan2025_15h15m.json` | bboxes | VIA | 3 | 3 | No categories or supercategories are specified. This data is still supported |
-| `via_project_30Jan2025_15h15m_coco.json` | bboxes | COCO | 3 | 3 |  No categories are specified, so no annotations are exported in COCO format. This data will throw an error. |
-| `via_project_30Jan2025_15h15m_csv.json` | bboxes | VIA-CSV | 3 | 3 | No categories are specified. |
-

+ 53 - 0
test_data/DATA_DESCRIPTION.md

@@ -0,0 +1,53 @@
+## Available data
+
+The test data is organised under subdirectories that match the tested modules in the `ethology` package.
+
+### Test data for `ethology.annotations`
+
+#### `medium_bboxes_dataset_VIA`
+A medium size bounding boxess dataset in VIA format.
+
+| File name | Type | Format | N annotations | N images | Comments |
+| --- | --- | --- | --- | --- | --- |
+| `VIA_JSON_sample_1.json` | bboxes | VIA | 4440 | 50 | Category ID is a string ("crab"). |
+| `VIA_JSON_sample_2.json` | bboxes | VIA | 3977 | 50 | Category ID is a string ("crab").|
+
+
+#### `medium_bboxes_dataset_COCO`
+A medium size bounding boxess dataset in COCO format.
+
+| File name | Type | Format | N annotations | N images | Comments |
+| --- | --- | --- | --- | --- | --- |
+| `COCO_JSON_sample_1.json` | bboxes | COCO | 4344 | 100 | Category ID is a number (1). |
+| `COCO_JSON_sample_2.json` | bboxes | COCO | 4618 | 100 | Category ID is a number (1).|
+
+
+#### `small_bboxes_dataset`
+A small size bounding boxess dataset in VIA, COCO and VIA-CSV formats.
+
+| File name | Type | Format | N annotations | N images | Comments |
+| --- | --- | --- | --- | --- | --- |
+| `via_project_30Jan2025_15h15m.json` | bboxes | VIA | 3 | 3 | One bounding box per frame. |
+| `via_project_30Jan2025_15h15m_coco.json` | bboxes | COCO | 3 | 3 | One bounding box per frame. |
+| `via_project_30Jan2025_15h15m_csv.json` | bboxes | VIA-CSV | 3 | 3 |  One bounding box per frame. |
+
+
+#### `small_bboxes_dataset_duplicates`
+A small size bounding boxess dataset in VIA, COCO and VIA-CSV formats with duplicate annotations.
+
+| File name | Type | Format | N annotations | N images | Comments |
+| --- | --- | --- | --- | --- | --- |
+| `via_project_30Jan2025_15h15m.json` | bboxes | VIA | 4 | 3 | Duplicate annotation in frame 0, one annotation per frame in the rest of frames. |
+| `via_project_30Jan2025_15h15m_coco.json` | bboxes | COCO | 4 | 3 |  Duplicate annotation in frame 0, one annotation per frame in the rest of frames.|
+| `via_project_30Jan2025_15h15m_csv.json` | bboxes | VIA-CSV | 4 | 3 | Duplicate annotation in frame 0, one annotation per frame in the rest of frames. |
+
+
+#### `small_bboxes_dataset_no_categories`
+A small size bounding boxess dataset in VIA, COCO and VIA-CSV formats without categories.
+
+| File name | Type | Format | N annotations | N images | Comments |
+| --- | --- | --- | --- | --- | --- |
+| `via_project_30Jan2025_15h15m.json` | bboxes | VIA | 3 | 3 | No categories or supercategories are specified. This data is still supported |
+| `via_project_30Jan2025_15h15m_coco.json` | bboxes | COCO | 3 | 3 |  No categories are specified, so no annotations are exported in COCO format. This data will throw an error. |
+| `via_project_30Jan2025_15h15m_csv.json` | bboxes | VIA-CSV | 3 | 3 | No categories are specified. |
+