YongchengYAO commited on
Commit
e971f50
Β·
1 Parent(s): 00b6d62

update doc

Browse files
Files changed (2) hide show
  1. README.md +5 -3
  2. doc/file-structure.md +1 -5
README.md CHANGED
@@ -47,6 +47,8 @@ size_categories:
47
 
48
  # Datasets
49
 
 
 
50
  πŸ“ The MedVision dataset consists of public medical images and
51
  quantitative annotations from this study. MRI: Magnetic Resonance Imaging;
52
  CT: Computed Tomography; PET: positron emission tomography; US: Ultrasound;
@@ -145,7 +147,7 @@ export MedVision_FORCE_INSTALL_CODE="False"
145
 
146
  The dataset codebase `medvision_ds` can be used to scale the dataset, including adding new annotation types and datasets.
147
 
148
- πŸ› οΈ **Install**
149
 
150
  ```bash
151
  pip install "git+https://huggingface.co/datasets/YongchengYAO/MedVision.git#subdirectory=src"
@@ -164,7 +166,7 @@ pip install huggingface_hub
164
  python -c "from medvision_bm.utils import install_medvision_ds; install_medvision_ds(data_dir='<local-data-folder>')"
165
  ```
166
 
167
- πŸ§‘πŸ»β€πŸ’» Use [utility functions](https://huggingface.co/datasets/YongchengYAO/MedVision/tree/main/src/medvision_ds/utils) for image processing
168
 
169
  ```python
170
  from medvision_ds.utils.data_conversion import (
@@ -181,7 +183,7 @@ from medvision_ds.utils.preprocess_utils import (
181
  )
182
  ```
183
 
184
- πŸ‘©πŸΌβ€πŸ’»Examples of dataset scaling:
185
 
186
  - Setup automatic data processing pipeline
187
 
 
47
 
48
  # Datasets
49
 
50
+ [File structure](https://huggingface.co/datasets/YongchengYAO/MedVision/blob/main/doc/file-structure.md): raw data will be automatically downloaded and processed, and our annotations are in each dataset folder
51
+
52
  πŸ“ The MedVision dataset consists of public medical images and
53
  quantitative annotations from this study. MRI: Magnetic Resonance Imaging;
54
  CT: Computed Tomography; PET: positron emission tomography; US: Ultrasound;
 
147
 
148
  The dataset codebase `medvision_ds` can be used to scale the dataset, including adding new annotation types and datasets.
149
 
150
+ ## πŸ› οΈ **Install**
151
 
152
  ```bash
153
  pip install "git+https://huggingface.co/datasets/YongchengYAO/MedVision.git#subdirectory=src"
 
166
  python -c "from medvision_bm.utils import install_medvision_ds; install_medvision_ds(data_dir='<local-data-folder>')"
167
  ```
168
 
169
+ ## πŸ§‘πŸ»β€πŸ’» Use [utility functions](https://huggingface.co/datasets/YongchengYAO/MedVision/tree/main/src/medvision_ds/utils) for image processing
170
 
171
  ```python
172
  from medvision_ds.utils.data_conversion import (
 
183
  )
184
  ```
185
 
186
+ ## πŸ‘©πŸΌβ€πŸ’»Examples of dataset scaling:
187
 
188
  - Setup automatic data processing pipeline
189
 
doc/file-structure.md CHANGED
@@ -2,14 +2,11 @@
2
 
3
  ```
4
  β”œβ”€β”€ Data # <== MedVision_DATA_DIR
5
- β”œβ”€β”€ .cache # <== huggingface, vllm cache
6
  β”œβ”€β”€ Datasets # <== preprocessed data
7
  β”œβ”€β”€ AbdomenAtlas1.0Mini
8
  β”œβ”€β”€ Images
9
- β”œβ”€β”€ tmp_prepared_png # <== PNG files (if save_processed_img_to_disk=true)
10
- β”œβ”€β”€ *.nii.gz # <== 3D medical images
11
  β”œβ”€β”€ Masks
12
- β”œβ”€β”€ benchmark_plan_*.json.gz # <== Our annotations
13
  β”œβ”€β”€ AbdomenCT-1K
14
  β”œβ”€β”€ Images
15
  β”œβ”€β”€ Masks
@@ -212,7 +209,6 @@
212
  β”œβ”€β”€ Masks
213
  β”œβ”€β”€ benchmark_plan_*.json.gz
214
  β”œβ”€β”€ src # <== source code for medvision_ds
215
- β”œβ”€β”€ tmp_* # <== tmp folder for combined/filtered/formatted datasets
216
  β”œβ”€β”€ .downloaded_datasets.json # <== dataset status tracker
217
  ```
218
 
 
2
 
3
  ```
4
  β”œβ”€β”€ Data # <== MedVision_DATA_DIR
 
5
  β”œβ”€β”€ Datasets # <== preprocessed data
6
  β”œβ”€β”€ AbdomenAtlas1.0Mini
7
  β”œβ”€β”€ Images
 
 
8
  β”œβ”€β”€ Masks
9
+ β”œβ”€β”€ benchmark_plan_*.json.gz # <== Our annotations
10
  β”œβ”€β”€ AbdomenCT-1K
11
  β”œβ”€β”€ Images
12
  β”œβ”€β”€ Masks
 
209
  β”œβ”€β”€ Masks
210
  β”œβ”€β”€ benchmark_plan_*.json.gz
211
  β”œβ”€β”€ src # <== source code for medvision_ds
 
212
  β”œβ”€β”€ .downloaded_datasets.json # <== dataset status tracker
213
  ```
214