#!/usr/bin/env python3
""" The default options for the faceswap VGG obstructed plugin.

Defaults files should be named `<plugin_name>_defaults.py`

Any qualifying items placed into this file will automatically get added to the relevant config
.ini files within the faceswap/config folder and added to the relevant GUI settings page.

The following variable should be defined:

    Parameters
    ----------
    HELPTEXT: str
        A string describing what this plugin does

Further plugin configuration options are assigned using:
>>> <config_item> = ConfigItem(...)

where <config_item> is the name of the configuration option to be added (lower-case, alpha-numeric
+ underscore only) and ConfigItem(...) is the [`~lib.config.objects.ConfigItem`] data for the
option.

See the docstring/ReadtheDocs documentation required parameters for the ConfigItem object.
Items will be grouped together as per their `group` parameter, but otherwise will be processed in
the order that they are added to this module.
from lib.config import ConfigItem
"""
# pylint:disable=duplicate-code
from lib.config import ConfigItem


HELPTEXT = (
    "VGG_Obstructed options. Mask designed to provide smart segmentation of mostly frontal "
    "faces.\nThe mask model has been specifically trained to recognize some facial obstructions "
    "(hands and eyeglasses). Profile faces may result in sub-par performance."
    )


batch_size = ConfigItem(
    datatype=int,
    default=2,
    group="settings",
    info="The batch size to use. To a point, higher batch sizes equal better performance, "
         "but setting it too high can harm performance.\n"
         "\n\tNvidia users: If the batchsize is set higher than the your GPU can "
         "accomodate then this will automatically be lowered.",
    rounding=1,
    min_max=(1, 64))
