Update documentations for release 0.3.2

PiperOrigin-RevId: 327495616
tensorflow · Aug 19, 2020 · 1ee0788 · 1ee0788
1 parent ea25132
commit 1ee0788
Show file tree

Hide file tree

Showing 85 changed files with 8 additions and 697 deletions.
diff --git a/tensorflow_ranking/g3doc/api_docs/python/_toc.yaml b/tensorflow_ranking/g3doc/api_docs/python/_toc.yaml
@@ -255,10 +255,6 @@ toc:
     path: /ranking/api_docs/python/tfr/utils/reshape_first_ndims
   - title: reshape_to_2d
     path: /ranking/api_docs/python/tfr/utils/reshape_to_2d
-  - title: scatter_to_2d
-    path: /ranking/api_docs/python/tfr/utils/scatter_to_2d
-  - title: segment_sorted_ranks
-    path: /ranking/api_docs/python/tfr/utils/segment_sorted_ranks
   - title: shuffle_valid_indices
     path: /ranking/api_docs/python/tfr/utils/shuffle_valid_indices
   - title: sorted_ranks

diff --git a/tensorflow_ranking/g3doc/api_docs/python/index.md b/tensorflow_ranking/g3doc/api_docs/python/index.md
@@ -112,8 +112,6 @@
 *   <a href="./tfr/utils/padded_nd_indices.md"><code>tfr.utils.padded_nd_indices</code></a>
 *   <a href="./tfr/utils/reshape_first_ndims.md"><code>tfr.utils.reshape_first_ndims</code></a>
 *   <a href="./tfr/utils/reshape_to_2d.md"><code>tfr.utils.reshape_to_2d</code></a>
-*   <a href="./tfr/utils/scatter_to_2d.md"><code>tfr.utils.scatter_to_2d</code></a>
-*   <a href="./tfr/utils/segment_sorted_ranks.md"><code>tfr.utils.segment_sorted_ranks</code></a>
 *   <a href="./tfr/utils/shuffle_valid_indices.md"><code>tfr.utils.shuffle_valid_indices</code></a>
 *   <a href="./tfr/utils/sort_by_scores.md"><code>tfr.utils.sort_by_scores</code></a>
 *   <a href="./tfr/utils/sorted_ranks.md"><code>tfr.utils.sorted_ranks</code></a>
diff --git a/tensorflow_ranking/g3doc/api_docs/python/tfr/_api_cache.json b/tensorflow_ranking/g3doc/api_docs/python/tfr/_api_cache.json
@@ -1978,8 +1978,6 @@
     "tfr.utils.print_function": true,
     "tfr.utils.reshape_first_ndims": false,
     "tfr.utils.reshape_to_2d": false,
-    "tfr.utils.scatter_to_2d": false,
-    "tfr.utils.segment_sorted_ranks": false,
     "tfr.utils.shuffle_valid_indices": false,
     "tfr.utils.sort_by_scores": false,
     "tfr.utils.sorted_ranks": false

diff --git a/tensorflow_ranking/g3doc/api_docs/python/tfr/data/build_ranking_dataset.md b/tensorflow_ranking/g3doc/api_docs/python/tfr/data/build_ranking_dataset.md
@@ -30,7 +30,6 @@ Builds a ranking tf.dataset with a standard data format.
 <!-- 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>
@@ -114,7 +113,6 @@ The kwargs passed to `build_ranking_dataset_with_parsing_fn`.
 </table>
 
 <!-- Tabular view -->
-
  <table class="responsive fixed orange">
 <colgroup><col width="214px"><col></colgroup>
 <tr><th colspan="2"><h2 class="add-link">Returns</h2></th></tr>

diff --git a/...ranking/g3doc/api_docs/python/tfr/data/build_ranking_dataset_with_parsing_fn.md b/...ranking/g3doc/api_docs/python/tfr/data/build_ranking_dataset_with_parsing_fn.md
@@ -32,7 +32,6 @@ Builds a ranking tf.dataset using the provided `parsing_fn`.
 <!-- 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>
@@ -157,7 +156,6 @@ dataset.map() when invoking parsing_fn. Defaults to auto-tune.
 </table>
 
 <!-- Tabular view -->
-
  <table class="responsive fixed orange">
 <colgroup><col width="214px"><col></colgroup>
 <tr><th colspan="2"><h2 class="add-link">Returns</h2></th></tr>

