Datasets:
Correct the speeling in contributor_README.md
Browse files- contributor_README.md +8 -8
contributor_README.md
CHANGED
|
@@ -13,7 +13,7 @@ git clone https://huggingface.co/datasets/OtoroLin/HyperForensics-plus-plus
|
|
| 13 |
cd ./HyperForensics-plus-plus
|
| 14 |
```
|
| 15 |
## 2. Extract the Dataset
|
| 16 |
-
Decompress the `.tar.gz` files into a separate local
|
| 17 |
```bash
|
| 18 |
# In zipping.sh
|
| 19 |
# Defined the root directory of the whole dataset
|
|
@@ -29,17 +29,17 @@ conda install pigz
|
|
| 29 |
```bash
|
| 30 |
./unzipping.sh --method <method name> --config <config name>
|
| 31 |
```
|
| 32 |
-
Replace `<method name>` with the forgery method and `<config name>` with the configuration index. This will automatically decompressed `.tar.gz` file and put it under
|
| 33 |
For instance, if I want to decompress the images under `ADMM-ADAM` forgery method, `config0` configuration:
|
| 34 |
```bash
|
| 35 |
./unzipping.sh --method ADMM-ADAM --config 0
|
| 36 |
```
|
| 37 |
This will decompress `HyperForensics-plus-plus/data/ADMM-ADAM/config0/config0.tar.gz` to `/path/to/local/ADMM-ADAM/config0/*`.
|
| 38 |
-
### 2.2 Decompress the entire
|
| 39 |
```bash
|
| 40 |
./unzipping.sh --all
|
| 41 |
```
|
| 42 |
-
This will recursively decompress all `tar.gz` file in the `HyperForensics-plus-plus/data` and automatically put the decompressed files under
|
| 43 |
|
| 44 |
## 3. [Create a pull request](https://huggingface.co/docs/hub/repositories-pull-requests-discussions#pull-requests-advanced-usage)
|
| 45 |
The pull requests on Hugging Face do not use forks and branches, but instead custom “branches” called `refs` that are stored directly on the source repo.
|
|
@@ -96,7 +96,7 @@ conda install pigz
|
|
| 96 |
```bash
|
| 97 |
./zipping.sh --method <method name> --config <config name>
|
| 98 |
```
|
| 99 |
-
Replace <method name> with the forgery method and <config name> with the configuration index. This will automatically put the compressed `.tar.gz` file under
|
| 100 |
For instance, if I want to zip the images under `ADMM-ADAM` forgery method, `config0` configuration:
|
| 101 |
```bash
|
| 102 |
./zipping.sh --method ADMM-ADAM --config 0
|
|
@@ -112,12 +112,12 @@ For instance,
|
|
| 112 |
./zipping.sh --dir-path /path/to/local/ADMM-ADAM/config0
|
| 113 |
```
|
| 114 |
This will compress `/path/to/local/ADMM-ADAM/config0/*` to `HyperForensics-plus-plus/config0.tar.gz`.
|
| 115 |
-
### 5.3 Compress the entire
|
| 116 |
```bash
|
| 117 |
./zipping.sh --all
|
| 118 |
```
|
| 119 |
-
This will compress the entire local data
|
| 120 |
-
> **Note** that I did not imiplement the method/config-specified compressing for **Origin** since it seems unlikely people needs to compress/decompress it regularly. You can either do it manually or use the path-specified compressing method and put it in to
|
| 121 |
|
| 122 |
## 6. Create a Pull Request
|
| 123 |
Push your changes to created PR:
|
|
|
|
| 13 |
cd ./HyperForensics-plus-plus
|
| 14 |
```
|
| 15 |
## 2. Extract the Dataset
|
| 16 |
+
Decompress the `.tar.gz` files into a separate local hierarchy. You can utilize the provided `unzipping.sh` script. First, modify the `ROOT_DIR` variable to the `local_data` path
|
| 17 |
```bash
|
| 18 |
# In zipping.sh
|
| 19 |
# Defined the root directory of the whole dataset
|
|
|
|
| 29 |
```bash
|
| 30 |
./unzipping.sh --method <method name> --config <config name>
|
| 31 |
```
|
| 32 |
+
Replace `<method name>` with the forgery method and `<config name>` with the configuration index. This will automatically decompressed `.tar.gz` file and put it under hierarchy of the local dataset directory.
|
| 33 |
For instance, if I want to decompress the images under `ADMM-ADAM` forgery method, `config0` configuration:
|
| 34 |
```bash
|
| 35 |
./unzipping.sh --method ADMM-ADAM --config 0
|
| 36 |
```
|
| 37 |
This will decompress `HyperForensics-plus-plus/data/ADMM-ADAM/config0/config0.tar.gz` to `/path/to/local/ADMM-ADAM/config0/*`.
|
| 38 |
+
### 2.2 Decompress the entire hierarchy
|
| 39 |
```bash
|
| 40 |
./unzipping.sh --all
|
| 41 |
```
|
| 42 |
+
This will recursively decompress all `tar.gz` file in the `HyperForensics-plus-plus/data` and automatically put the decompressed files under hierarchy of the local dataset directory.
|
| 43 |
|
| 44 |
## 3. [Create a pull request](https://huggingface.co/docs/hub/repositories-pull-requests-discussions#pull-requests-advanced-usage)
|
| 45 |
The pull requests on Hugging Face do not use forks and branches, but instead custom “branches” called `refs` that are stored directly on the source repo.
|
|
|
|
| 96 |
```bash
|
| 97 |
./zipping.sh --method <method name> --config <config name>
|
| 98 |
```
|
| 99 |
+
Replace <method name> with the forgery method and <config name> with the configuration index. This will automatically put the compressed `.tar.gz` file under hierarchy of the dataset repo.
|
| 100 |
For instance, if I want to zip the images under `ADMM-ADAM` forgery method, `config0` configuration:
|
| 101 |
```bash
|
| 102 |
./zipping.sh --method ADMM-ADAM --config 0
|
|
|
|
| 112 |
./zipping.sh --dir-path /path/to/local/ADMM-ADAM/config0
|
| 113 |
```
|
| 114 |
This will compress `/path/to/local/ADMM-ADAM/config0/*` to `HyperForensics-plus-plus/config0.tar.gz`.
|
| 115 |
+
### 5.3 Compress the entire hierarchy
|
| 116 |
```bash
|
| 117 |
./zipping.sh --all
|
| 118 |
```
|
| 119 |
+
This will compress the entire local data hierarchy seperately and automatically put the compressed files under hierarchy of the dataset repo.
|
| 120 |
+
> **Note** that I did not imiplement the method/config-specified compressing for **Origin** since it seems unlikely people needs to compress/decompress it regularly. You can either do it manually or use the path-specified compressing method and put it in to hierarchy by hand.
|
| 121 |
|
| 122 |
## 6. Create a Pull Request
|
| 123 |
Push your changes to created PR:
|