Add migration docstring for legacy_tf_layers/convolution.py

PiperOrigin-RevId: 381058890

keras/legacy_tf_layers/convolutional.py

@@ -81,6 +81,32 @@ class Conv1D(keras_layers.Conv1D, base.Layer):
     trainable: Boolean, if `True` also add variables to the graph collection
       `GraphKeys.TRAINABLE_VARIABLES` (see `tf.Variable`).
     name: A string, the name of the layer.
+
+  @compatibility(TF2)
+  This API is not compatible with eager execution or `tf.function`.
+
+  Please refer to [tf.layers section of the migration guide]
+  (https://www.tensorflow.org/guide/migrate#models_based_on_tflayers)
+  to migrate a TensorFlow v1 model to Keras. The corresponding TensorFlow v2
+  layer is `tf.keras.layers.Conv1D`.
+
+
+  #### Structural Mapping to Native TF2
+
+  None of the supported arguments have changed name.
+
+  Before:
+
+  ```python
+   conv = tf.compat.v1.layers.Conv1D(filters=3, kernel_size=3)
+  ```
+
+  After:
+
+  ```python
+   conv = tf.keras.layers.Conv1D(filters=3, kernels_size=3)
+  ```
+  @end_compatibility
   """
 
   def __init__(self, filters,
@@ -201,6 +227,38 @@ def conv1d(inputs,
 
   Raises:
     ValueError: if eager execution is enabled.
+
+
+  @compatibility(TF2)
+  This API is not compatible with eager execution or `tf.function`.
+
+  Please refer to [tf.layers section of the migration guide]
+  (https://www.tensorflow.org/guide/migrate#models_based_on_tflayers)
+  to migrate a TensorFlow v1 model to Keras. The corresponding TensorFlow v2
+  layer is `tf.keras.layers.Conv1D`.
+
+
+  #### Structural Mapping to Native TF2
+
+  None of the supported arguments have changed name.
+
+  Before:
+
+  ```python
+   y = tf.compat.v1.layers.conv1d(x, filters=3, kernel_size=3)
+  ```
+
+  After:
+
+  To migrate code using TF1 functional layers use the [Keras Functional API]
+  (https://www.tensorflow.org/guide/keras/functional):
+
+  ```python
+   x = tf.keras.Input((28, 28, 1))
+   y = tf.keras.layers.Conv1D(filters=3, kernels_size=3)(x)
+   model = tf.keras.Model(x, y)
+  ```
+  @end_compatibility
   """
   warnings.warn('`tf.layers.conv1d` is deprecated and '
                 'will be removed in a future version. '
@@ -288,6 +346,33 @@ class Conv2D(keras_layers.Conv2D, base.Layer):
     trainable: Boolean, if `True` also add variables to the graph collection
       `GraphKeys.TRAINABLE_VARIABLES` (see `tf.Variable`).
     name: A string, the name of the layer.
+
+
+  @compatibility(TF2)
+  This API is not compatible with eager execution or `tf.function`.
+
+  Please refer to [tf.layers section of the migration guide]
+  (https://www.tensorflow.org/guide/migrate#models_based_on_tflayers)
+  to migrate a TensorFlow v1 model to Keras. The corresponding TensorFlow v2
+  layer is `tf.keras.layers.Conv2D`.
+
+
+  #### Structural Mapping to Native TF2
+
+  None of the supported arguments have changed name.
+
+  Before:
+
+  ```python
+   conv = tf.compat.v1.layers.Conv2D(filters=3, kernel_size=3)
+  ```
+
+  After:
+
+  ```python
+   conv = tf.keras.layers.Conv2D(filters=3, kernels_size=3)
+  ```
+  @end_compatibility
   """
 
   def __init__(self, filters,
@@ -415,6 +500,38 @@ def conv2d(inputs,
 
   Raises:
     ValueError: if eager execution is enabled.
+
+
+  @compatibility(TF2)
+  This API is not compatible with eager execution or `tf.function`.
+
+  Please refer to [tf.layers section of the migration guide]
+  (https://www.tensorflow.org/guide/migrate#models_based_on_tflayers)
+  to migrate a TensorFlow v1 model to Keras. The corresponding TensorFlow v2
+  layer is `tf.keras.layers.Conv2D`.
+
+
+  #### Structural Mapping to Native TF2
+
+  None of the supported arguments have changed name.
+
+  Before:
+
+  ```python
+   y = tf.compat.v1.layers.conv2d(x, filters=3, kernel_size=3)
+  ```
+
+  After:
+
+  To migrate code using TF1 functional layers use the [Keras Functional API]
+  (https://www.tensorflow.org/guide/keras/functional):
+
+  ```python
+   x = tf.keras.Input((28, 28, 1))
+   y = tf.keras.layers.Conv2D(filters=3, kernels_size=3)(x)
+   model = tf.keras.Model(x, y)
+  ```
+  @end_compatibility
   """
   warnings.warn('`tf.layers.conv2d` is deprecated and '
                 'will be removed in a future version. '
@@ -503,6 +620,33 @@ class Conv3D(keras_layers.Conv3D, base.Layer):
     trainable: Boolean, if `True` also add variables to the graph collection
       `GraphKeys.TRAINABLE_VARIABLES` (see `tf.Variable`).
     name: A string, the name of the layer.
+
+
+  @compatibility(TF2)
+  This API is not compatible with eager execution or `tf.function`.
+
+  Please refer to [tf.layers section of the migration guide]
+  (https://www.tensorflow.org/guide/migrate#models_based_on_tflayers)
+  to migrate a TensorFlow v1 model to Keras. The corresponding TensorFlow v2
+  layer is `tf.keras.layers.Conv3D`.
+
+
+  #### Structural Mapping to Native TF2
+
+  None of the supported arguments have changed name.
+
+  Before:
+
+  ```python
+   conv = tf.compat.v1.layers.Conv3D(filters=3, kernel_size=3)
+  ```
+
+  After:
+
+  ```python
+   conv = tf.keras.layers.Conv3D(filters=3, kernels_size=3)
+  ```
+  @end_compatibility
   """
 
   def __init__(self, filters,
@@ -631,6 +775,38 @@ def conv3d(inputs,
 
   Raises:
     ValueError: if eager execution is enabled.
+
+
+  @compatibility(TF2)
+  This API is not compatible with eager execution or `tf.function`.
+
+  Please refer to [tf.layers section of the migration guide]
+  (https://www.tensorflow.org/guide/migrate#models_based_on_tflayers)
+  to migrate a TensorFlow v1 model to Keras. The corresponding TensorFlow v2
+  layer is `tf.keras.layers.Conv3D`.
+
+
+  #### Structural Mapping to Native TF2
+
+  None of the supported arguments have changed name.
+
+  Before:
+
+  ```python
+   y = tf.compat.v1.layers.conv3d(x, filters=3, kernel_size=3)
+  ```
+
+  After:
+
+  To migrate code using TF1 functional layers use the [Keras Functional API]
+  (https://www.tensorflow.org/guide/keras/functional):
+
+  ```python
+   x = tf.keras.Input((28, 28, 1))
+   y = tf.keras.layers.Conv3D(filters=3, kernels_size=3)(x)
+   model = tf.keras.Model(x, y)
+  ```
+  @end_compatibility
   """
   warnings.warn('`tf.layers.conv3d` is deprecated and '
                 'will be removed in a future version. '
@@ -720,6 +896,33 @@ class SeparableConv1D(keras_layers.SeparableConv1D, base.Layer):
     trainable: Boolean, if `True` also add variables to the graph collection
       `GraphKeys.TRAINABLE_VARIABLES` (see `tf.Variable`).
     name: A string, the name of the layer.
+
+
+  @compatibility(TF2)
+  This API is not compatible with eager execution or `tf.function`.
+
+  Please refer to [tf.layers section of the migration guide]
+  (https://www.tensorflow.org/guide/migrate#models_based_on_tflayers)
+  to migrate a TensorFlow v1 model to Keras. The corresponding TensorFlow v2
+  layer is `tf.keras.layers.SeparableConv1D`.
+
+
+  #### Structural Mapping to Native TF2
+
+  None of the supported arguments have changed name.
+
+  Before:
+
+  ```python
+   conv = tf.compat.v1.layers.SeparableConv1D(filters=3, kernel_size=3)
+  ```
+
+  After:
+
+  ```python
+   conv = tf.keras.layers.SeparableConv1D(filters=3, kernels_size=3)
+  ```
+  @end_compatibility
   """
 
   def __init__(self, filters,
@@ -836,6 +1039,33 @@ class SeparableConv2D(keras_layers.SeparableConv2D, base.Layer):
     trainable: Boolean, if `True` also add variables to the graph collection
       `GraphKeys.TRAINABLE_VARIABLES` (see `tf.Variable`).
     name: A string, the name of the layer.
+
+
+  @compatibility(TF2)
+  This API is not compatible with eager execution or `tf.function`.
+
+  Please refer to [tf.layers section of the migration guide]
+  (https://www.tensorflow.org/guide/migrate#models_based_on_tflayers)
+  to migrate a TensorFlow v1 model to Keras. The corresponding TensorFlow v2
+  layer is `tf.keras.layers.SeparableConv2D`.
+
+
+  #### Structural Mapping to Native TF2
+
+  None of the supported arguments have changed name.
+
+  Before:
+
+  ```python
+   conv = tf.compat.v1.layers.SeparableConv2D(filters=3, kernel_size=3)
+  ```
+
+  After:
+
+  ```python
+   conv = tf.keras.layers.SeparableConv2D(filters=3, kernels_size=3)
+  ```
+  @end_compatibility
   """
 
   def __init__(self, filters,
@@ -978,6 +1208,38 @@ def separable_conv1d(inputs,
 
   Raises:
     ValueError: if eager execution is enabled.
+
+
+  @compatibility(TF2)
+  This API is not compatible with eager execution or `tf.function`.
+
+  Please refer to [tf.layers section of the migration guide]
+  (https://www.tensorflow.org/guide/migrate#models_based_on_tflayers)
+  to migrate a TensorFlow v1 model to Keras. The corresponding TensorFlow v2
+  layer is `tf.keras.layers.SeparableConv1D`.
+
+
+  #### Structural Mapping to Native TF2
+
+  None of the supported arguments have changed name.
+
+  Before:
+
+  ```python
+   y = tf.compat.v1.layers.separable_conv1d(x, filters=3, kernel_size=3)
+  ```
+
+  After:
+
+  To migrate code using TF1 functional layers use the [Keras Functional API]
+  (https://www.tensorflow.org/guide/keras/functional):
+
+  ```python
+   x = tf.keras.Input((28, 28, 1))
+   y = tf.keras.layers.SeparableConv1D(filters=3, kernels_size=3)(x)
+   model = tf.keras.Model(x, y)
+  ```
+  @end_compatibility
   """
   warnings.warn('`tf.layers.separable_conv1d` is deprecated and '
                 'will be removed in a future version. '
@@ -1107,6 +1369,38 @@ def separable_conv2d(inputs,
 
   Raises:
     ValueError: if eager execution is enabled.
+
+
+  @compatibility(TF2)
+  This API is not compatible with eager execution or `tf.function`.
+
+  Please refer to [tf.layers section of the migration guide]
+  (https://www.tensorflow.org/guide/migrate#models_based_on_tflayers)
+  to migrate a TensorFlow v1 model to Keras. The corresponding TensorFlow v2
+  layer is `tf.keras.layers.SeparableConv2D`.
+
+
+  #### Structural Mapping to Native TF2
+
+  None of the supported arguments have changed name.
+
+  Before:
+
+  ```python
+   y = tf.compat.v1.layers.separable_conv2d(x, filters=3, kernel_size=3)
+  ```
+
+  After:
+
+  To migrate code using TF1 functional layers use the [Keras Functional API]
+  (https://www.tensorflow.org/guide/keras/functional):
+
+  ```python
+   x = tf.keras.Input((28, 28, 1))
+   y = tf.keras.layers.SeparableConv2D(filters=3, kernels_size=3)(x)
+   model = tf.keras.Model(x, y)
+  ```
+  @end_compatibility
   """
   warnings.warn('`tf.layers.separable_conv2d` is deprecated and '
                 'will be removed in a future version. '
@@ -1188,6 +1482,33 @@ class Conv2DTranspose(keras_layers.Conv2DTranspose, base.Layer):
     trainable: Boolean, if `True` also add variables to the graph collection
       `GraphKeys.TRAINABLE_VARIABLES` (see `tf.Variable`).
     name: A string, the name of the layer.
+
+
+  @compatibility(TF2)
+  This API is not compatible with eager execution or `tf.function`.
+
+  Please refer to [tf.layers section of the migration guide]
+  (https://www.tensorflow.org/guide/migrate#models_based_on_tflayers)
+  to migrate a TensorFlow v1 model to Keras. The corresponding TensorFlow v2
+  layer is `tf.keras.layers.Conv2DTranspose`.
+
+
+  #### Structural Mapping to Native TF2
+
+  None of the supported arguments have changed name.
+
+  Before:
+
+  ```python
+   conv = tf.compat.v1.layers.Conv2DTranspose(filters=3, kernel_size=3)
+  ```
+
+  After:
+
+  ```python
+   conv = tf.keras.layers.Conv2DTranspose(filters=3, kernels_size=3)
+  ```
+  @end_compatibility
   """
 
   def __init__(self, filters,
@@ -1303,6 +1624,38 @@ def conv2d_transpose(inputs,
 
   Raises:
     ValueError: if eager execution is enabled.
+
+
+  @compatibility(TF2)
+  This API is not compatible with eager execution or `tf.function`.
+
+  Please refer to [tf.layers section of the migration guide]
+  (https://www.tensorflow.org/guide/migrate#models_based_on_tflayers)
+  to migrate a TensorFlow v1 model to Keras. The corresponding TensorFlow v2
+  layer is `tf.keras.layers.Conv2DTranspose`.
+
+
+  #### Structural Mapping to Native TF2
+
+  None of the supported arguments have changed name.
+
+  Before:
+
+  ```python
+   y = tf.compat.v1.layers.conv2d_transpose(x, filters=3, kernel_size=3)
+  ```
+
+  After:
+
+  To migrate code using TF1 functional layers use the [Keras Functional API]
+  (https://www.tensorflow.org/guide/keras/functional):
+
+  ```python
+   x = tf.keras.Input((28, 28, 1))
+   y = tf.keras.layers.Conv2DTranspose(filters=3, kernels_size=3)(x)
+   model = tf.keras.Model(x, y)
+  ```
+  @end_compatibility
   """
   warnings.warn('`tf.layers.conv2d_transpose` is deprecated and '
                 'will be removed in a future version. '
@@ -1375,6 +1728,33 @@ class Conv3DTranspose(keras_layers.Conv3DTranspose, base.Layer):
     trainable: Boolean, if `True` also add variables to the graph collection
       `GraphKeys.TRAINABLE_VARIABLES` (see `tf.Variable`).
     name: A string, the name of the layer.
+
+
+  @compatibility(TF2)
+  This API is not compatible with eager execution or `tf.function`.
+
+  Please refer to [tf.layers section of the migration guide]
+  (https://www.tensorflow.org/guide/migrate#models_based_on_tflayers)
+  to migrate a TensorFlow v1 model to Keras. The corresponding TensorFlow v2
+  layer is `tf.keras.layers.Conv3DTranspose`.
+
+
+  #### Structural Mapping to Native TF2
+
+  None of the supported arguments have changed name.
+
+  Before:
+
+  ```python
+   conv = tf.compat.v1.layers.Conv3DTranspose(filters=3, kernel_size=3)
+  ```
+
+  After:
+
+  ```python
+   conv = tf.keras.layers.Conv3DTranspose(filters=3, kernels_size=3)
+  ```
+  @end_compatibility
   """
 
   def __init__(self,
@@ -1485,6 +1865,38 @@ def conv3d_transpose(inputs,
 
   Raises:
     ValueError: if eager execution is enabled.
+
+
+  @compatibility(TF2)
+  This API is not compatible with eager execution or `tf.function`.
+
+  Please refer to [tf.layers section of the migration guide]
+  (https://www.tensorflow.org/guide/migrate#models_based_on_tflayers)
+  to migrate a TensorFlow v1 model to Keras. The corresponding TensorFlow v2
+  layer is `tf.keras.layers.Conv3DTranspose`.
+
+
+  #### Structural Mapping to Native TF2
+
+  None of the supported arguments have changed name.
+
+  Before:
+
+  ```python
+   y = tf.compat.v1.layers.conv3d_transpose(x, filters=3, kernel_size=3)
+  ```
+
+  After:
+
+  To migrate code using TF1 functional layers use the [Keras Functional API]
+  (https://www.tensorflow.org/guide/keras/functional):
+
+  ```python
+   x = tf.keras.Input((28, 28, 1))
+   y = tf.keras.layers.Conv3DTranspose(filters=3, kernels_size=3)(x)
+   model = tf.keras.Model(x, y)
+  ```
+  @end_compatibility
   """
   warnings.warn('`tf.layers.conv3d_transpose` is deprecated and '
                 'will be removed in a future version. '