JeffreyJsam commited on
Commit
c729fb6
·
verified ·
1 Parent(s): 455200e

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +10 -10
README.md CHANGED
@@ -32,7 +32,7 @@ The dataset contains over 63,917 annotated images with instance masks for varied
32
  Due to Hugging Face Hub's per-directory file limit (10,000 files), this dataset is chunked: each logical split (like `train/labels/`) is subdivided into folders (`000/`, `001/`, ...) containing no more than 5,000 files each.
33
 
34
  **Example Structure:**
35
- '''
36
  Baseline
37
  ├──train/
38
  ├──images/
@@ -42,11 +42,11 @@ Due to Hugging Face Hub's per-directory file limit (10,000 files), this dataset
42
  ├── 001/
43
  └── ...
44
 
45
- '''
46
  If you're using models/tools like **YOLO** or others that expect a **flat directory**, you may need to **merge these subfolders at load-time or during preprocessing**.
47
 
48
  **YOLO Example Structure:**
49
- '''
50
  Baseline
51
  ├──train/
52
  ├──images/
@@ -54,7 +54,7 @@ If you're using models/tools like **YOLO** or others that expect a **flat direct
54
  ├── imag_99.png
55
  └── ...
56
 
57
- '''
58
 
59
 
60
  ### Utility Scripts
@@ -65,13 +65,13 @@ The following scripts help you with the download of this dataset. Due to the lar
65
  #### 1. Setup
66
 
67
  Create your virtual environment to help manage dependencies and prevent conflicts:
68
- '''
69
  python -m venv env
70
 
71
  source env/bin/activate # On Windows: env\Scripts\activate
72
 
73
  pip install -r requirements.txt
74
- '''
75
 
76
  #### 2. Sample 500 items from a specific chunk:
77
 
@@ -88,7 +88,7 @@ Arguments:
88
  --count Number of samples to download
89
 
90
  Example Usage with all args:
91
- '''
92
  python3 sample_swim.py
93
 
94
  --repo-id JeffreyJsam/SWiM-SpacecraftWithMasks
@@ -100,7 +100,7 @@ Example Usage with all args:
100
  --output-dir ./Sampled-SWiM
101
 
102
  --count 500
103
- '''
104
  #### 3. Download the entire dataset (optionally flatten chunks for YOLO format):
105
 
106
  Streams and downloads the full paired dataset (images + label txt files) from a Hugging Face Hub repository. It recursively processes all available chunk subfolders (e.g., '000', '001', ...) under given parent paths.
@@ -128,7 +128,7 @@ Arguments:
128
  --chunks Specific chunk names (e.g., 000 001); omit to download all
129
 
130
  Example usage with all args:
131
- '''
132
  python3 download_swim.py
133
 
134
  --repo-id JeffreyJsam/SWiM-SpacecraftWithMasks
@@ -140,7 +140,7 @@ Example usage with all args:
140
  --output-dir ./SWiM
141
 
142
  --flatten
143
- '''
144
 
145
  **Arguments are all configurable—see `--help` for details.**
146
 
 
32
  Due to Hugging Face Hub's per-directory file limit (10,000 files), this dataset is chunked: each logical split (like `train/labels/`) is subdivided into folders (`000/`, `001/`, ...) containing no more than 5,000 files each.
33
 
34
  **Example Structure:**
35
+ ```
36
  Baseline
37
  ├──train/
38
  ├──images/
 
42
  ├── 001/
43
  └── ...
44
 
45
+ ```
46
  If you're using models/tools like **YOLO** or others that expect a **flat directory**, you may need to **merge these subfolders at load-time or during preprocessing**.
47
 
48
  **YOLO Example Structure:**
49
+ ```
50
  Baseline
51
  ├──train/
52
  ├──images/
 
54
  ├── imag_99.png
55
  └── ...
56
 
57
+ ```
58
 
59
 
60
  ### Utility Scripts
 
65
  #### 1. Setup
66
 
67
  Create your virtual environment to help manage dependencies and prevent conflicts:
68
+ ```
69
  python -m venv env
70
 
71
  source env/bin/activate # On Windows: env\Scripts\activate
72
 
73
  pip install -r requirements.txt
74
+ ```
75
 
76
  #### 2. Sample 500 items from a specific chunk:
77
 
 
88
  --count Number of samples to download
89
 
90
  Example Usage with all args:
91
+ ```
92
  python3 sample_swim.py
93
 
94
  --repo-id JeffreyJsam/SWiM-SpacecraftWithMasks
 
100
  --output-dir ./Sampled-SWiM
101
 
102
  --count 500
103
+ ```
104
  #### 3. Download the entire dataset (optionally flatten chunks for YOLO format):
105
 
106
  Streams and downloads the full paired dataset (images + label txt files) from a Hugging Face Hub repository. It recursively processes all available chunk subfolders (e.g., '000', '001', ...) under given parent paths.
 
128
  --chunks Specific chunk names (e.g., 000 001); omit to download all
129
 
130
  Example usage with all args:
131
+ ```
132
  python3 download_swim.py
133
 
134
  --repo-id JeffreyJsam/SWiM-SpacecraftWithMasks
 
140
  --output-dir ./SWiM
141
 
142
  --flatten
143
+ ```
144
 
145
  **Arguments are all configurable—see `--help` for details.**
146