Add zipped file hirarchy and the zipped files

.gitattributes

@@ -58,3 +58,4 @@ saved_model/**/* filter=lfs diff=lfs merge=lfs -text
 *.mp4 filter=lfs diff=lfs merge=lfs -text
 *.webm filter=lfs diff=lfs merge=lfs -text
 data.tar.gz filter=lfs diff=lfs merge=lfs -text
+*.tar.gz filter=lfs diff=lfs merge=lfs -text

.gitignore

@@ -1,2 +1 @@
-download_testing.py
-zipping.sh
+download_testing.py

README.md

@@ -21,44 +21,6 @@ task_categories:
 - image-segmentation
 task_ids: []
 ---
----
-license: mit
-dataset_info:
-  config_name: data
-  features:
-  - name: origin
-    dtype:
-      array3_d:
-        shape:
-        - 256
-        - 256
-        - 172
-        dtype: int16
-  - name: label
-    dtype: string
-  - name: forgery
-    dtype:
-      array3_d:
-        shape:
-        - 256
-        - 256
-        - 172
-        dtype: int16
-  - name: method
-    dtype: string
-  - name: bbox
-    sequence: int16
-    length: 6
-  splits:
-  - name: train
-    num_bytes: 10947635800
-    num_examples: 240
-  - name: validation
-    num_bytes: 2736908805
-    num_examples: 60
-  download_size: 4651559462
-  dataset_size: 13684544605
----
 
 # Dataset Card Creation Guide
 

data.tar.gz → data/ADMM-ADAM/config0/config0.tar.gz

@@ -1,3 +1,3 @@
 version https://git-lfs.github.com/spec/v1
-oid sha256:313ddddbb44d0946609a73c368eee0216919ba55c2229f5def9a754ae0c63a67
-size 4651559462
+oid sha256:36d06c63f748c8811f3b8886ddd4ed61dfde372a664e83f900b4260134f648df
+size 4638742678

data/ADMM-ADAM/config1/config1.tar.gz

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:9ea09b6453115aa8eac713b9e73a4b626e4287aee5b74f68fe5fced8e8ebdc8b
+size 4641919697

data/ADMM-ADAM/config2/config2.tar.gz

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:c1b56a97086094412d674463188b65e4b35f7d8a10daeccea2dd9e6ee140847f
+size 4648017518

data/ADMM-ADAM/config3/config3.tar.gz

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:33403bf96845f87101714722c3384b83459005b1105c7c602145b18eada9d2ea
+size 4646102280

data/ADMM-ADAM/config4/config4.tar.gz

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:fd4a1289fc196c9ee58c50eae46012ada498d4fabcf4219e6bb0eaa51c4ae906
+size 4651590554

data/Origin/Origin.tar.gz

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:42d03c4d3d2979140a7c20314ee524bd778d05a86aa21b7bf4c7e7b01be2ed6c
+size 4683062375

data/new_FastHyIn/config1/config1.tar.gz

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:b7aa64b4f56cb99e66398100ec1b9fa9f1426ad5ce21f22d627ad11a061356b7
+size 18768694062

data/new_FastHyIn/config2/config2.tar.gz

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:6537cc80c1ababc67f3cebbbd9eedf9d1be579d22a136df48ac1edbde80c616e
+size 18751654099

data/new_FastHyIn/config3/config3.tar.gz

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:da3d973f6600e06676dc04a9267bf7b2267a87231549f670c86a409814dc0f71
+size 18773148209

data/new_FastHyIn/config4/config4.tar.gz

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:bcb6ac9182b047bbb804be3d61a924668556e986838605517b2c73e651fd99b7
+size 18763396934

developer_README.md

@@ -0,0 +1,79 @@
+# HyperForensics++ Dataset Contribution Guide
+
+This guide outlines the steps to contribute to the HyperForensics++ dataset repository.
+
+---
+
+## 1. Clone the Repository
+First, clone the repository from Hugging Face to your local machine:
+```bash
+# Make sure git-lfs is installed (https://git-lfs.com)
+git lfs install
+git clone https://huggingface.co/datasets/OtoroLin/HyperForensics-plus-plus
+```
+## 2. Extract the Dataset
+Unzip the data.tar.gz file into a separate local directory:
+```bash
+[to be filled]
+```
+## 3. Modify or Generate Data
+Make changes or generate new data in the extracted directory. Ensure the data follows the required structure:
+```
+local_data/
+    |-{attacking method}/
+    |   |-config0/
+    |   |   |-images.npy
+    |   |-config1/
+    |   | ...
+    |   |-config4/
+    |-{attacking method}/
+    |   |-config{0-4}/
+    |-Origin
+    |   |-images.npy
+HyperForensics-plus-plus/
+    |-data/
+```
+## 4. Zip the Directory
+After modifying or generating data, zip the directory into a `.tar.gz` file and place it in the repository.
+
+You can utilize the provided `zipping.sh` script. First, modify the `ROOT_DIR` variable to the `local_data` path
+```bash
+# In zipping.sh
+# Defined the root directory of the whole dataset
+ROOT_DIR="/root/to/local_data"
+```
+### 4.1 Compressing specify the method and configuration:
+```bash
+./zipping.sh --method <method name> --config <config name>
+```
+Replace <method name> with the forgery method and <config name> with the configuration index. This will automatically put the compressed `.tar.gz` file under hirarchy of the dataset repo.
+For instance, if I want to zip the images under `ADMM-ADAM` forgery method, `config0` configuration:
+```bash
+./zipping.sh --method ADMM-ADAM --config 0
+```
+This will compress `/path/to/local/ADMM-ADAM/config0/*` to `HyperForensics-plus-plus/data/ADMM-ADAM/config0/config0.tar.gz`.
+### 4.2 Compressing the specify direcotry
+```bash
+./zipping.sh --dir-path <path/to/directory>
+```
+Replace `<path/to/directory>` with the intended directory path. This will compress the directory and put it in the working directory.
+For instance,
+```bash
+./zipping.sh --dir-path /path/to/local/ADMM-ADAM/config0
+```
+This will compress `/path/to/local/ADMM-ADAM/config0/*` to `HyperForensics-plus-plus/config0.tar.gz`.
+### 4.3 Compress the entire hirarchy
+```bash
+./zipping.sh --all
+```
+This will compress the entire local data hirarchy seperately and automatically put the compressed files under hirarchy of the dataset repo.
+## 5. Create a Pull Request
+Push your changes to create a pull request. Hugging Face uses `git push` to implement pull requests:
+```bash
+git push origin pr/<pr index>:refs/pr/<pr index>
+```
+Replace `<pr index>` with the pull request index.
+## 6. Wait for merging the Pull Request
+Once the pull request is created, the repository maintainer will review and merge it.
+---
+Thank you for contributing to the HyperForensics++ dataset!