diff --git a/...nking/g3doc/api_docs/python/tfr/data/build_ranking_serving_input_receiver_fn.md b/...nking/g3doc/api_docs/python/tfr/data/build_ranking_serving_input_receiver_fn.md
@@ -30,7 +30,6 @@ Returns a serving input receiver fn for a standard data format.
 <!-- 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>
@@ -96,7 +95,6 @@ unset for variable batch size (recommended).
 </table>
 
 <!-- Tabular view -->
-
  <table class="responsive fixed orange">
 <colgroup><col width="214px"><col></colgroup>
 <tr><th colspan="2"><h2 class="add-link">Returns</h2></th></tr>

diff --git a/...docs/python/tfr/data/build_ranking_serving_input_receiver_fn_with_parsing_fn.md b/...docs/python/tfr/data/build_ranking_serving_input_receiver_fn_with_parsing_fn.md
@@ -28,7 +28,6 @@ Returns a receiver function with the provided `parsing_fn`.
 <!-- 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>
@@ -61,7 +60,6 @@ unset for variable batch size (recommended).
 </table>
 
 <!-- Tabular view -->
-
  <table class="responsive fixed orange">
 <colgroup><col width="214px"><col></colgroup>
 <tr><th colspan="2"><h2 class="add-link">Returns</h2></th></tr>

diff --git a/...oc/api_docs/python/tfr/data/build_sequence_example_serving_input_receiver_fn.md b/...oc/api_docs/python/tfr/data/build_sequence_example_serving_input_receiver_fn.md
@@ -32,7 +32,6 @@ example_feature_spec shouldn't contain weights, labels or training only features
 in general.
 
 <!-- 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>
@@ -74,7 +73,6 @@ unset for variable batch size (recommended).
 </table>
 
 <!-- Tabular view -->
-
  <table class="responsive fixed orange">
 <colgroup><col width="214px"><col></colgroup>
 <tr><th colspan="2"><h2 class="add-link">Returns</h2></th></tr>

diff --git a/tensorflow_ranking/g3doc/api_docs/python/tfr/data/make_parsing_fn.md b/tensorflow_ranking/g3doc/api_docs/python/tfr/data/make_parsing_fn.md
@@ -30,7 +30,6 @@ Returns a parsing fn for a standard data format.
 <!-- 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>
@@ -97,7 +96,6 @@ list are shuffled before the list is trimmed down to list_size elements
 </table>
 
 <!-- Tabular view -->
-
  <table class="responsive fixed orange">
 <colgroup><col width="214px"><col></colgroup>
 <tr><th colspan="2"><h2 class="add-link">Returns</h2></th></tr>

diff --git a/tensorflow_ranking/g3doc/api_docs/python/tfr/data/parse_from_example_in_example.md b/tensorflow_ranking/g3doc/api_docs/python/tfr/data/parse_from_example_in_example.md
@@ -152,7 +152,6 @@ And the expected output is:
 ```
 
 <!-- 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>
@@ -222,7 +221,6 @@ list are shuffled before the list is trimmed down to list_size elements
 </table>
 
 <!-- Tabular view -->
-
  <table class="responsive fixed orange">
 <colgroup><col width="214px"><col></colgroup>
 <tr><th colspan="2"><h2 class="add-link">Returns</h2></th></tr>

diff --git a/tensorflow_ranking/g3doc/api_docs/python/tfr/data/parse_from_example_list.md b/tensorflow_ranking/g3doc/api_docs/python/tfr/data/parse_from_example_list.md
@@ -132,7 +132,6 @@ And the expected output is:
 ```
 
 <!-- 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>
@@ -202,7 +201,6 @@ list are shuffled before the list is trimmed down to list_size elements
 </table>
 
 <!-- Tabular view -->
-
  <table class="responsive fixed orange">
 <colgroup><col width="214px"><col></colgroup>
 <tr><th colspan="2"><h2 class="add-link">Returns</h2></th></tr>

