updated huggingface readme

README.md

@@ -67,51 +67,36 @@ Please check [Dataset Structure](Datasets-Structure.md) for a more detailed stru
 
 # Downloading the dataset
 
-### *(Option 1)* Downloading the dataset **archive** from HuggingFace
+### Clone the repository
 
-- using a python script:
-
-```python
-import os
-import json
-import pandas as pd
-from huggingface_hub import hf_hub_download
-
-dataset_name = 'xami_dataset' # the dataset name of Huggingface
-images_dir = '.' # the output directory of the dataset images
+```bash
+git clone https://github.com/ESA-Datalabs/XAMI-dataset.git
+cd XAMI-dataset
+conda env create -f requirements.yaml # create an environment with the package requirements
+```
 
-hf_hub_download(
-    repo_id="iulia-elisa/XAMI-dataset", # the Huggingface repo ID
-    repo_type='dataset', 
-    filename=dataset_name+'.zip', 
-    local_dir=images_dir
-);
+Then
 
-# Unzip file
-!unzip -q "xami_dataset.zip" 
+### Download the dataset archive from HuggingFace
 
-# Read the train json annotations file
-annotations_path = os.path.join(images_dir, dataset_name, 'train/', '_annotations.coco.json')
+- using a python script (see [load_and_visualise_dataset.pynb](https://github.com/ESA-Datalabs/XAMI-dataset/blob/main/load_and_visualise_dataset.ipynb))
 
-with open(annotations_path) as f:
-    data_in = json.load(f)
+```python
+from xami_dataset import XAMIDataset
 
-data_in['images'][0]
+# Download the dataset
+xami_dataset = XAMIDataset(
+    repo_id="iulia-elisa/XAMI-dataset", 
+    dataset_name="xami_dataset", 
+    data_path='./dest_dir')
 ```
-or
 
-- using a CLI command:
+- using a CLI command
 ```bash
-huggingface-cli download iulia-elisa/XAMI-dataset xami_dataset.zip --repo-type dataset --local-dir '/path/to/local/dataset/dir'
-
-```
+DEST_DIR='/path/to/local/dataset/dir'
 
-### *(Option 2)* Cloning the repository for more visualization tools
+huggingface-cli download iulia-elisa/XAMI-dataset xami_dataset.zip --repo-type dataset --local-dir "$DEST_DIR" && unzip "$DEST_DIR/xami_dataset.zip" -d "$DEST_DIR" && rm "$DEST_DIR/xami_dataset.zip"
 
-```bash
-# Github
-git clone https://github.com/ESA-Datalabs/XAMI-dataset.git
-cd XAMI-dataset
 ```
 <!-- 
 # Dataset Split with SKF (Optional)