Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[keras/layers/convolutional] Standardise docstring usage of "Default to" #17963

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions keras/layers/convolutional/base_depthwise_conv.py
Original file line number Diff line number Diff line change
Expand Up @@ -65,10 +65,10 @@ class DepthwiseConv(Conv):
`channels_first`. The ordering of the dimensions in the inputs.
`channels_last` corresponds to inputs with shape `(batch_size, height,
width, channels)` while `channels_first` corresponds to inputs with
shape `(batch_size, channels, height, width)`. It defaults to the
`image_data_format` value found in your Keras config file at
`~/.keras/keras.json`. If you never set it, then it will be
'channels_last'.
shape `(batch_size, channels, height, width)`. If left unspecified,
uses `image_data_format` value found in your Keras config file at
`~/.keras/keras.json` (if exists) else 'channels_last'.
Defaults to 'channels_last'.
dilation_rate: An integer or tuple/list of 2 integers, specifying the
dilation rate to use for dilated convolution. Currently, specifying any
`dilation_rate` value != 1 is incompatible with specifying any `strides`
Expand Down
2 changes: 1 addition & 1 deletion keras/layers/convolutional/conv1d_transpose.py
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ class Conv1DTranspose(Conv1D):
kernel_size: An integer length of the 1D convolution window.
strides: An integer specifying the stride of the convolution along the
time dimension. Specifying a stride value != 1 is incompatible with
specifying a `dilation_rate` value != 1. Defaults to 1.
specifying a `dilation_rate` value != 1. Defaults to `1`.
padding: one of `"valid"` or `"same"` (case-insensitive).
`"valid"` means no padding. `"same"` results in padding with zeros
evenly to the left/right or up/down of the input such that output has
Expand Down
10 changes: 5 additions & 5 deletions keras/layers/convolutional/conv2d.py
Original file line number Diff line number Diff line change
Expand Up @@ -101,11 +101,11 @@ class Conv2D(Conv):
`channels_first`. The ordering of the dimensions in the inputs.
`channels_last` corresponds to inputs with shape `(batch_size, height,
width, channels)` while `channels_first` corresponds to inputs with
shape `(batch_size, channels, height, width)`. It defaults to the
`image_data_format` value found in your Keras config file at
`~/.keras/keras.json`. If you never set it, then it will be
`channels_last`. Note that the `channels_first` format is currently not
supported by TensorFlow on CPU.
shape `(batch_size, channels, height, width)`. If left unspecified, it
uses the `image_data_format` value found in your Keras config file at
`~/.keras/keras.json` (if exists) else 'channels_last'.
Note that the `channels_first` format is currently not
supported by TensorFlow on CPU. Defaults to 'channels_last'.
dilation_rate: an integer or tuple/list of 2 integers, specifying the
dilation rate to use for dilated convolution. Can be a single integer to
specify the same value for all spatial dimensions. Currently, specifying
Expand Down
6 changes: 3 additions & 3 deletions keras/layers/convolutional/conv2d_transpose.py
Original file line number Diff line number Diff line change
Expand Up @@ -82,9 +82,9 @@ class Conv2DTranspose(Conv2D):
`(batch_size, height, width, channels)` while `channels_first`
corresponds to inputs with shape
`(batch_size, channels, height, width)`.
It defaults to the `image_data_format` value found in your
Keras config file at `~/.keras/keras.json`.
If you never set it, then it will be "channels_last".
When unspecified, uses `image_data_format` value found in your Keras
config file at `~/.keras/keras.json` (if exists) else 'channels_last'.
Defaults to "channels_last".
dilation_rate: an integer, specifying the dilation rate for all spatial
dimensions for dilated convolution. Specifying different dilation rates
for different dimensions is not supported.
Expand Down
10 changes: 5 additions & 5 deletions keras/layers/convolutional/conv3d.py
Original file line number Diff line number Diff line change
Expand Up @@ -83,11 +83,11 @@ class Conv3D(Conv):
`channels_last` corresponds to inputs with shape `batch_shape +
(spatial_dim1, spatial_dim2, spatial_dim3, channels)` while
`channels_first` corresponds to inputs with shape `batch_shape +
(channels, spatial_dim1, spatial_dim2, spatial_dim3)`. It defaults to
the `image_data_format` value found in your Keras config file at
`~/.keras/keras.json`. If you never set it, then it will be
"channels_last". Note that the `channels_first` format is currently not
supported by TensorFlow on CPU.
(channels, spatial_dim1, spatial_dim2, spatial_dim3)`. When unspecified,
uses `image_data_format` value found in your Keras config file at
`~/.keras/keras.json` (if exists) else 'channels_last'. Note that the
`channels_first` format is currently not supported by TensorFlow on CPU.
Defaults to 'channels_last'.
dilation_rate: an integer or tuple/list of 3 integers, specifying the
dilation rate to use for dilated convolution. Can be a single integer to
specify the same value for all spatial dimensions. Currently, specifying
Expand Down
6 changes: 3 additions & 3 deletions keras/layers/convolutional/conv3d_transpose.py
Original file line number Diff line number Diff line change
Expand Up @@ -82,9 +82,9 @@ class Conv3DTranspose(Conv3D):
`(batch_size, depth, height, width, channels)` while `channels_first`
corresponds to inputs with shape
`(batch_size, channels, depth, height, width)`.
It defaults to the `image_data_format` value found in your
Keras config file at `~/.keras/keras.json`.
If you never set it, then it will be "channels_last".
When unspecified, uses `image_data_format` value found in your Keras
config file at `~/.keras/keras.json` (if exists) else 'channels_last'.
Defaults to 'channels_last'.
dilation_rate: an integer or tuple/list of 3 integers, specifying
the dilation rate to use for dilated convolution.
Can be a single integer to specify the same value for
Expand Down
6 changes: 3 additions & 3 deletions keras/layers/convolutional/depthwise_conv1d.py
Original file line number Diff line number Diff line change
Expand Up @@ -67,10 +67,10 @@ class DepthwiseConv1D(DepthwiseConv):
`channels_first`. The ordering of the dimensions in the inputs.
`channels_last` corresponds to inputs with shape `(batch_size, height,
width, channels)` while `channels_first` corresponds to inputs with
shape `(batch_size, channels, height, width)`. It defaults to the
shape `(batch_size, channels, height, width)`. When unspecified, uses
`image_data_format` value found in your Keras config file at
`~/.keras/keras.json`. If you never set it, then it will be
'channels_last'.
`~/.keras/keras.json` (if exists) else 'channels_last'.
Defaults to 'channels_last'.
dilation_rate: A single integer, specifying the dilation rate to use for
dilated convolution. Currently, specifying any `dilation_rate`
value != 1 is incompatible with specifying any stride value != 1.
Expand Down
6 changes: 3 additions & 3 deletions keras/layers/convolutional/depthwise_conv2d.py
Original file line number Diff line number Diff line change
Expand Up @@ -68,10 +68,10 @@ class DepthwiseConv2D(DepthwiseConv):
`channels_first`. The ordering of the dimensions in the inputs.
`channels_last` corresponds to inputs with shape `(batch_size, height,
width, channels)` while `channels_first` corresponds to inputs with
shape `(batch_size, channels, height, width)`. It defaults to the
shape `(batch_size, channels, height, width)`. When unspecified, uses
`image_data_format` value found in your Keras config file at
`~/.keras/keras.json`. If you never set it, then it will be
'channels_last'.
`~/.keras/keras.json` (if exists) else 'channels_last'.
Defaults to 'channels_last'.
dilation_rate: An integer or tuple/list of 2 integers, specifying the
dilation rate to use for dilated convolution. Currently, specifying any
`dilation_rate` value != 1 is incompatible with specifying any `strides`
Expand Down
6 changes: 3 additions & 3 deletions keras/layers/convolutional/separable_conv2d.py
Original file line number Diff line number Diff line change
Expand Up @@ -70,9 +70,9 @@ class SeparableConv2D(SeparableConv):
`(batch_size, height, width, channels)` while `channels_first`
corresponds to inputs with shape
`(batch_size, channels, height, width)`.
It defaults to the `image_data_format` value found in your
Keras config file at `~/.keras/keras.json`.
If you never set it, then it will be "channels_last".
When unspecified, uses `image_data_format` value found in your Keras
config file at `~/.keras/keras.json` (if exists) else 'channels_last'.
Defaults to 'channels_last'.
dilation_rate: An integer or tuple/list of 2 integers, specifying
the dilation rate to use for dilated convolution.
depth_multiplier: The number of depthwise convolution output channels
Expand Down