Update README.md

README.md

@@ -7,21 +7,61 @@ size_categories:
   - 1M<n<10M
 ---
 
-[![arXiv](https://img.shields.io/badge/arXiv-2503.09399-b31b1b?logo=arxiv)](https://arxiv.org/abs/2503.09399) [![Static Badge](https://img.shields.io/badge/GitHub-Repo-blue?logo=github)](https://github.com/tobna/ForAug)
+[![arXiv](https://img.shields.io/badge/arXiv-2503.09399-b31b1b?logo=arxiv)](https://arxiv.org/abs/2503.09399) [![Static Badge](https://img.shields.io/badge/Huggingface-Dataset-yellow?logo=huggingface)](https://huggingface.co/datasets/TNauen/ForNet)
 
-# ForAug/ForNet
+# ForAug
 
 ![ForAug](images/foraug.png)
 
-This is the ForNet dataset from the paper [ForAug: Recombining Foregrounds and Backgrounds to Improve Vision Transformer Training with Bias Mitigation](https://www.arxiv.org/abs/2503.09399).
+This is the public code repository for the paper [_ForAug: Recombining Foregrounds and Backgrounds to Improve Vision Transformer Training with Bias Mitigation_](https://www.arxiv.org/abs/2503.09399).
 
 ### Updates
 
-- [19.03.2025] We release the code to download and use [ForNet on GitHub](https://github.com/tobna/ForAug) :computer:
-- [19.03.2025] We release the patch files of ForNet on Huggingface :hugs:
-- [12.03.2025] We release the preprint of [ForAug on arXiv](https://www.arxiv.org/abs/2503.09399) :spiral_notepad:
+- [24.03.2025] We have [integrated ForNet into Huggingface Datasets](#with--huggingface-datasets) for easy and convenient use 🤗 💫
+- [19.03.2025] We release the code to download and use ForNet in this repo 💻
+- [19.03.2025] We release the patch files of [ForNet on Huggingface](https://huggingface.co/datasets/TNauen/ForNet) 🤗
+- [12.03.2025] We release the preprint of [ForAug on arXiv](https://www.arxiv.org/abs/2503.09399) 🗒️
 
-## Using ForAug/ForNet
+# Using ForAug/ForNet
+
+## With 🤗 Huggingface Datasets
+
+We have integrated ForNet into [🤗 huggingface datasets](https://huggingface.co/docs/datasets/index):
+
+```Python
+from datasets import load_dataset
+
+ds = load_dataset(
+    "TNauen/ForNet",
+    trust_remote_code=True,
+    split="train",
+)
+```
+
+⚠️ You must be authenticated and have access to the `ILSVRC/imagenet-1k` dataset on the hub, since it is used to apply the patches and get the foreground and background information.
+
+⚠️ Be prepared to wait while the files are downloaded and the patches are applied. This will only happen the first time you load the dataset. By default, well use as many CPU cores as available on the system. To limit the number of cores used set the `MAX_WORKERS` environment variable.
+
+You can pass additional parameters to control the recombination phase:
+
+- `background_combination`: Which backgrounds to combine with foregrounds. Options: `"orig", "same", "all"`.
+- `fg_scale_jitter`: How much should the size of the foreground be changed (random ratio). Example: `(0.1, 0.8)`.
+- `pruning_ratio`: For pruning backgrounds, with (foreground size/background size) $\geq$ <pruning_ratio>. Backgrounds from images that contain very large foreground objects are mostly computer generated and therefore relatively unnatural. Full dataset: `1.1`.
+- `fg_size_mode`: How to determine the size of the foreground, based on the foreground sizes of the foreground and background images. Options: `"range", "min", "max", "mean"`.
+- `fg_bates_n`: Bates parameter for the distribution of the object position in the foreground. Uniform Distribution: 1. The higher the value, the more likely the object is in the center. For fg_bates_n = 0, the object is always in the center.
+- `mask_smoothing_sigma`: Sigma for the Gaussian blur of the mask edge.
+- `rel_jut_out`: How much is the foreground allowed to stand/jut out of the background (and then cut off).
+- `orig_img_prob`: Probability to use the original image, instead of the fg-bg recombinations. Options: `0.0`-`1.0`, `"linear", "revlinear", "cos"`.
+
+For `orig_img_prob` schedules to work, you need to set `ds.epochs` to the total number of epochs you want to train.
+Before each epoch set `ds.epoch` to the current epoch ($0 \leq$ `ds.epoch` $<$ `ds.epochs`).
+
+To recreate out evaluation metrics, you may set:
+
+- `fg_in_nonant`: Integer from 0 to 8. This will scale down the foreground and put it into the corresponding nonant (part of a 3x3 grid) in the image.
+- `fg_size_fact`: The foreground object is (additionally) scaled by this factor.
+
+## Local Installation
 
 ### Preliminaries
 
@@ -51,7 +91,7 @@ To be able to download ForNet, you will need the ImageNet dataset in the usual f
 
 To download and prepare the already-segmented ForNet dataset at `<data_path>`, follow these steps:
 
-#### 1. Clone the git repository and install the requirements
+#### 1. Clone this repository and install the requirements
 
 ```
 git clone https://github.com/tobna/ForAug
@@ -75,6 +115,14 @@ python apply_patch.py -p <data_path> -in <in_path> -o <data_path>
 
 This will apply the diffs to ImageNet and store the results in the `<data_path>` folder. It will also delete the already-processes patch files (the ones downloaded in step 2). In order to keep the patch files, add the `--keep` flag.
 
+#### 4. Validate the ForNet files
+
+To validate that you have all required files, run
+
+```
+python validate.py -f <data_path>
+```
+
 #### Optional: Zip the files without compression
 
 When dealing with a large cluster and dataset files that have to be sent over the network (i.e. the dataset is on another server than the one used for processing) it's sometimes useful to not deal with many small files and have fewer large ones instead.
@@ -134,14 +182,10 @@ help(ForNet.__init__)
 }
 ```
 
-### Dataset Sources
-
-- **Repository:** [GitHub](https://github.com/tobna/ForAug)
-- **Paper:** [arXiv](https://www.arxiv.org/abs/2503.09399)
-- **Project Page:** coming soon
-
 ## ToDos
 
 - [x] release code to download and create ForNet
 - [x] release code to use ForNet for training and evaluation
-- [ ] integrate ForNet into Huggingface Datasets
+- [x] integrate ForNet into Huggingface Datasets
+- [ ] release code for the segmentation phase
+