Update version for release 0.5.3

PiperOrigin-RevId: 537460867
tensorflow · Jun 3, 2023 · c46cede · c46cede
1 parent 28ff425
commit c46cede
Show file tree

Hide file tree

Showing 72 changed files with 2,745 additions and 1,985 deletions.
diff --git a/docs/api_docs/python/tfr/_api_cache.json b/docs/api_docs/python/tfr/_api_cache.json
diff --git a/docs/api_docs/python/tfr/_toc.yaml b/docs/api_docs/python/tfr/_toc.yaml
@@ -153,6 +153,10 @@ toc:
       path: /ranking/api_docs/python/tfr/keras/losses/SoftmaxLoss
     - title: UniqueSoftmaxLoss
       path: /ranking/api_docs/python/tfr/keras/losses/UniqueSoftmaxLoss
+    - title: YetiDCGLambdaWeight
+      path: /ranking/api_docs/python/tfr/keras/losses/YetiDCGLambdaWeight
+    - title: YetiLogisticLoss
+      path: /ranking/api_docs/python/tfr/keras/losses/YetiLogisticLoss
     - title: get
       path: /ranking/api_docs/python/tfr/keras/losses/get
   - title: metrics
@@ -273,6 +277,8 @@ toc:
       path: /ranking/api_docs/python/tfr/keras/utils
     - title: GainFunction
       path: /ranking/api_docs/python/tfr/keras/utils/GainFunction
+    - title: deserialize_keras_object
+      path: /ranking/api_docs/python/tfr/keras/utils/deserialize_keras_object
     - title: identity
       path: /ranking/api_docs/python/tfr/keras/utils/identity
     - title: inverse
@@ -283,6 +289,8 @@ toc:
       path: /ranking/api_docs/python/tfr/keras/utils/log2_inverse
     - title: pow_minus_1
       path: /ranking/api_docs/python/tfr/keras/utils/pow_minus_1
+    - title: serialize_keras_object
+      path: /ranking/api_docs/python/tfr/keras/utils/serialize_keras_object
     - title: symmetric_log1p
       path: /ranking/api_docs/python/tfr/keras/utils/symmetric_log1p
 - title: tfr.utils

diff --git a/docs/api_docs/python/tfr/all_symbols.md b/docs/api_docs/python/tfr/all_symbols.md
@@ -81,6 +81,8 @@
 *   <a href="../tfr/keras/losses/SigmoidCrossEntropyLoss.md"><code>tfr.keras.losses.SigmoidCrossEntropyLoss</code></a>
 *   <a href="../tfr/keras/losses/SoftmaxLoss.md"><code>tfr.keras.losses.SoftmaxLoss</code></a>
 *   <a href="../tfr/keras/losses/UniqueSoftmaxLoss.md"><code>tfr.keras.losses.UniqueSoftmaxLoss</code></a>
+*   <a href="../tfr/keras/losses/YetiDCGLambdaWeight.md"><code>tfr.keras.losses.YetiDCGLambdaWeight</code></a>
+*   <a href="../tfr/keras/losses/YetiLogisticLoss.md"><code>tfr.keras.losses.YetiLogisticLoss</code></a>
 *   <a href="../tfr/keras/losses/get.md"><code>tfr.keras.losses.get</code></a>
 *   <a href="../tfr/keras/metrics.md"><code>tfr.keras.metrics</code></a>
 *   <a href="../tfr/keras/metrics/ARPMetric.md"><code>tfr.keras.metrics.ARPMetric</code></a>
@@ -138,11 +140,13 @@
 *   <a href="../tfr/keras/utils/GainFunction.md"><code>tfr.keras.utils.PositiveFunction</code></a>
 *   <a href="../tfr/keras/utils/GainFunction.md"><code>tfr.keras.utils.RankDiscountFunction</code></a>
 *   <a href="../tfr/keras/model/TensorLike.md"><code>tfr.keras.utils.TensorLike</code></a>
