Commit eb7e9905 authored by narugo1992's avatar narugo1992
Browse files

dev(narugo): add examples

parent 8a19656f

imgutils/validate/aicheck.py

+56 −0
Original line number Diff line number Diff line
@@ -71,6 +71,34 @@ def get_ai_created_score(image: ImageTyping, model_name: str = _DEFAULT_MODEL_NA 
        If you need better accuracy, use ``caformer_s36_plus_sce``.

        All the available values are listed on the benchmark graph.

    :return: A float number which represent the score of AI-check.



    Examples::

        >>> from imgutils.validate import is_ai_created

        >>>

        >>> is_ai_created('aicheck/ai/1.jpg')

        True

        >>> is_ai_created('aicheck/ai/2.jpg')

        True

        >>> is_ai_created('aicheck/ai/3.jpg')

        True

        >>> is_ai_created('aicheck/ai/4.jpg')

        True

        >>> is_ai_created('aicheck/ai/5.jpg')

        True

        >>> is_ai_created('aicheck/ai/6.jpg')

        True

        >>> is_ai_created('aicheck/human/7.jpg')

        False

        >>> is_ai_created('aicheck/human/8.jpg')

        False

        >>> is_ai_created('aicheck/human/9.jpg')

        False

        >>> is_ai_created('aicheck/human/10.jpg')

        False

        >>> is_ai_created('aicheck/human/11.jpg')

        False

        >>> is_ai_created('aicheck/human/12.jpg')

        False

    """

    image = load_image(image, force_background='white', mode='RGB')

    input_ = _img_encode(image)[None, ...]
@@ -91,5 +119,33 @@ def is_ai_created(image: ImageTyping, model_name: str = _DEFAULT_MODEL_NAME, thr 
    :param threshold: Threshold of the score. When the score is no less than ``threshold``, this image

        will be predicted as ``AI-created``. Default is ``0.5``.

    :return: This image is ``AI-created`` or not.



    Examples::

        >>> from imgutils.validate import get_ai_created_score

        >>>

        >>> get_ai_created_score('aicheck/ai/1.jpg')

        0.9996960163116455

        >>> get_ai_created_score('aicheck/ai/2.jpg')

        0.9999125003814697

        >>> get_ai_created_score('aicheck/ai/3.jpg')

        0.997803270816803

        >>> get_ai_created_score('aicheck/ai/4.jpg')

        0.9960069060325623

        >>> get_ai_created_score('aicheck/ai/5.jpg')

        0.9887709021568298

        >>> get_ai_created_score('aicheck/ai/6.jpg')

        0.9998629093170166

        >>> get_ai_created_score('aicheck/human/7.jpg')

        0.0013722758740186691

        >>> get_ai_created_score('aicheck/human/8.jpg')

        0.00020673229300882667

        >>> get_ai_created_score('aicheck/human/9.jpg')

        0.0001895089662866667

        >>> get_ai_created_score('aicheck/human/10.jpg')

        0.0008857478387653828

        >>> get_ai_created_score('aicheck/human/11.jpg')

        4.552320024231449e-05

        >>> get_ai_created_score('aicheck/human/12.jpg')

        0.001168627175502479

    """

    return get_ai_created_score(image, model_name) >= threshold