[xdoctest] reformat example code with google style in No.1-No.5 (#55804)

PaddlePaddle · Aug 1, 2023 · 9084a03 · 9084a03
1 parent 7ce0f9e
commit 9084a03
Show file tree

Hide file tree

Showing 5 changed files with 469 additions and 463 deletions.
diff --git a/python/paddle/batch.py b/python/paddle/batch.py
@@ -35,21 +35,20 @@ def batch(reader, batch_size, drop_last=False):
     Examples:
         .. code-block:: python
 
-            import paddle
-            def reader():
-                for i in range(10):
-                    yield i
-            batch_reader = paddle.batch(reader, batch_size=2)
+            >>> import paddle
+            >>> def reader():
+            ...     for i in range(10):
+            ...         yield i
+            >>> batch_reader = paddle.batch(reader, batch_size=2)
 
-            for data in batch_reader():
-                print(data)
-
-            # Output is
-            # [0, 1]
-            # [2, 3]
-            # [4, 5]
-            # [6, 7]
-            # [8, 9]
+            >>> for data in batch_reader():
+            ...     print(data)
+            ...
+            [0, 1]
+            [2, 3]
+            [4, 5]
+            [6, 7]
+            [8, 9]
     """
 
     def batch_reader():

diff --git a/python/paddle/dataset/image.py b/python/paddle/dataset/image.py
@@ -123,9 +123,9 @@ def load_image_bytes(bytes, is_color=True):
 
     .. code-block:: python
 
-        with open('cat.jpg') as f:
-            im = load_image_bytes(f.read())
-
+        >>> with open('cat.jpg') as f:
+        ...     im = load_image_bytes(f.read())
+        ...
     :param bytes: the input image bytes array.
     :type bytes: str
     :param is_color: If set is_color True, it will load and
@@ -148,7 +148,7 @@ def load_image(file, is_color=True):
 
     .. code-block:: python
 
-        im = load_image('cat.jpg')
+        >>> im = load_image('cat.jpg')
 
     :param file: the input image path.
     :type file: string
@@ -178,8 +178,8 @@ def resize_short(im, size):
 
     .. code-block:: python
 
-        im = load_image('cat.jpg')
-        im = resize_short(im, 256)
+        >>> im = load_image('cat.jpg')
+        >>> im = resize_short(im, 256)
 
     :param im: the input image with HWC layout.
     :type im: ndarray
@@ -208,9 +208,9 @@ def to_chw(im, order=(2, 0, 1)):
 
     .. code-block:: python
 
-        im = load_image('cat.jpg')
-        im = resize_short(im, 256)
-        im = to_chw(im)
+        >>> im = load_image('cat.jpg')
+        >>> im = resize_short(im, 256)
+        >>> im = to_chw(im)
 
     :param im: the input image with HWC layout.
     :type im: ndarray
@@ -230,7 +230,8 @@ def center_crop(im, size, is_color=True):
 
     .. code-block:: python
 
-        im = center_crop(im, 224)
+        >>> im = load_image('cat.jpg')
+        >>> im = center_crop(im, 224)
 
     :param im: the input image with HWC layout.
     :type im: ndarray
@@ -258,7 +259,8 @@ def random_crop(im, size, is_color=True):
 
     .. code-block:: python
 
-        im = random_crop(im, 224)
+        >>> im = load_image('cat.jpg')
+        >>> im = random_crop(im, 224)
 
     :param im: the input image with HWC layout.
     :type im: ndarray
@@ -287,7 +289,8 @@ def left_right_flip(im, is_color=True):
 
     .. code-block:: python
 
-        im = left_right_flip(im)
+        >>> im = load_image('cat.jpg')
+        >>> im = left_right_flip(im)
 
     :param im: input image with HWC layout or HW layout for gray image
     :type im: ndarray
@@ -311,7 +314,8 @@ def simple_transform(
 
     .. code-block:: python
 
-        im = simple_transform(im, 256, 224, True)
+        >>> im = load_image('cat.jpg')
+        >>> im = simple_transform(im, 256, 224, True)
 
     :param im: The input image with HWC layout.
     :type im: ndarray
@@ -365,7 +369,7 @@ def load_and_transform(
 
     .. code-block:: python
 
-        im = load_and_transform('cat.jpg', 256, 224, True)
+        >>> im = load_and_transform('cat.jpg', 256, 224, True)
 
     :param filename: The file name of input image.
     :type filename: string