Skin-tone-classifier

<details markdown="1" open>
<summary><i>Click here to show more.</i></summary>

In this version, we have made the following changes:

1. ✨ **NEW!**: We have added two new built-in skin tone palettes for the black/white images.
* The all available colored palettes are `perla`, `yadon-ostfeld`, `proder`.
* You can use the `-p` option to specify the palette for the processed images.
- For example, `stone -i ./path/to/images/ -p yadon-ostfeld`.
* The default palette `perla` is used for color images, and the `bw` palette is used for black/white
images.
2. ✨ **NEW!**: We have added some new use cases like Web API based projects in the documentation.

</details>

<details markdown="1">
<summary><i>Click here to show more.</i></summary>

In this version, we have made the following changes:

1. 🐛 **FIX!**: We fixed a bug where the app will crash when using the `-bw` option.

Thanks [ergo70](https://github.com/ergo70)'s feedback in [issue#25](https://github.com/ChenglongMa/SkinToneClassifier/issues/25).

</details>

<details markdown="1">
<summary><i>Click here to show more.</i></summary>

In this version, we have made the following changes:

1. 🧬 **CHANGE!**: We change the GUI mode to **optional**.
* Now, you can install the GUI mode by running:
* bash
pip install skin-tone-classifier[all] --upgrade

* It will support both the **CLI** mode and the **GUI** mode.
* If you don't specify the `[all]` option, the app will install the CLI mode only.
2. 🧬 **CHANGE!**: [For developer]. We base the project to `project.toml` instead of `setup.py`.


</details>

<details markdown="1">
<summary><i>Click here to show more.</i></summary>

In this version, we have made the following changes:

1. ✨ **NEW!**: We add a GUI version of `stone` for users who are not familiar with the command line interface.
* You can use the config GUI of `stone` to process the images.
* See more information at [here](use-stone-in-a-gui).
2. ✨ **NEW!**: We add new **patterns** in the `-l` (or `--labels`) option to set the skin tone labels.
* Now, you can use the following patterns to set the skin tone labels:
* **Default value**: the uppercase alphabet list leading by the image type (`C` for `color`; `B`
for `Black&White`).
* Specify the labels directly using _a space_ as delimiters, e.g., `-l A B C D E` or `-l 1 2 3 4 5`.
* Specify the range of labels using _a hyphen_ as delimiters, e.g.,
* `-l A-E` (equivalent to `-l A B C D E`);
* `-l A-E-2` (equivalent to `-l A C E`);
* `-l 1-5` (equivalent to `-l 1 2 3 4 5`);
* `-l 1-10-3` (equivalent to `-l 1 4 7 10`);
* **NB**: The number of skin tone labels should be equal to the number of colors in the palette.

</details>

<details markdown="1">
<summary><i>Click here to show more.</i></summary>

In this version, we have made the following changes:

1. 🐛 **FIX!**: We fixed a bug where the app will crash when using the `-bw` option.
Error message: `cannot reshape array of size 62500 into shape (3)`.
2. 🐛 **FIX!**: We fixed a bug where the app may identify the image type as `color` when using the `-bw` option.

</details>

<details markdown="1">
<summary><i>Click here to show more.</i></summary>

In this version, we have made the following changes:

1. ✨ **NEW!**: We add the `-v` (or `--version`) option to show the version number.
2. ✨ **NEW!**: We add the `-r` (or `--recursive`) option to **enable** recursive search for images.
* For example, `stone -i ./path/to/images/ -r` will search all images in the `./path/to/images/` directory **and its
subdirectories**.
* `stone -i ./path/to/images/` will only search images in the `./path/to/images/` directory.
3. 🐛 **FIX!**: We fixed a bug where the app cannot correctly identify the current folder if `-i` option is not
specified.

</details>