+*   <a href="../tfr/keras/utils/deserialize_keras_object.md"><code>tfr.keras.utils.deserialize_keras_object</code></a>
 *   <a href="../tfr/keras/utils/identity.md"><code>tfr.keras.utils.identity</code></a>
 *   <a href="../tfr/keras/utils/inverse.md"><code>tfr.keras.utils.inverse</code></a>
 *   <a href="../tfr/keras/utils/is_greater_equal_1.md"><code>tfr.keras.utils.is_greater_equal_1</code></a>
 *   <a href="../tfr/keras/utils/log2_inverse.md"><code>tfr.keras.utils.log2_inverse</code></a>
 *   <a href="../tfr/keras/utils/pow_minus_1.md"><code>tfr.keras.utils.pow_minus_1</code></a>
+*   <a href="../tfr/keras/utils/serialize_keras_object.md"><code>tfr.keras.utils.serialize_keras_object</code></a>
 *   <a href="../tfr/keras/utils/symmetric_log1p.md"><code>tfr.keras.utils.symmetric_log1p</code></a>
 *   <a href="../tfr/utils.md"><code>tfr.utils</code></a>
 *   <a href="../tfr/utils/LossFunction.md"><code>tfr.utils.LossFunction</code></a>

diff --git a/docs/api_docs/python/tfr/api_report.pb b/docs/api_docs/python/tfr/api_report.pb
diff --git a/docs/api_docs/python/tfr/data/parse_from_example_in_example.md b/docs/api_docs/python/tfr/data/parse_from_example_in_example.md
@@ -146,17 +146,14 @@ And the expected output is:
 
 ```python
 {
-    "unigrams":
-        SparseTensor(
-            indices=array([[0, 0, 0], [0, 1, 0], [0, 1, 1], [0, 1, 2],
-                           [1, 0, 0], [1, 1, 0], [1, 1, 1]]),
-            values=[
-                "tensorflow", "learning", "to", "rank", "gbdt", "neural",
-                "network"
-            ],
-            dense_shape=array([2, 2, 3])),
-    "utility": [[[0.], [1.]], [[0.], [1.]]],
-    "query_length": [[3], [2]],
+  "unigrams": SparseTensor(
+    indices=array([[0, 0, 0], [0, 1, 0], [0, 1, 1], [0, 1, 2], [1, 0, 0],
+      [1, 1, 0], [1, 1, 1]]),
+    values=["tensorflow", "learning", "to", "rank", "gbdt", "neural" ,
+      "network"],
+    dense_shape=array([2, 2, 3])),
+  "utility": [[[ 0.], [ 1.]], [[ 0.], [ 1.]]],
+  "query_length": [[3], [2]],
 }
 ```
 

diff --git a/docs/api_docs/python/tfr/data/parse_from_example_list.md b/docs/api_docs/python/tfr/data/parse_from_example_list.md
@@ -126,17 +126,14 @@ And the expected output is:
 
 ```python
 {
-    "unigrams":
-        SparseTensor(
-            indices=array([[0, 0, 0], [0, 1, 0], [0, 1, 1], [0, 1, 2],
-                           [1, 0, 0], [1, 1, 0], [1, 1, 1]]),
-            values=[
-                "tensorflow", "learning", "to", "rank", "gbdt", "neural",
-                "network"
-            ],
-            dense_shape=array([2, 2, 3])),
-    "utility": [[[0.], [1.]], [[0.], [1.]]],
-    "query_length": [[3], [2]],
+  "unigrams": SparseTensor(
+    indices=array([[0, 0, 0], [0, 1, 0], [0, 1, 1], [0, 1, 2], [1, 0, 0],
+      [1, 1, 0], [1, 1, 1]]),
+    values=["tensorflow", "learning", "to", "rank", "gbdt", "neural" ,
+      "network"],
+    dense_shape=array([2, 2, 3])),
+  "utility": [[[ 0.], [ 1.]], [[ 0.], [ 1.]]],
+  "query_length": [[3], [2]],
 }
 ```
 

