Expose premade package. Update version to release 0.4.2.

PiperOrigin-RevId: 386338223

Author: HongleiZhuang

tensorflow_ranking/examples/keras/BUILD

@@ -184,7 +184,7 @@ py_library(
         # tensorflow_models/official/core:config_definitions dep,
         # tensorflow_models/official/core:exp_factory dep,
         # tensorflow_models/official/modeling/optimization dep,
-        "//tensorflow_ranking/python/keras/premade:tfrbert_task",
+        "//tensorflow_ranking",
     ],
 )
 

tensorflow_ranking/examples/keras/tfrbert_task_experiments.py

@@ -18,18 +18,17 @@
 from official.core import config_definitions as cfg
 from official.core import exp_factory
 from official.modeling import optimization
-from tensorflow_ranking.python.keras.premade import tfrbert_task
+import tensorflow_ranking as tfr
 
 
 @exp_factory.register_config_factory('tfr_bert')
 def tfrbert_exp() -> cfg.ExperimentConfig:
   """Defines a TFR-BERT experiment."""
   config = cfg.ExperimentConfig(
-      task=tfrbert_task.TFRBertConfig(
-          train_data=tfrbert_task.TFRBertDataConfig(),
-          validation_data=tfrbert_task.TFRBertDataConfig(
-              is_training=False,
-              drop_remainder=False)),
+      task=tfr.keras.premade.TFRBertConfig(
+          train_data=tfr.keras.premade.TFRBertDataConfig(),
+          validation_data=tfr.keras.premade.TFRBertDataConfig(
+              is_training=False, drop_remainder=False)),
       trainer=cfg.TrainerConfig(
           optimizer_config=optimization.OptimizationConfig({
               'optimizer': {

tensorflow_ranking/g3doc/api_docs/python/tfr.md

@@ -56,7 +56,7 @@ library.
 __version__<a id="__version__"></a>
 </td>
 <td>
-`'0.4.1.dev'`
+`'0.4.2.dev'`
 </td>
 </tr>
 </table>

tensorflow_ranking/g3doc/api_docs/python/tfr/_api_cache.json

@@ -3,3 +3,23 @@ redirects:
   to: /ranking/api_docs/python/tfr/keras/canned/DNNRankingNetwork
 - from: /ranking/api_docs/python/tfr/keras/canned/gam/GAMRankingNetwork
   to: /ranking/api_docs/python/tfr/keras/canned/GAMRankingNetwork
+- from: /ranking/api_docs/python/tfr/keras/premade/TensorLike
+  to: /ranking/api_docs/python/tfr/keras/model/TensorLike
+- from: /ranking/api_docs/python/tfr/keras/premade/tfrbert_task/TFRBertConfig
+  to: /ranking/api_docs/python/tfr/keras/premade/TFRBertConfig
+- from: /ranking/api_docs/python/tfr/keras/premade/tfrbert_task/TFRBertDataConfig
+  to: /ranking/api_docs/python/tfr/keras/premade/TFRBertDataConfig
+- from: /ranking/api_docs/python/tfr/keras/premade/tfrbert_task/TFRBertDataLoader
+  to: /ranking/api_docs/python/tfr/keras/premade/TFRBertDataLoader
+- from: /ranking/api_docs/python/tfr/keras/premade/tfrbert_task/TFRBertModelBuilder
+  to: /ranking/api_docs/python/tfr/keras/premade/TFRBertModelBuilder
+- from: /ranking/api_docs/python/tfr/keras/premade/tfrbert_task/TFRBertModelConfig
+  to: /ranking/api_docs/python/tfr/keras/premade/TFRBertModelConfig
+- from: /ranking/api_docs/python/tfr/keras/premade/tfrbert_task/TFRBertScorer
+  to: /ranking/api_docs/python/tfr/keras/premade/TFRBertScorer
+- from: /ranking/api_docs/python/tfr/keras/premade/tfrbert_task/TFRBertTask
+  to: /ranking/api_docs/python/tfr/keras/premade/TFRBertTask
+- from: /ranking/api_docs/python/tfr/keras/premade/tfrbert_task/TensorDict
+  to: /ranking/api_docs/python/tfr/keras/premade/TensorDict
+- from: /ranking/api_docs/python/tfr/keras/premade/tfrbert_task/TensorLike
+  to: /ranking/api_docs/python/tfr/keras/model/TensorLike

tensorflow_ranking/g3doc/api_docs/python/tfr/_redirects.yaml

@@ -279,6 +279,30 @@ toc:
       path: /ranking/api_docs/python/tfr/keras/pipeline/SimpleDatasetBuilder
     - title: SimplePipeline
       path: /ranking/api_docs/python/tfr/keras/pipeline/SimplePipeline
+  - title: premade
+    section:
+    - title: Overview
+      path: /ranking/api_docs/python/tfr/keras/premade
+    - title: TFRBertConfig
+      path: /ranking/api_docs/python/tfr/keras/premade/TFRBertConfig
+    - title: TFRBertDataConfig
+      path: /ranking/api_docs/python/tfr/keras/premade/TFRBertDataConfig
+    - title: TFRBertDataLoader
+      path: /ranking/api_docs/python/tfr/keras/premade/TFRBertDataLoader
+    - title: TFRBertModelBuilder
+      path: /ranking/api_docs/python/tfr/keras/premade/TFRBertModelBuilder
+    - title: TFRBertModelConfig
+      path: /ranking/api_docs/python/tfr/keras/premade/TFRBertModelConfig
+    - title: TFRBertScorer
+      path: /ranking/api_docs/python/tfr/keras/premade/TFRBertScorer
+    - title: TFRBertTask
+      path: /ranking/api_docs/python/tfr/keras/premade/TFRBertTask
+    - title: TensorDict
+      path: /ranking/api_docs/python/tfr/keras/premade/TensorDict
+    - title: tfrbert_task
+      section:
+      - title: Overview
+        path: /ranking/api_docs/python/tfr/keras/premade/tfrbert_task
   - title: saved_model
     section:
     - title: Overview

tensorflow_ranking/g3doc/api_docs/python/tfr/_toc.yaml

@@ -126,6 +126,26 @@
 *   <a href="../tfr/keras/pipeline/PipelineHparams.md"><code>tfr.keras.pipeline.PipelineHparams</code></a>
 *   <a href="../tfr/keras/pipeline/SimpleDatasetBuilder.md"><code>tfr.keras.pipeline.SimpleDatasetBuilder</code></a>
 *   <a href="../tfr/keras/pipeline/SimplePipeline.md"><code>tfr.keras.pipeline.SimplePipeline</code></a>
+*   <a href="../tfr/keras/premade.md"><code>tfr.keras.premade</code></a>
+*   <a href="../tfr/keras/premade/TFRBertConfig.md"><code>tfr.keras.premade.TFRBertConfig</code></a>
+*   <a href="../tfr/keras/premade/TFRBertDataConfig.md"><code>tfr.keras.premade.TFRBertDataConfig</code></a>
+*   <a href="../tfr/keras/premade/TFRBertDataLoader.md"><code>tfr.keras.premade.TFRBertDataLoader</code></a>
+*   <a href="../tfr/keras/premade/TFRBertModelBuilder.md"><code>tfr.keras.premade.TFRBertModelBuilder</code></a>
+*   <a href="../tfr/keras/premade/TFRBertModelConfig.md"><code>tfr.keras.premade.TFRBertModelConfig</code></a>
+*   <a href="../tfr/keras/premade/TFRBertScorer.md"><code>tfr.keras.premade.TFRBertScorer</code></a>
+*   <a href="../tfr/keras/premade/TFRBertTask.md"><code>tfr.keras.premade.TFRBertTask</code></a>
+*   <a href="../tfr/keras/premade/TensorDict.md"><code>tfr.keras.premade.TensorDict</code></a>
+*   <a href="../tfr/keras/model/TensorLike.md"><code>tfr.keras.premade.TensorLike</code></a>
+*   <a href="../tfr/keras/premade/tfrbert_task.md"><code>tfr.keras.premade.tfrbert_task</code></a>
+*   <a href="../tfr/keras/premade/TFRBertConfig.md"><code>tfr.keras.premade.tfrbert_task.TFRBertConfig</code></a>
+*   <a href="../tfr/keras/premade/TFRBertDataConfig.md"><code>tfr.keras.premade.tfrbert_task.TFRBertDataConfig</code></a>
+*   <a href="../tfr/keras/premade/TFRBertDataLoader.md"><code>tfr.keras.premade.tfrbert_task.TFRBertDataLoader</code></a>
+*   <a href="../tfr/keras/premade/TFRBertModelBuilder.md"><code>tfr.keras.premade.tfrbert_task.TFRBertModelBuilder</code></a>
+*   <a href="../tfr/keras/premade/TFRBertModelConfig.md"><code>tfr.keras.premade.tfrbert_task.TFRBertModelConfig</code></a>
+*   <a href="../tfr/keras/premade/TFRBertScorer.md"><code>tfr.keras.premade.tfrbert_task.TFRBertScorer</code></a>
+*   <a href="../tfr/keras/premade/TFRBertTask.md"><code>tfr.keras.premade.tfrbert_task.TFRBertTask</code></a>
+*   <a href="../tfr/keras/premade/TensorDict.md"><code>tfr.keras.premade.tfrbert_task.TensorDict</code></a>
+*   <a href="../tfr/keras/model/TensorLike.md"><code>tfr.keras.premade.tfrbert_task.TensorLike</code></a>
 *   <a href="../tfr/keras/saved_model.md"><code>tfr.keras.saved_model</code></a>
 *   <a href="../tfr/keras/saved_model/Signatures.md"><code>tfr.keras.saved_model.Signatures</code></a>
 *   <a href="../tfr/keras/strategy_utils.md"><code>tfr.keras.strategy_utils</code></a>

tensorflow_ranking/g3doc/api_docs/python/tfr/all_symbols.md

@@ -45,6 +45,9 @@ tfr.keras.
 [`pipeline`](../tfr/keras/pipeline.md) module: Ranking pipeline to train
 tf.keras.Model in tfr.keras.
 
+[`premade`](../tfr/keras/premade.md) module: TensorFlow Ranking Premade Orbit
+Task Module.
+
 [`saved_model`](../tfr/keras/saved_model.md) module: SavedModel utilities for
 TF-Ranking.
 

tensorflow_ranking/g3doc/api_docs/python/tfr/keras.md

@@ -8,7 +8,6 @@ description: The central part of internal API.
 # tfr.keras.model.TensorDict
 
 <!-- Insert buttons and diff -->
-
 This symbol is a **type alias**.
 
 The central part of internal API.

tensorflow_ranking/g3doc/api_docs/python/tfr/keras/model/TensorDict.md

@@ -566,7 +566,6 @@ batch.
 </table>
 
 <!-- Tabular view -->
-
  <table class="responsive fixed orange">
 <colgroup><col width="214px"><col></colgroup>
 <tr><th colspan="2">Returns</th></tr>
@@ -1504,7 +1503,6 @@ the same key to combine in a single batch, which will be passed to
 </table>
 
 <!-- Tabular view -->
-
  <table class="responsive fixed orange">
 <colgroup><col width="214px"><col></colgroup>
 <tr><th colspan="2">Returns</th></tr>
@@ -2499,7 +2497,6 @@ accumulates one or more state tensors, whose initial values are `initial_state`.
 ```
 
 <!-- Tabular view -->
-
  <table class="responsive fixed orange">
 <colgroup><col width="214px"><col></colgroup>
 <tr><th colspan="2">Args</th></tr>
@@ -2526,7 +2523,6 @@ structure of `initial_state`.
 </table>
 
 <!-- Tabular view -->
-
  <table class="responsive fixed orange">
 <colgroup><col width="214px"><col></colgroup>
 <tr><th colspan="2">Returns</th></tr>
@@ -2874,7 +2870,6 @@ By default, snapshot parallelizes reads by the number of cores available on the
 system, but will not attempt to shuffle the data.
 
 <!-- Tabular view -->
-
  <table class="responsive fixed orange">
 <colgroup><col width="214px"><col></colgroup>
 <tr><th colspan="2">Args</th></tr>
@@ -2917,7 +2912,6 @@ a snapshot.
 </table>
 
 <!-- Tabular view -->
-
  <table class="responsive fixed orange">
 <colgroup><col width="214px"><col></colgroup>
 <tr><th colspan="2">Returns</th></tr>
@@ -2997,7 +2991,6 @@ A transformation that stops dataset iteration based on a `predicate`.
 ```
 
 <!-- Tabular view -->
-
  <table class="responsive fixed orange">
 <colgroup><col width="214px"><col></colgroup>
 <tr><th colspan="2">Args</th></tr>
@@ -3015,7 +3008,6 @@ shapes and types defined by `self.output_shapes` and
 </table>
 
 <!-- Tabular view -->
-
  <table class="responsive fixed orange">
 <colgroup><col width="214px"><col></colgroup>
 <tr><th colspan="2">Returns</th></tr>
@@ -3086,7 +3078,6 @@ Note: This transformation only supports datasets which fit into memory and have
 elements of either `tf.int32`, `tf.int64` or `tf.string` type.
 
 <!-- Tabular view -->
-
  <table class="responsive fixed orange">
 <colgroup><col width="214px"><col></colgroup>
 <tr><th colspan="2">Returns</th></tr>