diff --git a/tensorflow_ranking/g3doc/api_docs/python/tfr/data/parse_from_sequence_example.md b/tensorflow_ranking/g3doc/api_docs/python/tfr/data/parse_from_sequence_example.md
@@ -124,7 +124,6 @@ And the expected output is:
 ```
 
 <!-- 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>
@@ -196,7 +195,6 @@ list are shuffled before the list is trimmed down to list_size elements
 </table>
 
 <!-- Tabular view -->
-
  <table class="responsive fixed orange">
 <colgroup><col width="214px"><col></colgroup>
 <tr><th colspan="2"><h2 class="add-link">Returns</h2></th></tr>

diff --git a/...ranking/g3doc/api_docs/python/tfr/data/read_batched_sequence_example_dataset.md b/...ranking/g3doc/api_docs/python/tfr/data/read_batched_sequence_example_dataset.md
@@ -114,7 +114,6 @@ And the expected output is:
 ```
 
 <!-- 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>
@@ -249,7 +248,6 @@ Defaults to `False`. If `True`, the batch_size can be statically inferred.
 </table>
 
 <!-- Tabular view -->
-
  <table class="responsive fixed orange">
 <colgroup><col width="214px"><col></colgroup>
 <tr><th colspan="2"><h2 class="add-link">Returns</h2></th></tr>

diff --git a/tensorflow_ranking/g3doc/api_docs/python/tfr/estimator/EstimatorBuilder.md b/tensorflow_ranking/g3doc/api_docs/python/tfr/estimator/EstimatorBuilder.md
@@ -90,7 +90,6 @@ If you really need to overwrite other functions, particularly `_transform_fn`,
 parameters might no longer be used.
 
 <!-- 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>
@@ -169,7 +168,6 @@ type. See type definition in the `tf.compat.v1.losses.Reduction`.
 </table>
 
 <!-- Tabular view -->
-
  <table class="responsive fixed orange">
 <colgroup><col width="214px"><col></colgroup>
 <tr><th colspan="2"><h2 class="add-link">Raises</h2></th></tr>

diff --git a/tensorflow_ranking/g3doc/api_docs/python/tfr/estimator/GAMEstimatorBuilder.md b/tensorflow_ranking/g3doc/api_docs/python/tfr/estimator/GAMEstimatorBuilder.md
@@ -64,7 +64,6 @@ n-dimensional vector and can be retrieved by tensor named
 `{feature_name}_subweight`.
 
 <!-- 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>
@@ -143,7 +142,6 @@ type. See type definition in the `tf.compat.v1.losses.Reduction`.
 </table>
 
 <!-- Tabular view -->
-
  <table class="responsive fixed orange">
 <colgroup><col width="214px"><col></colgroup>
 <tr><th colspan="2"><h2 class="add-link">Raises</h2></th></tr>

diff --git a/...rflow_ranking/g3doc/api_docs/python/tfr/estimator/make_dnn_ranking_estimator.md b/...rflow_ranking/g3doc/api_docs/python/tfr/estimator/make_dnn_ranking_estimator.md
@@ -34,7 +34,6 @@ Builds an `Estimator` instance with DNN scoring function.
 <!-- 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>
@@ -160,7 +159,6 @@ continue training a previously saved model.
 </table>
 
 <!-- Tabular view -->
-
  <table class="responsive fixed orange">
 <colgroup><col width="214px"><col></colgroup>
 <tr><th colspan="2"><h2 class="add-link">Returns</h2></th></tr>

diff --git a/...rflow_ranking/g3doc/api_docs/python/tfr/estimator/make_gam_ranking_estimator.md b/...rflow_ranking/g3doc/api_docs/python/tfr/estimator/make_gam_ranking_estimator.md
@@ -36,7 +36,6 @@ Builds an `Estimator` instance with GAM scoring function.
 See the comment of `GAMEstimatorBuilder` class for more details.
 
 <!-- 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>
@@ -166,7 +165,6 @@ continue training a previously saved model.
 </table>
 
 <!-- Tabular view -->
-
  <table class="responsive fixed orange">
 <colgroup><col width="214px"><col></colgroup>
 <tr><th colspan="2"><h2 class="add-link">Returns</h2></th></tr>

diff --git a/tensorflow_ranking/g3doc/api_docs/python/tfr/ext/pipeline/RankingPipeline.md b/tensorflow_ranking/g3doc/api_docs/python/tfr/ext/pipeline/RankingPipeline.md
@@ -131,7 +131,6 @@ ranking_pipeline.train_and_eval()
 ```
 
 <!-- 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>