diff --git a/docs/api_docs/python/tfr/data/parse_from_sequence_example.md b/docs/api_docs/python/tfr/data/parse_from_sequence_example.md
@@ -119,14 +119,13 @@ And the expected output is:
 
 ```python
 {
-    "unigrams":
-        SparseTensor(
-            indices=array([[0, 0, 0], [0, 1, 0], [0, 1, 1], [0, 1, 2],
-                           [1, 0, 0], [1, 1, 0], [1, 1, 1]]),
-            values=["tensorflow", "learning", "to", "rank", "gbdt"],
-            dense_shape=array([2, 2, 3])),
-    "utility": [[[0.], [1.]], [[0.], [0.]]],
-    "query_length": [[3], [2]],
+  "unigrams": SparseTensor(
+    indices=array([[0, 0, 0], [0, 1, 0], [0, 1, 1], [0, 1, 2], [1, 0, 0], [1,
+    1, 0], [1, 1, 1]]),
+    values=["tensorflow", "learning", "to", "rank", "gbdt"],
+    dense_shape=array([2, 2, 3])),
+  "utility": [[[ 0.], [ 1.]], [[ 0.], [ 0.]]],
+  "query_length": [[3], [2]],
 }
 ```
 

diff --git a/docs/api_docs/python/tfr/extension/premade/TFRBertConfig.md b/docs/api_docs/python/tfr/extension/premade/TFRBertConfig.md
@@ -19,6 +19,7 @@ description: The tf-ranking BERT task config.
 <meta itemprop="property" content="RESERVED_ATTR"/>
 <meta itemprop="property" content="SEQUENCE_TYPES"/>
 <meta itemprop="property" content="aggregated_metrics"/>
+<meta itemprop="property" content="allow_image_summary"/>
 <meta itemprop="property" content="default_params"/>
 <meta itemprop="property" content="differential_privacy_config"/>
 <meta itemprop="property" content="init_checkpoint"/>
@@ -68,6 +69,7 @@ Inherits From:
     validation_data: <a href="../../../tfr/extension/task/RankingDataConfig.md"><code>tfr.extension.task.RankingDataConfig</code></a> = None,
     name: Optional[str] = None,
     differential_privacy_config: Optional[dp_configs.DifferentialPrivacyConfig] = None,
+    allow_image_summary: bool = False,
     loss: str = &#x27;softmax_loss&#x27;,
     loss_reduction: str = tf.keras.losses.Reduction.NONE,
     aggregated_metrics: bool = False,
@@ -78,7 +80,6 @@ Inherits From:
 <!-- Placeholder for "Used in" -->
 
 <!-- Tabular view -->
-
  <table class="responsive fixed orange">
 <colgroup><col width="214px"><col></colgroup>
 <tr><th colspan="2"><h2 class="add-link">Args</h2></th></tr>
@@ -105,7 +106,6 @@ operators, including {'==', '!=',  '<', '<=', '>', '>='}.
 </table>
 
 <!-- Tabular view -->
-
  <table class="responsive fixed orange">
 <colgroup><col width="214px"><col></colgroup>
 <tr><th colspan="2"><h2 class="add-link">Attributes</h2></th></tr>
@@ -171,6 +171,13 @@ Dataclass field
 </td>
 </tr><tr>
 <td>
+`allow_image_summary`<a id="allow_image_summary"></a>
+</td>
+<td>
+Dataclass field
+</td>
+</tr><tr>
+<td>
 `loss`<a id="loss"></a>
 </td>
 <td>
@@ -424,6 +431,13 @@ aggregated_metrics<a id="aggregated_metrics"></a>
 </td>
 </tr><tr>
 <td>
+allow_image_summary<a id="allow_image_summary"></a>
+</td>
+<td>
+`False`
+</td>
+</tr><tr>
+<td>
 default_params<a id="default_params"></a>
 </td>
 <td>

diff --git a/docs/api_docs/python/tfr/extension/premade/TFRBertDataConfig.md b/docs/api_docs/python/tfr/extension/premade/TFRBertDataConfig.md
@@ -19,6 +19,7 @@ description: Data config for TFR-BERT task.
 <meta itemprop="property" content="RESERVED_ATTR"/>
 <meta itemprop="property" content="SEQUENCE_TYPES"/>
 <meta itemprop="property" content="apply_tf_data_service_before_batching"/>
+<meta itemprop="property" content="autotune_algorithm"/>
 <meta itemprop="property" content="block_length"/>
 <meta itemprop="property" content="cache"/>
 <meta itemprop="property" content="convert_labels_to_binary"/>
@@ -107,6 +108,7 @@ Inherits From:
     trainer_id: Optional[str] = None,
     seed: Optional[int] = None,
     prefetch_buffer_size: Optional[int] = None,
