YongchengYAO commited on
Commit
b580fa2
Β·
1 Parent(s): bf953a1

update: add doc

Browse files
Files changed (2) hide show
  1. README.md +3 -0
  2. doc/dataset_toothfairy2.md +47 -0
README.md CHANGED
@@ -84,6 +84,9 @@ size_categories:
84
 
85
  πŸ“ For SKM-TEA and ToothFairy2, you need to process the raw data and upload the preprocessed data to your private HF dataset repo. We will add instructions later.
86
 
 
 
 
87
  <br/>
88
 
89
  # Requirement
 
84
 
85
  πŸ“ For SKM-TEA and ToothFairy2, you need to process the raw data and upload the preprocessed data to your private HF dataset repo. We will add instructions later.
86
 
87
+ - Prepare SKM-TEA data: [tutorial](https://huggingface.co/datasets/YongchengYAO/MedVision/blob/main/doc/dataset_skm-tea.md)
88
+ - Prepare ToothFairy2 data: [tutorial](https://huggingface.co/datasets/YongchengYAO/MedVision/blob/main/doc/dataset_toothfairy2.md)
89
+
90
  <br/>
91
 
92
  # Requirement
doc/dataset_toothfairy2.md ADDED
@@ -0,0 +1,47 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # Preparing ToothFairy2 Data
2
+
3
+ **MedVision** is designed to download raw data from source and the annotations from our Huggingface dataset repo. For access to the raw data of the ToothFairy2 dataset, you need to register at https://ditto.ing.unimore.it/toothfairy2/.
4
+
5
+ This tutorial is about:
6
+
7
+ - What data to download from the source in order to use the annotations from MedVision?
8
+ - How to prepare data?
9
+
10
+ ## What data to download?
11
+
12
+ - Download and extract data from source
13
+
14
+ ```
15
+ # Files from ToothFairy2 source
16
+ β”œβ”€β”€ Dataset112_ToothFairy2
17
+ β”œβ”€β”€ imagesTr
18
+ β”œβ”€β”€ ToothFairy2F_001_0000.mha
19
+ β”œβ”€β”€ ...
20
+ β”œβ”€β”€ labelsTr
21
+ β”œβ”€β”€ ToothFairy2F_001.mha
22
+ β”œβ”€β”€ ...
23
+ ```
24
+
25
+ ## How to prepare data?
26
+
27
+ ⚠️ DO NOT change file or folder names. See why [here](https://huggingface.co/datasets/YongchengYAO/MedVision/blob/main/src/medvision_ds/datasets/ToothFairy2/download.py).
28
+
29
+ 1. Put these folders into `ToothFairy2` and upload the **compressed** file to your HF dataset repo
30
+
31
+ ```
32
+ # DO NOT use other folder names
33
+ β”œβ”€β”€ ToothFairy2
34
+ β”œβ”€β”€ imagesTr
35
+ β”œβ”€β”€ labelsTr
36
+ ```
37
+
38
+ Your HF repo should contain `ToothFairy2.zip`
39
+
40
+ 2. Set env var whenever you load ToothFairy2 data from MedVision
41
+
42
+ ```python
43
+ import os
44
+ os.environ["MedVision_ToothFairy2_HF_ID"] = <your-hf-dataset-id>
45
+ ```
46
+
47
+