janvanlooy philippemo commited on
Commit
65affe5
1 Parent(s): 70f07a0

Update README.md (#1)

Browse files

- Update README.md (af2b30031f03bf0823a82bdf8278e27625322525)


Co-authored-by: Philippe Moussalli <philippemo@users.noreply.huggingface.co>

Files changed (1) hide show
  1. README.md +8 -4
README.md CHANGED
@@ -89,7 +89,7 @@ fondant run pipeline --local
89
  If you want to download the full dataset, you will need to modify the component arguments in the `pipeline.py` file,
90
  specifically the following part:
91
 
92
- ```
93
  load_from_hf_hub = ComponentOp(
94
  component_dir="components/load_from_hf_hub",
95
  arguments={
@@ -106,10 +106,14 @@ To visually inspect the results quickly, you can use:
106
  fondant explore --base_path ./data
107
  ```
108
 
109
- To extract the images from the Parquet files we have added a simple Python script which extracts the image files and adds a csv with
110
- image data and file names, TODO XXXXXXXXXXXXXXXXXXXXXXXXXXXXX
 
 
111
 
112
- To download the full dataset, TODO XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
 
 
113
 
114
  ### How to contribute
115
  If you want to contribute to the dataset, the best way is to help us develop pipeline components for further processing. Components
 
89
  If you want to download the full dataset, you will need to modify the component arguments in the `pipeline.py` file,
90
  specifically the following part:
91
 
92
+ ```python
93
  load_from_hf_hub = ComponentOp(
94
  component_dir="components/load_from_hf_hub",
95
  arguments={
 
106
  fondant explore --base_path ./data
107
  ```
108
 
109
+ You can also choose to download images to your local machine if you prefer, we have provided an [example script](https://huggingface.co/datasets/fondant-ai/fondant-cc-25m/blob/main/extract_images.py)
110
+ that enabled this:
111
+
112
+ To run the script, you can simply execute the following:
113
 
114
+ ```bash
115
+ python extract_images.py --parquet_file <Path to the Parquet file or folder containing the images> --save_folder <The folder where to save the images to>
116
+ ```
117
 
118
  ### How to contribute
119
  If you want to contribute to the dataset, the best way is to help us develop pipeline components for further processing. Components