docs

ASEM000 · Apr 10, 2024 · 9c376ed · 9c376ed
1 parent e76957d
commit 9c376ed
Show file tree

Hide file tree

Showing 70 changed files with 747 additions and 7,482 deletions.
diff --git a/docs/API/augment.rst b/docs/API/augment.rst
diff --git a/docs/API/color.rst b/docs/API/color.rst
diff --git a/docs/API/common.rst b/docs/API/common.rst
@@ -3,8 +3,7 @@
 
 .. currentmodule:: serket
 
-.. autofunction:: tree_state
-.. autofunction:: tree_eval
-
 .. autoclass:: Sequential
-.. autoclass:: RandomChoice
+
+.. autofunction:: tree_state
+.. autofunction:: tree_eval
diff --git a/docs/API/convolution.rst b/docs/API/convolution.rst
@@ -6,39 +6,30 @@ Convolution
 .. autoclass:: Conv1D
 .. autoclass:: Conv2D
 .. autoclass:: Conv3D
-
 .. autoclass:: Conv1DTranspose
 .. autoclass:: Conv2DTranspose
 .. autoclass:: Conv3DTranspose
-
 .. autoclass:: DepthwiseConv1D
 .. autoclass:: DepthwiseConv2D
 .. autoclass:: DepthwiseConv3D
-
 .. autoclass:: SeparableConv1D
 .. autoclass:: SeparableConv2D
 .. autoclass:: SeparableConv3D
-
 .. autoclass:: Conv1DLocal
 .. autoclass:: Conv2DLocal
 .. autoclass:: Conv3DLocal
-
 .. autoclass:: FFTConv1D
 .. autoclass:: FFTConv2D
 .. autoclass:: FFTConv3D
-
 .. autoclass:: DepthwiseFFTConv1D
 .. autoclass:: DepthwiseFFTConv2D
 .. autoclass:: DepthwiseFFTConv3D
-
 .. autoclass:: FFTConv1DTranspose
 .. autoclass:: FFTConv2DTranspose
 .. autoclass:: FFTConv3DTranspose
-
 .. autoclass:: SeparableFFTConv1D
 .. autoclass:: SeparableFFTConv2D
 .. autoclass:: SeparableFFTConv3D
-
 .. autoclass:: SpectralConv1D
 .. autoclass:: SpectralConv2D
 .. autoclass:: SpectralConv3D

diff --git a/docs/API/filter.rst b/docs/API/filter.rst
@@ -1,62 +1,49 @@
 Filter API
 ---------------------------------
 .. currentmodule:: serket.image
-
-.. autoclass:: AvgBlur2D
-.. autoclass:: FFTAvgBlur2D
-
-.. autoclass:: BoxBlur2D
-.. autoclass:: FFTBoxBlur2D
 
+.. autoclass:: AvgBlur2D
+.. autoclass:: BilateralBlur2D
 .. autoclass:: BlurPool2D
+.. autoclass:: BoxBlur2D
+.. autoclass:: ElasticTransform2D
+.. autoclass:: FFTAvgBlur2D
 .. autoclass:: FFTBlurPool2D
-
-.. autoclass:: BilateralBlur2D
-.. autoclass:: JointBilateralBlur2D
-.. autoclass:: MedianBlur2D
-
-.. autoclass:: GaussianBlur2D
+.. autoclass:: FFTBoxBlur2D
+.. autoclass:: FFTElasticTransform2D
 .. autoclass:: FFTGaussianBlur2D
-
-.. autoclass:: Laplacian2D
 .. autoclass:: FFTLaplacian2D
-
-.. autoclass:: MotionBlur2D
 .. autoclass:: FFTMotionBlur2D
-
-.. autoclass:: UnsharpMask2D
+.. autoclass:: FFTSobel2D
 .. autoclass:: FFTUnsharpMask2D
-
+.. autoclass:: GaussianBlur2D
+.. autoclass:: JointBilateralBlur2D
+.. autoclass:: Laplacian2D
+.. autoclass:: MedianBlur2D
+.. autoclass:: MotionBlur2D
 .. autoclass:: Sobel2D
-.. autoclass:: FFTSobel2D
+.. autoclass:: UnsharpMask2D
 
 .. autofunction:: avg_blur_2d
-.. autofunction:: fft_avg_blur_2d
-
-.. autofunction:: box_blur_2d
-.. autofunction:: fft_box_blur_2d
-
+.. autofunction:: bilateral_blur_2d
 .. autofunction:: blur_pool_2d
+.. autofunction:: box_blur_2d
+.. autofunction:: elastic_transform_2d
+.. autofunction:: fft_avg_blur_2d
 .. autofunction:: fft_blur_pool_2d
-
-.. autofunction:: bilateral_blur_2d
-.. autofunction:: joint_bilateral_blur_2d
-.. autofunction:: median_blur_2d
-
-.. autofunction:: gaussian_blur_2d
+.. autofunction:: fft_box_blur_2d
+.. autofunction:: fft_elastic_transform_2d
+.. autofunction:: fft_filter_2d
 .. autofunction:: fft_gaussian_blur_2d
-
-.. autofunction:: laplacian_2d
 .. autofunction:: fft_laplacian_2d
-
-.. autofunction:: motion_blur_2d
 .. autofunction:: fft_motion_blur_2d
-
-.. autofunction:: unsharp_mask_2d
-.. autofunction:: fft_unsharp_mask_2d
-
-.. autofunction:: sobel_2d
 .. autofunction:: fft_sobel_2d
-
+.. autofunction:: fft_unsharp_mask_2d
 .. autofunction:: filter_2d
-.. autofunction:: fft_filter_2d
+.. autofunction:: gaussian_blur_2d
+.. autofunction:: joint_bilateral_blur_2d
+.. autofunction:: laplacian_2d
+.. autofunction:: median_blur_2d
+.. autofunction:: motion_blur_2d
+.. autofunction:: sobel_2d
+.. autofunction:: unsharp_mask_2d
diff --git a/docs/API/image.rst b/docs/API/image.rst
@@ -9,6 +9,4 @@
    :caption: API Documentation
 
    geometric
-   augment
    filter
-   color
diff --git a/docs/_static/adjustbrightness2d.png b/docs/_static/adjustbrightness2d.png
diff --git a/docs/_static/adjustcontrast2d.png b/docs/_static/adjustcontrast2d.png
diff --git a/docs/_static/adjusthue2d.png b/docs/_static/adjusthue2d.png
diff --git a/docs/_static/adjustsaturation2d.png b/docs/_static/adjustsaturation2d.png
diff --git a/docs/_static/fourierdomainadapt2d.png b/docs/_static/fourierdomainadapt2d.png
diff --git a/docs/_static/jigsaw2d.png b/docs/_static/jigsaw2d.png
-Original file line number
+Diff line change
@@ Expand Up / @@ -9,6 +9,4 @@ @@
        :caption: API Documentation
        geometric
-       augment
        filter
-       color