Move Defaults to to end of arg docstring and standardise values

.gitignore

@@ -11,6 +11,7 @@ build/
 *.egg-info
 __pycache__/
 *.so
+venv
 
 #VS Code files and container
 .vscode/

benchmarks/vectorized_channel_shuffle.py

@@ -38,7 +38,7 @@ class OldChannelShuffle(BaseImageAugmentationLayer):
         `(..., height, width, channels)`, in `"channels_last"` format
 
     Args:
-        groups: Number of groups to divide the input channels, defaults to 3.
+        groups: Number of groups to divide the input channels. Defaults to `3`.
         seed: Integer. Used to create a random seed.
 
     Call arguments:
@@ -48,7 +48,7 @@ class OldChannelShuffle(BaseImageAugmentationLayer):
             ` or (width, height, channels)`, with dtype
                 tf.float32 / tf.uint8
         training: A boolean argument that determines whether the call should be
-            run in inference mode or training mode, defaults to True.
+            run in inference mode or training mode. Defaults to `True`.
 
     Usage:
     ```python

benchmarks/vectorized_jittered_resize.py

@@ -87,15 +87,15 @@ class OldJitteredResize(BaseImageAugmentationLayer):
             This factor is used to scale the input image.
             To replicate the results of the MaskRCNN paper pass `(0.8, 1.25)`.
         crop_size: (Optional) the size of the image to crop from the scaled
-            image, defaults to `target_size` when not provided.
+            image. Defaults to `target_size`.
         bounding_box_format: The format of bounding boxes of input boxes.
             Refer to
-            https://github.com/keras-team/keras-cv/blob/master/keras_cv/bounding_box/converters.py
+            keras-team/keras-cv/blob/master/keras_cv/bounding_box/converters.py
             for more details on supported bounding box formats.
-        interpolation: String, the interpolation method, defaults to
-            `"bilinear"`. Supports `"bilinear"`, `"nearest"`, `"bicubic"`,
-            `"area"`, `"lanczos3"`, `"lanczos5"`, `"gaussian"`,
-            `"mitchellcubic"`.
+        interpolation: String, the interpolation method.
+            Supports `"bilinear"`, `"nearest"`, `"bicubic"`, `"area"`,
+            `"lanczos3"`, `"lanczos5"`, `"gaussian"`, `"mitchellcubic"`.
+            Defaults to `"bilinear"`.
         seed: (Optional) integer to use as the random seed.
     """
 

benchmarks/vectorized_mosaic.py

@@ -50,15 +50,16 @@ class OldMosaic(BaseImageAugmentationLayer):
             sampled between the two values for every image augmented. If a
             single float is used, a value between `0.0` and the passed float is
             sampled. In order to ensure the value is always the same, please
-            pass a tuple with two identical floats: `(0.5, 0.5)`. Defaults to
-            (0.25, 0.75).
+            pass a tuple with two identical floats: `(0.5, 0.5)`.
+            Defaults to `(0.25, 0.75)`.
         bounding_box_format: a case-insensitive string (for example, "xyxy") to
             be passed if bounding boxes are being augmented by this layer.
             Each bounding box is defined by at least these 4 values. The inputs
             may contain additional information such as classes and confidence
             after these 4 values but these values will be ignored and returned
             as is. For detailed information on the supported formats, see the
-            [KerasCV bounding box documentation](https://keras.io/api/keras_cv/bounding_box/formats/). Defaults to None.
+            [KerasCV bounding box documentation](https://keras.io/api/keras_cv/bounding_box/formats/).
+            Defaults to `None`.
         seed: integer, used to create a random seed.
 
     References:

benchmarks/vectorized_random_brightness.py

@@ -46,11 +46,12 @@ class OldRandomBrightness(BaseImageAugmentationLayer):
         is provided, eg, 0.2, then -0.2 will be used for lower bound and 0.2
         will be used for upper bound.
       value_range: Optional list/tuple of 2 floats for the lower and upper limit
-        of the values of the input data, defaults to [0.0, 255.0]. Can be
-        changed to e.g. [0.0, 1.0] if the image input has been scaled before
-        this layer. The brightness adjustment will be scaled to this range, and
-        the output values will be clipped to this range.
+        of the values of the input data. Can be changed to e.g. [0.0, 1.0] if
+        the image input has been scaled before this layer. The brightness
+        adjustment will be scaled to this range, and the output values will be
+        clipped to this range. Defaults to `[0.0, 255.0]`.
       seed: optional integer, for fixed RNG behavior.
+        Defaults to `[0.0, 255.0]`.
     Inputs: 3D (HWC) or 4D (NHWC) tensor, with float or int dtype. Input pixel
       values can be of any range (e.g. `[0., 1.)` or `[0, 255]`)
     Output: 3D (HWC) or 4D (NHWC) tensor with brightness adjusted based on the

benchmarks/vectorized_random_flip.py

@@ -58,9 +58,9 @@ class OldRandomFlip(BaseImageAugmentationLayer):
 
     Arguments:
       mode: String indicating which flip mode to use. Can be `"horizontal"`,
-        `"vertical"`, or `"horizontal_and_vertical"`, defaults to
-        `"horizontal"`. `"horizontal"` is a left-right flip and `"vertical"` is
-        a top-bottom flip.
+        `"vertical"`, or `"horizontal_and_vertical"`. `"horizontal"` is a
+        left-right flip and `"vertical"` is a top-bottom flip.
+        Defaults to `"horizontal"`.
       seed: Integer. Used to create a random seed.
       bounding_box_format: The format of bounding boxes of input dataset.
         Refer to

benchmarks/vectorized_random_zoom.py

@@ -56,10 +56,10 @@ class OldRandomZoom(BaseImageAugmentationLayer):
         represented as a single float, this value is used for both the upper and
         lower bound. For instance, `width_factor=(0.2, 0.3)` result in an output
         zooming out between 20% to 30%. `width_factor=(-0.3, -0.2)` result in an
-        output zooming in between 20% to 30%. Defaults to `None`, i.e., zooming
+        output zooming in between 20% to 30%. When `None`: zooming
         vertical and horizontal directions by preserving the aspect ratio. If
         height_factor=0 and width_factor=None, it would result in images with
-        no zoom at all.
+        no zoom at all. Defaults to `None`.
       fill_mode: Points outside the boundaries of the input are filled according
         to the given mode (one of `{"constant", "reflect", "wrap", "nearest"}`).
         - *reflect*: `(d c b a | a b c d | d c b a)` The input is extended by

benchmarks/vectorized_randomly_zoomed_crop.py

@@ -52,8 +52,8 @@ class OldRandomlyZoomedCrop(BaseImageAugmentationLayer):
             tasks, this should be `(3/4, 4/3)`. To perform a no-op provide the
             value `(1.0, 1.0)`.
         interpolation: (Optional) A string specifying the sampling method for
-            resizing, defaults to "bilinear".
-        seed: (Optional) Used to create a random seed, defaults to None.
+            resizing. Defaults to `"bilinear"`.
+        seed: (Optional) Used to create a random seed. Defaults to `None`.
     """
 
     def __init__(

examples/training/classification/imagenet/basic_training.py

@@ -146,7 +146,7 @@
 batch size based on the number of accelerators being used.
 """
 
-# Try to detect an available TPU. If none is present, defaults to
+# Try to detect an available TPU. If none is present. Defaults to
 # MirroredStrategy
 try:
     tpu = tf.distribute.cluster_resolver.TPUClusterResolver.connect()
@@ -303,10 +303,11 @@ def lr_warmup_cosine_decay(
 learning rate, after an optional holding period.
 
 args:
-    - [float] start_lr: default 0.0, the starting learning rate at the beginning
-        of training from which the warmup starts
-    - [float] target_lr: default 1e-2, the target (initial) learning rate from
-        which you'd usually start without a LR warmup schedule
+    - [float] start_lr: the starting learning rate at the beginning
+        of training from which the warmup starts. Defaults to `0.0`.
+    - [float] target_lr: the target (initial) learning rate from
+        which you'd usually start without a LR warmup schedule.
+        Defaults to `1e-2`.
     - [int] warmup_steps: number of training steps to warm up for expressed in
         batches
     - [int] total_steps: the total steps (epochs * number of batches per epoch)

keras_cv/bounding_box/converters.py

@@ -364,7 +364,7 @@ def convert_format(
             converters to compute relative pixel values of the bounding box
             dimensions. Required when transforming from a rel format to a
             non-rel format.
-        dtype: the data type to use when transforming the boxes, defaults to
+        dtype: the data type to use when transforming the boxes. Defaults to
             `"float32"`.
     """
     if isinstance(boxes, dict):

keras_cv/bounding_box/iou.py

@@ -96,8 +96,8 @@ def compute_iou(
       use_masking: whether masking will be applied. This will mask all `boxes1`
         or `boxes2` that have values less than 0 in all its 4 dimensions.
         Default to `False`.
-      mask_val: int to mask those returned IOUs if the masking is True, defaults
-        to -1.
+      mask_val: int to mask those returned IOUs if the masking is True.
+        Defaults to `-1`.
 
     Returns:
       iou_lookup_table: a vector containing the pairwise ious of boxes1 and

keras_cv/bounding_box/to_dense.py

@@ -45,8 +45,8 @@ def to_dense(bounding_boxes, max_boxes=None, default_value=-1):
         max_boxes: the maximum number of boxes, used to pad tensors to a given
             shape. This can be used to make object detection pipelines TPU
             compatible.
-        default_value: the default value to pad bounding boxes with. defaults
-            to -1.
+        default_value: the default value to pad bounding boxes with.
+            Defaults to `-1`.
     """
     info = validate_format.validate_format(bounding_boxes)
 

keras_cv/bounding_box/to_ragged.py

@@ -45,7 +45,8 @@ def to_ragged(bounding_boxes, sentinel=-1, dtype=tf.float32):
         bounding_boxes: a Tensor of bounding boxes. May be batched, or
             unbatched.
         sentinel: The value indicating that a bounding box does not exist at the
-            current index, and the corresponding box is padding, defaults to -1.
+            current index, and the corresponding box is padding.
+            Defaults to `-1`.
         dtype: the data type to use for the underlying Tensors.
     Returns:
         dictionary of `tf.RaggedTensor` or 'tf.Tensor' containing the filtered

keras_cv/datasets/imagenet/load.py

@@ -81,12 +81,12 @@ def load(
         batch_size: how many instances to include in batches after loading.
             Should only be specified if img_size is specified (so that images
             can be resized to the same size before batching).
-        shuffle: whether to shuffle the dataset, defaults to True.
+        shuffle: whether to shuffle the dataset. Defaults to `True`.
         shuffle_buffer: the size of the buffer to use in shuffling.
         reshuffle_each_iteration: whether to reshuffle the dataset on every
-            epoch, defaults to False.
-        img_size: the size to resize the images to, defaults to None, indicating
-            that images should not be resized.
+            epoch. Defaults to `False`.
+        img_size: the size to resize the images to, when None, this indicates
+            that images should not be resized. Defaults to `None`.
 
     Returns:
         tf.data.Dataset containing ImageNet. Each entry is a dictionary

keras_cv/datasets/pascal_voc/load.py

@@ -66,10 +66,10 @@ def load(
             for more details on supported bounding box formats.
         batch_size: how many instances to include in batches after loading
         shuffle_buffer: the size of the buffer to use in shuffling.
-        shuffle_files: (Optional) whether to shuffle files, defaults to
-            True.
+        shuffle_files: (Optional) whether to shuffle files. Defaults to
+            `True`.
         dataset: (Optional) the PascalVOC dataset to load from. Should be either
-            'voc/2007' or 'voc/2012', defaults to 'voc/2007'.
+            `"voc/2007"` or `"voc/2012"`. Defaults to `"voc/2007"`.
 
     Returns:
         tf.data.Dataset containing PascalVOC. Each entry is a dictionary

keras_cv/datasets/pascal_voc/segmentation.py

@@ -484,8 +484,8 @@ def load(
             dataset. Defaults to `sbd_train`.
         data_dir: string, local directory path for the loaded data. This will be
             used to download the data file, and unzip. It will be used as a
-            cache directory. Defaults to None, and `~/.keras/pascal_voc_2012`
-            will be used.
+            cache directory. When `None`: `~/.keras/pascal_voc_2012`
+            will be used. Defaults to `None`.
     """
     supported_split_value = [
         "train",

keras_cv/datasets/waymo/load.py

@@ -53,11 +53,11 @@ def load(
             tfrecords in the Waymo Open Dataset, or a list of strings pointing
             to the tfrecords themselves
         transformer: a Python function which transforms a Waymo Open Dataset
-          Frame object into tensors, defaults to convert range image to point
+          Frame object into tensors. Defaults to convert range image to point
           cloud.
         output_signature: the type specification of the tensors created by the
           transformer. This is often a dictionary from feature column names to
-          tf.TypeSpecs, defaults to point cloud representations of Waymo Open
+          tf.TypeSpecs. Defaults to point cloud representations of Waymo Open
           Dataset data.
 
     Returns:

keras_cv/keypoint/converters.py

@@ -110,7 +110,7 @@ def convert_format(keypoints, source, target, images=None, dtype=None):
             Required when transforming from a rel format to a non-rel
             format.
         dtype: the data type to use when transforming the boxes.
-            Defaults to None, i.e. `keypoints` dtype.
+            When `None` uses a `keypoints` dtype. Defaults to `None`.
     """
 
     source = source.lower()

keras_cv/layers/feature_pyramid.py

@@ -55,17 +55,17 @@ class FeaturePyramid(keras.layers.Layer):
         max_level: a python int for the highest level of the pyramid for
             feature extraction.
         num_channels: an integer representing the number of channels for the FPN
-            operations, defaults to 256.
+            operations. Defaults to `256`.
         lateral_layers: a python dict with int keys that matches to each of the
             pyramid level. The values of the dict should be `keras.Layer`, which
             will be called with feature activation outputs from backbone at each
-            level. Defaults to None, and a `keras.Conv2D` layer with kernel 1x1
-            will be created for each pyramid level.
+            level. When `None`: a `keras.Conv2D` layer with kernel 1x1
+            will be created for each pyramid level. Defaults to `None`.
         output_layers: a python dict with int keys that matches to each of the
             pyramid level. The values of the dict should be `keras.Layer`, which
             will be called with feature inputs and merged result from upstream
-            levels. Defaults to None, and a `keras.Conv2D` layer with kernel 3x3
-            will be created for each pyramid level.
+            levels. When `None`: a `keras.Conv2D` layer with kernel 3x3
+            will be created for each pyramid level. Defaults to `None`.
 
     Sample Usage:
     ```python

keras_cv/layers/fusedmbconv.py

@@ -52,19 +52,21 @@ class FusedMBConvBlock(keras.layers.Layer):
     Args:
         input_filters: int, the number of input filters
         output_filters: int, the number of output filters
-        expand_ratio: default 1, the ratio by which input_filters are multiplied
-            to expand the structure in the middle expansion phase
-        kernel_size: default 3, the kernel_size to apply to the expansion phase
-            convolutions
-        strides: default 1, the strides to apply to the expansion phase
-            convolutions
-        se_ratio: default 0.0, The filters used in the Squeeze-Excitation phase,
+        expand_ratio: the ratio by which input_filters are multiplied
+            to expand the structure in the middle expansion phase.
+            Defaults to `1`.
+        kernel_size: the kernel_size to apply to the expansion phase
+            convolutions. Defaults to `3`.
+        strides: the strides to apply to the expansion phase
+            convolutions. Defaults to `1`.
+        se_ratio: The filters used in the Squeeze-Excitation phase,
             and are chosen as the maximum between 1 and input_filters*se_ratio
-        bn_momentum: default 0.9, the BatchNormalization momentum
-        activation: default "swish", the activation function used between
-            convolution operations
+            Defaults to `0.0`.
+        bn_momentum: the BatchNormalization momentum. Defaults to `0.9`.
+        activation: the activation function used between
+            convolution operations. Defaults to `"swish"`.
         survival_probability: float, the optional dropout rate to apply before
-            the output convolution, defaults to 0.8
+            the output convolution. Defaults to `0.8`.
 
     Returns:
         A `tf.Tensor` representing a feature map, passed through the FusedMBConv

keras_cv/layers/mbconv.py

@@ -63,21 +63,22 @@ def __init__(
             input_filters: int, the number of input filters
             output_filters: int, the optional number of output filters after
                 Squeeze-Excitation
-            expand_ratio: default 1, the ratio by which input_filters are
-                multiplied to expand the structure in the middle expansion phase
-            kernel_size: default 3, the kernel_size to apply to the expansion
-                phase convolutions
-            strides: default 1, the strides to apply to the expansion phase
-                convolutions
-            se_ratio: default 0.0, Squeeze-Excitation happens before depthwise
-                convolution and before output convolution only if the se_ratio
-                is above 0. The filters used in this phase are chosen as the
-                maximum between 1 and input_filters*se_ratio
-            bn_momentum: default 0.9, the BatchNormalization momentum
-            activation: default "swish", the activation function used between
-                convolution operations
+            expand_ratio: the ratio by which input_filters are
+                multiplied to expand the structure in the middle expansion phase.
+                Defaults to `1`.
+            kernel_size: the kernel_size to apply to the expansion
+                phase convolutions. Defaults to `3`.
+            strides: the strides to apply to the expansion phase
+                convolutions. Defaults to `1`.
+            se_ratio: Squeeze-Excitation happens before depthwise convolution
+                and before output convolution only if the se_ratio is above 0.
+                The filters used in this phase are chosen as the maximum
+                between 1 and input_filters*se_ratio. Defaults to `0.0`.
+            bn_momentum: the BatchNormalization momentum. Defaults to `0.9`.
+            activation: the activation function used between
+                convolution operations. Defaults to `"swish"`.
             survival_probability: float, the optional dropout rate to apply
-                before the output convolution, defaults to 0.8
+                before the output convolution. Defaults to `0.8`.
 
         Returns:
             A `tf.Tensor` representing a feature map, passed through the MBConv

keras_cv/layers/object_detection/anchor_generator.py

@@ -48,7 +48,7 @@ class AnchorGenerator(keras.layers.Layer):
       strides: iterable of ints that represent the anchor stride size between
         center of anchors at each scale.
       clip_boxes: whether to clip generated anchor boxes to the image
-        size, defaults to `False`.
+        size. Defaults to `False`.
 
     Usage:
     ```python
@@ -210,8 +210,8 @@ class _SingleAnchorGenerator:
       stride: A single int represents the anchor stride size between center of
         each anchor.
       clip_boxes: Boolean to represent whether the anchor coordinates should be
-        clipped to the image size, defaults to `False`.
-      dtype: (Optional) The data type to use for the output anchors, defaults to
+        clipped to the image size. Defaults to `False`.
+      dtype: (Optional) The data type to use for the output anchors. Defaults to
         'float32'.
 
     """