Skip to content

Commit 15f09eb

Browse files
Standardize docstring (#2399)
1 parent 301f7cd commit 15f09eb

File tree

88 files changed

+88
-88
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

88 files changed

+88
-88
lines changed

benchmarks/vectorized_channel_shuffle.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ class OldChannelShuffle(BaseImageAugmentationLayer):
5050
training: A boolean argument that determines whether the call should be
5151
run in inference mode or training mode, defaults to True.
5252
53-
Usage:
53+
Example:
5454
```python
5555
(images, labels), _ = keras.datasets.cifar10.load_data()
5656
channel_shuffle = keras_cv.layers.ChannelShuffle()

benchmarks/vectorized_grayscale.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ class OldGrayscale(BaseImageAugmentationLayer):
4242
after the `Grayscale` operation:
4343
a. (..., height, width, 1) if output_channels = 1
4444
b. (..., height, width, 3) if output_channels = 3.
45-
Usage:
45+
Example:
4646
```python
4747
(images, labels), _ = keras.datasets.cifar10.load_data()
4848
to_grayscale = keras_cv.layers.preprocessing.Grayscale()

benchmarks/vectorized_jittered_resize.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ class OldJitteredResize(BaseImageAugmentationLayer):
5353
are translated and scaled according to the random scaling and random
5454
cropping.
5555
56-
Usage:
56+
Example:
5757
```python
5858
train_ds = load_object_detection_dataset()
5959
jittered_resize = layers.JitteredResize(

benchmarks/vectorized_mosaic.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ class OldMosaic(BaseImageAugmentationLayer):
6666
- [Yolov5 implementation](https://github.com/ultralytics/yolov5).
6767
- [YoloX implementation](https://github.com/Megvii-BaseDetection/YOLOX)
6868
69-
Sample usage:
69+
Example:
7070
```python
7171
(images, labels), _ = keras.datasets.cifar10.load_data()
7272
labels = tf.one_hot(labels,10)

benchmarks/vectorized_random_color_jitter.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ class OldRandomColorJitter(BaseImageAugmentationLayer):
7272
pass a tuple with two identical floats: `(0.5, 0.5)`.
7373
seed: Integer. Used to create a random seed.
7474
75-
Usage:
75+
Example:
7676
```python
7777
(images, labels), _ = keras.datasets.cifar10.load_data()
7878
color_jitter = keras_cv.layers.RandomColorJitter(

keras_cv/bounding_box/converters.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -338,7 +338,7 @@ def convert_format(
338338
performance loss, as each image will need to be processed separately due to
339339
the mismatching image shapes.
340340
341-
Usage:
341+
Example:
342342
343343
```python
344344
boxes = load_coco_dataset()

keras_cv/bounding_box/to_ragged.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ def to_ragged(bounding_boxes, sentinel=-1, dtype=tf.float32):
2929
checking for padded sentinel value of the class_id axis of the
3030
bounding_boxes.
3131
32-
Usage:
32+
Example:
3333
```python
3434
bounding_boxes = {
3535
"boxes": tf.constant([[2, 3, 4, 5], [0, 1, 2, 3]]),

keras_cv/core/factor_sampler/constant_factor_sampler.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ class ConstantFactorSampler(FactorSampler):
2929
Args:
3030
value: the value to return from `__call__()`.
3131
32-
Usage:
32+
Example:
3333
```python
3434
constant_factor = keras_cv.ConstantFactorSampler(0.5)
3535
random_sharpness = keras_cv.layers.RandomSharpness(factor=constant_factor)

keras_cv/core/factor_sampler/normal_factor_sampler.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ class NormalFactorSampler(FactorSampler):
3131
min_value: values below min_value are clipped to min_value.
3232
max_value: values above max_value are clipped to max_value.
3333
34-
Usage:
34+
Example:
3535
```python
3636
factor = keras_cv.core.NormalFactor(
3737
mean=0.5,

keras_cv/core/factor_sampler/uniform_factor_sampler.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ class UniformFactorSampler(FactorSampler):
3131
seed: A shape int or Tensor, the seed to the random number generator.
3232
Must have dtype int32 or int64. (When using XLA, only int32 is
3333
allowed.)
34-
Usage:
34+
Example:
3535
```python
3636
uniform_factor = keras_cv.UniformFactorSampler(0, 0.5)
3737
random_sharpness = keras_cv.layers.RandomSharpness(factor=uniform_factor)

0 commit comments

Comments
 (0)