Commit 8f6e8271 authored by narugo1992's avatar narugo1992
Browse files

dev(narugo): add docs for drop_overlap argument for tagging functions

parent cc28c6cf

imgutils/tagging/deepdanbooru.py

+1 −0
Original line number Diff line number Diff line
@@ -75,6 +75,7 @@ def get_deepdanbooru_tags(image: ImageTyping, use_real_name: bool = False, 
        The default value of ``False`` indicates the use of the original tag names.

    :param general_threshold: Threshold for default tags, default is ``0.35``.

    :param character_threshold: Threshold for character tags, default is ``0.85``.

    :param drop_overlap: Drop overlap tags or not, default is ``False``.

    :return: Tagging results for levels, features and characters.



    Example:

imgutils/tagging/mldanbooru.py

+1 −0
Original line number Diff line number Diff line
@@ -74,6 +74,7 @@ def get_mldanbooru_tags(image: ImageTyping, use_real_name: bool = False, 
    :param size: Size when passing the resized image into model, default is ``448``.

    :param keep_ratio: Keep the original ratio between height and width when passing the image into

        model, default is ``False``.

    :param drop_overlap: Drop overlap tags or not, default is ``False``.



    Example:

        Here are some images for example

imgutils/tagging/wd14.py

+1 −0
Original line number Diff line number Diff line
@@ -96,6 +96,7 @@ def get_wd14_tags(image: ImageTyping, model_name: str = "ConvNextV2", 
        ``SwinV2``, ``ConvNext``, ``ConvNextV2``, ``ViT`` or ``MOAT``, default is ``ConvNextV2``.

    :param general_threshold: Threshold for default tags, default is ``0.35``.

    :param character_threshold: Threshold for character tags, default is ``0.85``.

    :param drop_overlap: Drop overlap tags or not, default is ``False``.

    :return: Tagging results for levels, features and characters.



    Example: