Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
@ChenglongMa
ChenglongMa committed Jan 16, 2025
1 parent df9daa6 commit ea7ea88
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -257,19 +257,19 @@ Detailed usage:
| -h | --help | Show this help message and exit. |
| -i | --images | Image filename(s) or URLs to process. <br>Supports multiple values separated by **space**, e.g., `a.jpg b.png`. <br>Supports directory or file name(s), e.g., `./path/to/images/ a.jpg`. <br>Supports URL(s), e.g., `https://example.com/images/pic.jpg` since v1.1.0+. <br>If you don't specify this option, the app will search all images in the current directory by default. |
| -r | --recursive | Whether to search images **recursively** in the specified directory. |
| -t | --image_type | Specify whether the input image(s) is/are **colored** or **black/white**. Valid choices are: `auto`, `color`, or `bw`. Defaults to `auto`, which will be detected **automatically**. |
| -p | --palette | Skin tone palette. <br>Valid choices can be `perla`, `yadon-ostfeld`, `proder`; <br>Or you can input RGB **hex** values starting with `#` or **RGB** values separated by **commas**, <br>e.g., `-p #373028 #422811` or `-p 255,255,255 100,100,100`. |
| -l | --labels | Skin tone labels. <br>Default values are the **UPPERCASE** alphabet list leading by the image type (`C` for `color`; `B` for `Black&White`), <br>e.g., `['CA', 'CB', ..., 'CZ']` or `['BA', 'BB', ..., 'BZ']`. |
| -t | --image_type | Specify whether the input image(s) is/are **colored** or **black/white**. <br>Valid choices are: `auto`, `color`, or `bw`. <br>Defaults to `auto`, which will be detected **automatically**. |
| -p | --palette | Skin tone palette. <br>Valid choices can be `perla`, `yadon-ostfeld`, `proder`; <br>You can also input RGB **hex** values starting with `#` <br>or **RGB** values separated by **commas**, <br>e.g., `-p #373028 #422811` or `-p 255,255,255 100,100,100`. |
| -l | --labels | Skin tone labels. <br>Default values are the **UPPERCASE** alphabet list leading by the image type <br>(`C` for `color`; `B` for `Black&White`), <br>e.g., `['CA', 'CB', ..., 'CZ']` or `['BA', 'BB', ..., 'BZ']`. |
| -d | --debug | Whether to generate report images, used for debugging and verification. <br>The report images will be saved in the `./debug` directory. |
| -bw | --black_white | Whether to convert the input to **black/white** image(s). <br>If `true`, the app will use a **black/white palette** to classify the image. |
| -o | --output | The path of the output file, defaults to **the current directory**. |
| | --n_workers | The number of workers to process the images, defaults to **the number of CPUs** in the system. |
| | --n_workers | The number of workers to process the images, <br>defaults to **the number of CPUs** in the system. |
| | --n_colors | CONFIG: the number of dominant colors to be extracted, defaults to 2. |
| | --new_width | CONFIG: resize the images with the specified width. **Negative value will be ignored**, defaults to 250. |
| | --new_width | CONFIG: resize the images with the specified width. <br>**Negative value will be ignored**, defaults to 250. |
| | --scale | CONFIG: how much the image size is reduced at each image scale, defaults to 1.1. |
| | --min_nbrs | CONFIG: how many neighbors each candidate rectangle should have to retain it. <br>**Higher value results in fewer detections but with higher quality**, defaults to 5. |
| | --min_size | CONFIG: minimum possible face size. **Faces smaller than that are ignored**. <br>Valid format: `width height`, defaults to `90 90`. |
| | --threshold | CONFIG: what percentage of the skin area is required to identify the face, defaults to 0.15. |
| | --threshold | CONFIG: what percentage of the skin area is required to identify the face, <br>defaults to 0.15. |
| -v | --version | Show the version number and exit. |

### Use Cases
Expand Down

0 comments on commit ea7ea88

Please sign in to comment.