Update version for release 0.3.0

PiperOrigin-RevId: 302554103
tensorflow · Mar 24, 2020 · fa4fd39 · fa4fd39
1 parent 9b67099
commit fa4fd39
Show file tree

Hide file tree

Showing 51 changed files with 9,930 additions and 58 deletions.
diff --git a/tensorflow_ranking/g3doc/api_docs/python/_redirects.yaml b/tensorflow_ranking/g3doc/api_docs/python/_redirects.yaml
@@ -0,0 +1,3 @@
+redirects:
+- from: /ranking/api_docs/python/tfr/keras/canned/dnn/DNNRankingNetwork
+  to: /ranking/api_docs/python/tfr/keras/canned/DNNRankingNetwork
diff --git a/tensorflow_ranking/g3doc/api_docs/python/_toc.yaml b/tensorflow_ranking/g3doc/api_docs/python/_toc.yaml
@@ -33,6 +33,8 @@ toc:
     path: /ranking/api_docs/python/tfr/estimator
   - title: EstimatorBuilder
     path: /ranking/api_docs/python/tfr/estimator/EstimatorBuilder
+  - title: make_dnn_ranking_estimator
+    path: /ranking/api_docs/python/tfr/estimator/make_dnn_ranking_estimator
 - title: tfr.ext
   section:
   - title: Overview
@@ -63,6 +65,98 @@ toc:
     path: /ranking/api_docs/python/tfr/head/create_multi_ranking_head
   - title: create_ranking_head
     path: /ranking/api_docs/python/tfr/head/create_ranking_head
+- title: tfr.keras
+  section:
+  - title: Overview
+    path: /ranking/api_docs/python/tfr/keras
+  - title: canned
+    section:
+    - title: Overview
+      path: /ranking/api_docs/python/tfr/keras/canned
+    - title: DNNRankingNetwork
+      path: /ranking/api_docs/python/tfr/keras/canned/DNNRankingNetwork
+    - title: dnn
+      section:
+      - title: Overview
+        path: /ranking/api_docs/python/tfr/keras/canned/dnn
+  - title: estimator
+    section:
+    - title: Overview
+      path: /ranking/api_docs/python/tfr/keras/estimator
+    - title: model_to_estimator
+      path: /ranking/api_docs/python/tfr/keras/estimator/model_to_estimator
+  - title: feature
+    section:
+    - title: Overview
+      path: /ranking/api_docs/python/tfr/keras/feature
+    - title: create_keras_inputs
+      path: /ranking/api_docs/python/tfr/keras/feature/create_keras_inputs
+    - title: EncodeListwiseFeatures
+      path: /ranking/api_docs/python/tfr/keras/feature/EncodeListwiseFeatures
+    - title: GenerateMask
+      path: /ranking/api_docs/python/tfr/keras/feature/GenerateMask
+  - title: losses
+    section:
+    - title: Overview
+      path: /ranking/api_docs/python/tfr/keras/losses
+    - title: ApproxMRRLoss
+      path: /ranking/api_docs/python/tfr/keras/losses/ApproxMRRLoss
+    - title: ApproxNDCGLoss
+      path: /ranking/api_docs/python/tfr/keras/losses/ApproxNDCGLoss
+    - title: get
+      path: /ranking/api_docs/python/tfr/keras/losses/get
+    - title: GumbelApproxNDCGLoss
+      path: /ranking/api_docs/python/tfr/keras/losses/GumbelApproxNDCGLoss
+    - title: ListMLELoss
+      path: /ranking/api_docs/python/tfr/keras/losses/ListMLELoss
+    - title: MeanSquaredLoss
+      path: /ranking/api_docs/python/tfr/keras/losses/MeanSquaredLoss
+    - title: PairwiseHingeLoss
+      path: /ranking/api_docs/python/tfr/keras/losses/PairwiseHingeLoss
+    - title: PairwiseLogisticLoss
+      path: /ranking/api_docs/python/tfr/keras/losses/PairwiseLogisticLoss
+    - title: PairwiseSoftZeroOneLoss
+      path: /ranking/api_docs/python/tfr/keras/losses/PairwiseSoftZeroOneLoss
+    - title: RankingLossKey
+      path: /ranking/api_docs/python/tfr/keras/losses/RankingLossKey
+    - title: SigmoidCrossEntropyLoss
+      path: /ranking/api_docs/python/tfr/keras/losses/SigmoidCrossEntropyLoss
+    - title: SoftmaxLoss
+      path: /ranking/api_docs/python/tfr/keras/losses/SoftmaxLoss
+  - title: metrics
+    section:
+    - title: Overview
+      path: /ranking/api_docs/python/tfr/keras/metrics
+    - title: ARPMetric
+      path: /ranking/api_docs/python/tfr/keras/metrics/ARPMetric
+    - title: DCGMetric
+      path: /ranking/api_docs/python/tfr/keras/metrics/DCGMetric
+    - title: default_keras_metrics
+      path: /ranking/api_docs/python/tfr/keras/metrics/default_keras_metrics
+    - title: MeanAveragePrecisionMetric
+      path: /ranking/api_docs/python/tfr/keras/metrics/MeanAveragePrecisionMetric
+    - title: MRRMetric
+      path: /ranking/api_docs/python/tfr/keras/metrics/MRRMetric
+    - title: NDCGMetric
+      path: /ranking/api_docs/python/tfr/keras/metrics/NDCGMetric
+    - title: OPAMetric
+      path: /ranking/api_docs/python/tfr/keras/metrics/OPAMetric
+    - title: PrecisionMetric
+      path: /ranking/api_docs/python/tfr/keras/metrics/PrecisionMetric
+  - title: model
+    section:
+    - title: Overview
+      path: /ranking/api_docs/python/tfr/keras/model
+    - title: create_keras_model
+      path: /ranking/api_docs/python/tfr/keras/model/create_keras_model
+  - title: network
+    section:
+    - title: Overview
+      path: /ranking/api_docs/python/tfr/keras/network
+    - title: RankingNetwork
+      path: /ranking/api_docs/python/tfr/keras/network/RankingNetwork
+    - title: UnivariateRankingNetwork
+      path: /ranking/api_docs/python/tfr/keras/network/UnivariateRankingNetwork
 - title: tfr.losses
   section:
   - title: Overview