zipping.sh

@@ -0,0 +1,117 @@
+#!/bin/bash
+
+# Defined the root directory of the whole dataset
+ROOT_DIR="/ssd2/TzuYu/data"
+
+# Function to display usage
+usage() {
+    echo "Usage: $0 [--method METHOD --config CONFIG] | [--dir-path DIR_PATH]"
+    exit 1
+}
+# Function to zip a single directory
+zip_config() {
+    local method=$1
+    local config=$2
+    local dir_path="$ROOT_DIR/$method/$config"
+    local output_path="./data/$method/$config/$config.tar.gz"
+
+    # Ensure the output directory exists
+    mkdir -p "$(dirname "$output_path")"
+
+    # Create the tar.gz file
+    echo "Zipping $dir_path to $output_path"
+    tar -czvf "$output_path" "$dir_path"/*
+    if [[ $? -ne 0 ]]; then
+        echo "Error: Failed to create tar.gz for $dir_path"
+        exit 1
+    fi
+}
+
+# Parse arguments
+while [[ "$#" -gt 0 ]]; do
+    case $1 in
+        --help) usage ;;
+        --h) usage ;;
+        --all) ALL="true" ;;
+        --method) METHOD="$2"; shift ;;
+        --config) CONFIG="$2"; shift ;;
+        --dir-path) DIR_PATH="$2"; shift ;;
+        *) echo "Unknown parameter: $1"; usage ;;
+    esac
+    shift
+done
+
+# zipping all folders
+if [[ "$ALL" == "true" ]]; then
+    # Iterate through all methods and configs
+    for method_dir in "$ROOT_DIR"/*; do
+        if [[ -d "$method_dir" && "$(basename "$method_dir")" != "Origin" ]]; then
+            method=$(basename "$method_dir")
+            for config_dir in "$method_dir"/config*; do
+                if [[ -d "$config_dir" ]]; then
+                    config=$(basename "$config_dir")
+                    zip_config "$method" "$config"
+                fi
+            done
+        fi
+    done
+
+    if [ ! -e "./data/Origin/Origin.tar.gz" ]; then
+        # Ensure the output directory exists
+        mkdir -p "./data/Origin"
+
+        # Create the tar.gz file
+        echo "Zipping $ROOT_DIR/Origin to ./data/Origin/Origin.tar.gz"
+        tar -czvf "./data/Origin/Origin.tar.gz" "$ROOT_DIR"/Origin/*
+        if [[ $? -ne 0 ]]; then
+            echo "Error: Failed to create tar.gz for $ROOT_DIR/Origin"
+            exit 1
+        fi
+    fi
+    echo "All configurations have been zipped successfully."
+    exit 0
+fi
+
+SPECIFIED="false"
+
+# Validate arguments
+if [[ -n "$METHOD" && -n "$CONFIG" ]]; then
+    DIR_PATH="$ROOT_DIR/$METHOD/config$CONFIG"
+    SPECIFIED="true"
+elif [[ -z "$DIR_PATH" ]]; then
+    echo "Error: Either --method and --config or --dir-path must be specified."
+    usage
+fi
+
+# Check if the directory exists
+if [[ ! -d "$DIR_PATH" ]]; then
+    echo "Error: Directory $DIR_PATH does not exist."
+    exit 1
+fi
+
+# Extract method and config index from the directory path
+METHOD=$(basename "$(dirname "$DIR_PATH")")
+CONFIG=$(basename "$DIR_PATH")
+
+# Define the output tar file name
+# If directory path specified, saved to the data hirarchy
+# Otherwise, saved to the repo root directory
+if [[ "$SPECIFIED" == "false" ]]; then
+    OUTPUT_TAR="./$CONFIG.tar.gz"
+else
+    OUTPUT_TAR="./data/$METHOD/$CONFIG/$CONFIG.tar.gz"
+fi
+
+# Ensure the output directory exists
+mkdir -p "$(dirname "$OUTPUT_TAR")"
+
+# Create the tar.gz file
+echo "Zipping directory: $DIR_PATH"
+tar -czvf "$OUTPUT_TAR" "$DIR_PATH"/*
+if [[ $? -ne 0 ]]; then
+    echo "Error: Failed to create tar.gz file."
+    exit 1
+fi
+
+# Confirm completion
+echo "Directory zipped successfully to: $OUTPUT_TAR"