Commit d1ea273a authored by narugo1992's avatar narugo1992
Browse files

dev(narugo): better docs

parent bbc13e9d

imgutils/restore/nafnet.py

+6 −0
Original line number Diff line number Diff line
@@ -14,6 +14,12 @@ Overview: 
        Currently, we've identified a significant issue with NafNet when images contain gaussian noise.

        To ensure your code functions correctly, please ensure the credibility of

        your image source or preprocess them using SCUNet.



    .. note::

        New in version v0.4.4, **images with alpha channel supported**.



        If you use an image with alpha channel (e.g. RGBA images),

        it will return a RGBA image, otherwise return RGG image.

"""

from functools import lru_cache

from typing import Literal

imgutils/restore/scunet.py

+5 −0
Original line number Diff line number Diff line
@@ -10,6 +10,11 @@ Overview: 
    .. image:: scunet_benchmark.plot.py.svg

        :align: center



    .. note::

        New in version v0.4.4, **images with alpha channel supported**.



        If you use an image with alpha channel (e.g. RGBA images),

        it will return a RGBA image, otherwise return RGG image.

"""

from functools import lru_cache

from typing import Literal