@@ -121,6 +215,8 @@ toc:
     path: /ranking/api_docs/python/tfr/utils/inverse_max_dcg
   - title: is_label_valid
     path: /ranking/api_docs/python/tfr/utils/is_label_valid
+  - title: ndcg
+    path: /ranking/api_docs/python/tfr/utils/ndcg
   - title: organize_valid_indices
     path: /ranking/api_docs/python/tfr/utils/organize_valid_indices
   - title: padded_nd_indices

diff --git a/tensorflow_ranking/g3doc/api_docs/python/index.md b/tensorflow_ranking/g3doc/api_docs/python/index.md
@@ -16,6 +16,7 @@
 *   <a href="./tfr/data/read_batched_sequence_example_dataset.md"><code>tfr.data.read_batched_sequence_example_dataset</code></a>
 *   <a href="./tfr/estimator.md"><code>tfr.estimator</code></a>
 *   <a href="./tfr/estimator/EstimatorBuilder.md"><code>tfr.estimator.EstimatorBuilder</code></a>
+*   <a href="./tfr/estimator/make_dnn_ranking_estimator.md"><code>tfr.estimator.make_dnn_ranking_estimator</code></a>
 *   <a href="./tfr/ext.md"><code>tfr.ext</code></a>
 *   <a href="./tfr/ext/pipeline.md"><code>tfr.ext.pipeline</code></a>
 *   <a href="./tfr/ext/pipeline/RankingPipeline.md"><code>tfr.ext.pipeline.RankingPipeline</code></a>
@@ -27,6 +28,44 @@
 *   <a href="./tfr/head.md"><code>tfr.head</code></a>
 *   <a href="./tfr/head/create_multi_ranking_head.md"><code>tfr.head.create_multi_ranking_head</code></a>
 *   <a href="./tfr/head/create_ranking_head.md"><code>tfr.head.create_ranking_head</code></a>