+    autotune_algorithm: Optional[str] = None,
     data_format: str = tfr_data.ELWC,
     dataset_fn: str = &#x27;tfrecord&#x27;,
     list_size: Optional[int] = None,
@@ -122,7 +124,6 @@ Inherits From:
 <!-- Placeholder for "Used in" -->
 
 <!-- Tabular view -->
-
  <table class="responsive fixed orange">
 <colgroup><col width="214px"><col></colgroup>
 <tr><th colspan="2"><h2 class="add-link">Args</h2></th></tr>
@@ -149,7 +150,6 @@ operators, including {'==', '!=',  '<', '<=', '>', '>='}.
 </table>
 
 <!-- Tabular view -->
-
  <table class="responsive fixed orange">
 <colgroup><col width="214px"><col></colgroup>
 <tr><th colspan="2"><h2 class="add-link">Attributes</h2></th></tr>
@@ -334,6 +334,13 @@ Dataclass field
 </td>
 </tr><tr>
 <td>
+`autotune_algorithm`<a id="autotune_algorithm"></a>
+</td>
+<td>
+Dataclass field
+</td>
+</tr><tr>
+<td>
 `data_format`<a id="data_format"></a>
 </td>
 <td>
@@ -622,6 +629,13 @@ apply_tf_data_service_before_batching<a id="apply_tf_data_service_before_batchin
 </td>
 </tr><tr>
 <td>
+autotune_algorithm<a id="autotune_algorithm"></a>
+</td>
+<td>
+`None`
+</td>
+</tr><tr>
+<td>
 block_length<a id="block_length"></a>
 </td>
 <td>

diff --git a/docs/api_docs/python/tfr/extension/premade/TFRBertModelConfig.md b/docs/api_docs/python/tfr/extension/premade/TFRBertModelConfig.md
@@ -59,7 +59,6 @@ A TFR-BERT model configuration.
 <!-- Placeholder for "Used in" -->
 
 <!-- Tabular view -->
-
  <table class="responsive fixed orange">
 <colgroup><col width="214px"><col></colgroup>
 <tr><th colspan="2"><h2 class="add-link">Args</h2></th></tr>
@@ -86,7 +85,6 @@ operators, including {'==', '!=',  '<', '<=', '>', '>='}.
 </table>
 
 <!-- Tabular view -->
-
  <table class="responsive fixed orange">
 <colgroup><col width="214px"><col></colgroup>
 <tr><th colspan="2"><h2 class="add-link">Attributes</h2></th></tr>

diff --git a/docs/api_docs/python/tfr/extension/premade/TensorDict.md b/docs/api_docs/python/tfr/extension/premade/TensorDict.md
@@ -6,7 +6,6 @@
 # tfr.extension.premade.TensorDict
 
 <!-- Insert buttons and diff -->
-
 This symbol is a **type alias**.
 
 #### Source:

diff --git a/docs/api_docs/python/tfr/extension/task/FeatureSpec.md b/docs/api_docs/python/tfr/extension/task/FeatureSpec.md
@@ -6,7 +6,6 @@
 # tfr.extension.task.FeatureSpec
 
 <!-- Insert buttons and diff -->
-
 This symbol is a **type alias**.
 
 #### Source:

diff --git a/docs/api_docs/python/tfr/extension/task/RankingDataConfig.md b/docs/api_docs/python/tfr/extension/task/RankingDataConfig.md
@@ -19,6 +19,7 @@ description: Data set config.
 <meta itemprop="property" content="RESERVED_ATTR"/>
 <meta itemprop="property" content="SEQUENCE_TYPES"/>
 <meta itemprop="property" content="apply_tf_data_service_before_batching"/>
+<meta itemprop="property" content="autotune_algorithm"/>
 <meta itemprop="property" content="block_length"/>
 <meta itemprop="property" content="cache"/>
 <meta itemprop="property" content="convert_labels_to_binary"/>
@@ -93,6 +94,7 @@ Data set config.
     trainer_id: Optional[str] = None,
     seed: Optional[int] = None,
     prefetch_buffer_size: Optional[int] = None,
