YongchengYAO commited on
Commit
e37cd9e
·
verified ·
1 Parent(s): 706a57a

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +9 -6
README.md CHANGED
@@ -77,10 +77,9 @@ Data Split & Info
77
  - `subInfo_test`: list of testing data
78
  - `kneeSideInfo`: a file containing knee side information, used in CartiMorph Toolbox
79
 
80
- ## Intended Usage
81
-
82
- ### 1. Download Files from the `main` Branch
83
 
 
 
84
  ```bash
85
  #!/bin/bash
86
  pip install --upgrade huggingface-hub[cli]
@@ -91,9 +90,14 @@ huggingface-cli login --token $HF_TOKEN
91
  from huggingface_hub import snapshot_download
92
  snapshot_download(repo_id="YongchengYAO/OAIZIB-CM", repo_type='dataset', local_dir="/your/local/folder")
93
  ```
 
 
 
 
 
94
 
95
- ### 2. Load `Dataset` or `IterableDataset` from the `load_dataset-support` Branch
96
 
 
97
  ```python
98
  >>> from datasets import load_dataset
99
 
@@ -112,11 +116,10 @@ snapshot_download(repo_id="YongchengYAO/OAIZIB-CM", repo_type='dataset', local_d
112
  >>> type(iterdataset_train)
113
  <class 'datasets.iterable_dataset.IterableDataset'>
114
  ```
115
-
116
  - 🔥 [Differences between Dataset and IterableDataset](https://huggingface.co/docs/datasets/about_mapstyle_vs_iterable#downloading-and-streaming)
117
 
118
- ## Segmentation Labels
119
 
 
120
  ```python
121
  labels_map = {
122
  "1": "Femur",
 
77
  - `subInfo_test`: list of testing data
78
  - `kneeSideInfo`: a file containing knee side information, used in CartiMorph Toolbox
79
 
 
 
 
80
 
81
+ ## Intended Usage
82
+ ### 1. Download Files from the `main` or `load_dataset-support` Branch
83
  ```bash
84
  #!/bin/bash
85
  pip install --upgrade huggingface-hub[cli]
 
90
  from huggingface_hub import snapshot_download
91
  snapshot_download(repo_id="YongchengYAO/OAIZIB-CM", repo_type='dataset', local_dir="/your/local/folder")
92
  ```
93
+ ```python
94
+ # python
95
+ from huggingface_hub import snapshot_download
96
+ snapshot_download(repo_id="YongchengYAO/OAIZIB-CM", repo_type='dataset', revision="load_dataset-support", local_dir="/your/local/folder")
97
+ ```
98
 
 
99
 
100
+ ### 2. Load `Dataset` or `IterableDataset` from the `load_dataset-support` Branch
101
  ```python
102
  >>> from datasets import load_dataset
103
 
 
116
  >>> type(iterdataset_train)
117
  <class 'datasets.iterable_dataset.IterableDataset'>
118
  ```
 
119
  - 🔥 [Differences between Dataset and IterableDataset](https://huggingface.co/docs/datasets/about_mapstyle_vs_iterable#downloading-and-streaming)
120
 
 
121
 
122
+ ## Segmentation Labels
123
  ```python
124
  labels_map = {
125
  "1": "Femur",