+*   <a href="./tfr/keras.md"><code>tfr.keras</code></a>
+*   <a href="./tfr/keras/canned.md"><code>tfr.keras.canned</code></a>
+*   <a href="./tfr/keras/canned/DNNRankingNetwork.md"><code>tfr.keras.canned.DNNRankingNetwork</code></a>
+*   <a href="./tfr/keras/canned/dnn.md"><code>tfr.keras.canned.dnn</code></a>
+*   <a href="./tfr/keras/canned/DNNRankingNetwork.md"><code>tfr.keras.canned.dnn.DNNRankingNetwork</code></a>
+*   <a href="./tfr/keras/estimator.md"><code>tfr.keras.estimator</code></a>
+*   <a href="./tfr/keras/estimator/model_to_estimator.md"><code>tfr.keras.estimator.model_to_estimator</code></a>
+*   <a href="./tfr/keras/feature.md"><code>tfr.keras.feature</code></a>
+*   <a href="./tfr/keras/feature/EncodeListwiseFeatures.md"><code>tfr.keras.feature.EncodeListwiseFeatures</code></a>
+*   <a href="./tfr/keras/feature/GenerateMask.md"><code>tfr.keras.feature.GenerateMask</code></a>
+*   <a href="./tfr/keras/feature/create_keras_inputs.md"><code>tfr.keras.feature.create_keras_inputs</code></a>
+*   <a href="./tfr/keras/losses.md"><code>tfr.keras.losses</code></a>
+*   <a href="./tfr/keras/losses/ApproxMRRLoss.md"><code>tfr.keras.losses.ApproxMRRLoss</code></a>
+*   <a href="./tfr/keras/losses/ApproxNDCGLoss.md"><code>tfr.keras.losses.ApproxNDCGLoss</code></a>
+*   <a href="./tfr/keras/losses/GumbelApproxNDCGLoss.md"><code>tfr.keras.losses.GumbelApproxNDCGLoss</code></a>
+*   <a href="./tfr/keras/losses/ListMLELoss.md"><code>tfr.keras.losses.ListMLELoss</code></a>
+*   <a href="./tfr/keras/losses/MeanSquaredLoss.md"><code>tfr.keras.losses.MeanSquaredLoss</code></a>
+*   <a href="./tfr/keras/losses/PairwiseHingeLoss.md"><code>tfr.keras.losses.PairwiseHingeLoss</code></a>
+*   <a href="./tfr/keras/losses/PairwiseLogisticLoss.md"><code>tfr.keras.losses.PairwiseLogisticLoss</code></a>
+*   <a href="./tfr/keras/losses/PairwiseSoftZeroOneLoss.md"><code>tfr.keras.losses.PairwiseSoftZeroOneLoss</code></a>
+*   <a href="./tfr/keras/losses/RankingLossKey.md"><code>tfr.keras.losses.RankingLossKey</code></a>
+*   <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/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>
+*   <a href="./tfr/keras/metrics/DCGMetric.md"><code>tfr.keras.metrics.DCGMetric</code></a>
+*   <a href="./tfr/keras/metrics/MRRMetric.md"><code>tfr.keras.metrics.MRRMetric</code></a>
+*   <a href="./tfr/keras/metrics/MeanAveragePrecisionMetric.md"><code>tfr.keras.metrics.MeanAveragePrecisionMetric</code></a>
+*   <a href="./tfr/keras/metrics/NDCGMetric.md"><code>tfr.keras.metrics.NDCGMetric</code></a>
+*   <a href="./tfr/keras/metrics/OPAMetric.md"><code>tfr.keras.metrics.OPAMetric</code></a>
+*   <a href="./tfr/keras/metrics/PrecisionMetric.md"><code>tfr.keras.metrics.PrecisionMetric</code></a>
+*   <a href="./tfr/keras/metrics/default_keras_metrics.md"><code>tfr.keras.metrics.default_keras_metrics</code></a>
+*   <a href="./tfr/keras/model.md"><code>tfr.keras.model</code></a>
+*   <a href="./tfr/keras/model/create_keras_model.md"><code>tfr.keras.model.create_keras_model</code></a>
+*   <a href="./tfr/keras/network.md"><code>tfr.keras.network</code></a>
+*   <a href="./tfr/keras/network/RankingNetwork.md"><code>tfr.keras.network.RankingNetwork</code></a>
+*   <a href="./tfr/keras/network/UnivariateRankingNetwork.md"><code>tfr.keras.network.UnivariateRankingNetwork</code></a>
 *   <a href="./tfr/losses.md"><code>tfr.losses</code></a>
 *   <a href="./tfr/losses/RankingLossKey.md"><code>tfr.losses.RankingLossKey</code></a>
 *   <a href="./tfr/losses/create_ndcg_lambda_weight.md"><code>tfr.losses.create_ndcg_lambda_weight</code></a>
@@ -52,6 +91,7 @@
 *   <a href="./tfr/utils/approx_ranks.md"><code>tfr.utils.approx_ranks</code></a>
 *   <a href="./tfr/utils/inverse_max_dcg.md"><code>tfr.utils.inverse_max_dcg</code></a>
 *   <a href="./tfr/utils/is_label_valid.md"><code>tfr.utils.is_label_valid</code></a>
+*   <a href="./tfr/utils/ndcg.md"><code>tfr.utils.ndcg</code></a>
 *   <a href="./tfr/utils/organize_valid_indices.md"><code>tfr.utils.organize_valid_indices</code></a>
 *   <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>

diff --git a/tensorflow_ranking/g3doc/api_docs/python/tfr.md b/tensorflow_ranking/g3doc/api_docs/python/tfr.md
@@ -33,6 +33,8 @@ library.
 
 [`head`](./tfr/head.md) module: Defines `Head`s of TF ranking models.
 
+[`keras`](./tfr/keras.md) module: TensorFlow Ranking Keras Module.
+
 [`losses`](./tfr/losses.md) module: Defines ranking losses as TF ops.
 
 [`metrics`](./tfr/metrics.md) module: Defines ranking metrics as TF ops.
@@ -43,4 +45,4 @@ library.
 
 ## Other Members
 
-*   `__version__ = '0.2.3.dev'` <a id="__version__"></a>
+*   `__version__ = '0.2.4.dev'` <a id="__version__"></a>