ds-faceapi/README.md

A DroidScript FaceAPI plugin trainer

# ds-faceapi

A command-line interface (CLI) for training image datasets and generating JSON models that can be used with the face recognition plugin in DroidScript.  

---

## Installation

To install the CLI globally, run:

```bash
npm install -g ds-faceapi
```

## Usage

The `ds-faceapi` CLI provides a command to train images and generate face recognition models. Below is a detailed description of the `train` command.

### Train Command

Use the `train` command to process images from a source folder and create a model file:

```bash
ds-faceapi train [options]
```

#### Options

| Option                  | Description                                                                 |
|-------------------------|-----------------------------------------------------------------------------|
| `-s, --source <source>` | The source folder containing images to train the model. **Required**.      |
| `-n, --name <name>`     | The name of the model. Defaults to the source folder name if not provided. |
| `-f, --fast`            | Enables a faster training process by prioritizing speed over accuracy.     |

#### Examples

```bash
ds-faceapi train -s ./images -n my-model
```

This command trains the images in the `./images` directory and creates a model named `my-model.json`.

To prioritize speed over accuracy, add the `--fast` option or just `-f` flag:

```bash
ds-faceapi train -s ./images -f
```

## License

This project is licensed under the MIT License. See the [LICENSE](./LICENSE) file for details.

## Support

For any issues or questions, please contact me at _hamacjumar@gmail.com_.