+    autotune_algorithm: Optional[str] = None,
     data_format: str = tfr_data.ELWC,
     dataset_fn: str = &#x27;tfrecord&#x27;,
     list_size: Optional[int] = None,
@@ -105,7 +107,6 @@ Data set config.
 <!-- Placeholder for "Used in" -->
 
 <!-- Tabular view -->
-
  <table class="responsive fixed orange">
 <colgroup><col width="214px"><col></colgroup>
 <tr><th colspan="2"><h2 class="add-link">Args</h2></th></tr>
@@ -132,7 +133,6 @@ operators, including {'==', '!=',  '<', '<=', '>', '>='}.
 </table>
 
 <!-- Tabular view -->
-
  <table class="responsive fixed orange">
 <colgroup><col width="214px"><col></colgroup>
 <tr><th colspan="2"><h2 class="add-link">Attributes</h2></th></tr>
@@ -317,6 +317,13 @@ Dataclass field
 </td>
 </tr><tr>
 <td>
+`autotune_algorithm`<a id="autotune_algorithm"></a>
+</td>
+<td>
+Dataclass field
+</td>
+</tr><tr>
+<td>
 `data_format`<a id="data_format"></a>
 </td>
 <td>
@@ -584,6 +591,13 @@ apply_tf_data_service_before_batching<a id="apply_tf_data_service_before_batchin
 </td>
 </tr><tr>
 <td>
+autotune_algorithm<a id="autotune_algorithm"></a>
+</td>
+<td>
+`None`
+</td>
+</tr><tr>
+<td>
 block_length<a id="block_length"></a>
 </td>
 <td>

diff --git a/docs/api_docs/python/tfr/extension/task/RankingTaskConfig.md b/docs/api_docs/python/tfr/extension/task/RankingTaskConfig.md
@@ -19,6 +19,7 @@ description: The TF-Ranking task config.
 <meta itemprop="property" content="RESERVED_ATTR"/>
 <meta itemprop="property" content="SEQUENCE_TYPES"/>
 <meta itemprop="property" content="aggregated_metrics"/>
+<meta itemprop="property" content="allow_image_summary"/>
 <meta itemprop="property" content="default_params"/>
 <meta itemprop="property" content="differential_privacy_config"/>
 <meta itemprop="property" content="init_checkpoint"/>
@@ -57,6 +58,7 @@ The TF-Ranking task config.
     validation_data: <a href="../../../tfr/extension/task/RankingDataConfig.md"><code>tfr.extension.task.RankingDataConfig</code></a> = None,
     name: Optional[str] = None,
     differential_privacy_config: Optional[dp_configs.DifferentialPrivacyConfig] = None,
+    allow_image_summary: bool = False,
     loss: str = &#x27;softmax_loss&#x27;,
     loss_reduction: str = tf.keras.losses.Reduction.NONE,
     aggregated_metrics: bool = False,
@@ -67,7 +69,6 @@ The TF-Ranking task config.
 <!-- Placeholder for "Used in" -->
 
 <!-- Tabular view -->
-
  <table class="responsive fixed orange">
 <colgroup><col width="214px"><col></colgroup>
 <tr><th colspan="2"><h2 class="add-link">Args</h2></th></tr>
@@ -94,7 +95,6 @@ operators, including {'==', '!=',  '<', '<=', '>', '>='}.
 </table>
 
 <!-- Tabular view -->
-
  <table class="responsive fixed orange">
 <colgroup><col width="214px"><col></colgroup>
 <tr><th colspan="2"><h2 class="add-link">Attributes</h2></th></tr>
@@ -160,6 +160,13 @@ Dataclass field
 </td>
 </tr><tr>
 <td>
+`allow_image_summary`<a id="allow_image_summary"></a>
+</td>
+<td>
+Dataclass field
+</td>
+</tr><tr>
+<td>
 `loss`<a id="loss"></a>
 </td>
 <td>
@@ -413,6 +420,13 @@ aggregated_metrics<a id="aggregated_metrics"></a>
 </td>
 </tr><tr>
 <td>
+allow_image_summary<a id="allow_image_summary"></a>
+</td>
+<td>
+`False`
+</td>
+</tr><tr>
+<td>
 default_params<a id="default_params"></a>
 </td>
 <td>