Skip to content
This repository was archived by the owner on May 21, 2025. It is now read-only.

Commit fa4fd39

Browse files
committed
Update version for release 0.3.0
PiperOrigin-RevId: 302554103
1 parent 9b67099 commit fa4fd39

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

51 files changed

+9930
-58
lines changed
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
redirects:
2+
- from: /ranking/api_docs/python/tfr/keras/canned/dnn/DNNRankingNetwork
3+
to: /ranking/api_docs/python/tfr/keras/canned/DNNRankingNetwork

tensorflow_ranking/g3doc/api_docs/python/_toc.yaml

Lines changed: 96 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,8 @@ toc:
3333
path: /ranking/api_docs/python/tfr/estimator
3434
- title: EstimatorBuilder
3535
path: /ranking/api_docs/python/tfr/estimator/EstimatorBuilder
36+
- title: make_dnn_ranking_estimator
37+
path: /ranking/api_docs/python/tfr/estimator/make_dnn_ranking_estimator
3638
- title: tfr.ext
3739
section:
3840
- title: Overview
@@ -63,6 +65,98 @@ toc:
6365
path: /ranking/api_docs/python/tfr/head/create_multi_ranking_head
6466
- title: create_ranking_head
6567
path: /ranking/api_docs/python/tfr/head/create_ranking_head
68+
- title: tfr.keras
69+
section:
70+
- title: Overview
71+
path: /ranking/api_docs/python/tfr/keras
72+
- title: canned
73+
section:
74+
- title: Overview
75+
path: /ranking/api_docs/python/tfr/keras/canned
76+
- title: DNNRankingNetwork
77+
path: /ranking/api_docs/python/tfr/keras/canned/DNNRankingNetwork
78+
- title: dnn
79+
section:
80+
- title: Overview
81+
path: /ranking/api_docs/python/tfr/keras/canned/dnn
82+
- title: estimator
83+
section:
84+
- title: Overview
85+
path: /ranking/api_docs/python/tfr/keras/estimator
86+
- title: model_to_estimator
87+
path: /ranking/api_docs/python/tfr/keras/estimator/model_to_estimator
88+
- title: feature
89+
section:
90+
- title: Overview
91+
path: /ranking/api_docs/python/tfr/keras/feature
92+
- title: create_keras_inputs
93+
path: /ranking/api_docs/python/tfr/keras/feature/create_keras_inputs
94+
- title: EncodeListwiseFeatures
95+
path: /ranking/api_docs/python/tfr/keras/feature/EncodeListwiseFeatures
96+
- title: GenerateMask
97+
path: /ranking/api_docs/python/tfr/keras/feature/GenerateMask
98+
- title: losses
99+
section:
100+
- title: Overview
101+
path: /ranking/api_docs/python/tfr/keras/losses
102+
- title: ApproxMRRLoss
103+
path: /ranking/api_docs/python/tfr/keras/losses/ApproxMRRLoss
104+
- title: ApproxNDCGLoss
105+
path: /ranking/api_docs/python/tfr/keras/losses/ApproxNDCGLoss
106+
- title: get
107+
path: /ranking/api_docs/python/tfr/keras/losses/get
108+
- title: GumbelApproxNDCGLoss
109+
path: /ranking/api_docs/python/tfr/keras/losses/GumbelApproxNDCGLoss
110+
- title: ListMLELoss
111+
path: /ranking/api_docs/python/tfr/keras/losses/ListMLELoss
112+
- title: MeanSquaredLoss
113+
path: /ranking/api_docs/python/tfr/keras/losses/MeanSquaredLoss
114+
- title: PairwiseHingeLoss
115+
path: /ranking/api_docs/python/tfr/keras/losses/PairwiseHingeLoss
116+
- title: PairwiseLogisticLoss
117+
path: /ranking/api_docs/python/tfr/keras/losses/PairwiseLogisticLoss
118+
- title: PairwiseSoftZeroOneLoss
119+
path: /ranking/api_docs/python/tfr/keras/losses/PairwiseSoftZeroOneLoss
120+
- title: RankingLossKey
121+
path: /ranking/api_docs/python/tfr/keras/losses/RankingLossKey
122+
- title: SigmoidCrossEntropyLoss
123+
path: /ranking/api_docs/python/tfr/keras/losses/SigmoidCrossEntropyLoss
124+
- title: SoftmaxLoss
125+
path: /ranking/api_docs/python/tfr/keras/losses/SoftmaxLoss
126+
- title: metrics
127+
section:
128+
- title: Overview
129+
path: /ranking/api_docs/python/tfr/keras/metrics
130+
- title: ARPMetric
131+
path: /ranking/api_docs/python/tfr/keras/metrics/ARPMetric
132+
- title: DCGMetric
133+
path: /ranking/api_docs/python/tfr/keras/metrics/DCGMetric
134+
- title: default_keras_metrics
135+
path: /ranking/api_docs/python/tfr/keras/metrics/default_keras_metrics
136+
- title: MeanAveragePrecisionMetric
137+
path: /ranking/api_docs/python/tfr/keras/metrics/MeanAveragePrecisionMetric
138+
- title: MRRMetric
139+
path: /ranking/api_docs/python/tfr/keras/metrics/MRRMetric
140+
- title: NDCGMetric
141+
path: /ranking/api_docs/python/tfr/keras/metrics/NDCGMetric
142+
- title: OPAMetric
143+
path: /ranking/api_docs/python/tfr/keras/metrics/OPAMetric
144+
- title: PrecisionMetric
145+
path: /ranking/api_docs/python/tfr/keras/metrics/PrecisionMetric
146+
- title: model
147+
section:
148+
- title: Overview
149+
path: /ranking/api_docs/python/tfr/keras/model
150+
- title: create_keras_model
151+
path: /ranking/api_docs/python/tfr/keras/model/create_keras_model
152+
- title: network
153+
section:
154+
- title: Overview
155+
path: /ranking/api_docs/python/tfr/keras/network
156+
- title: RankingNetwork
157+
path: /ranking/api_docs/python/tfr/keras/network/RankingNetwork
158+
- title: UnivariateRankingNetwork
159+
path: /ranking/api_docs/python/tfr/keras/network/UnivariateRankingNetwork
66160
- title: tfr.losses
67161
section:
68162
- title: Overview
@@ -121,6 +215,8 @@ toc:
121215
path: /ranking/api_docs/python/tfr/utils/inverse_max_dcg
122216
- title: is_label_valid
123217
path: /ranking/api_docs/python/tfr/utils/is_label_valid
218+
- title: ndcg
219+
path: /ranking/api_docs/python/tfr/utils/ndcg
124220
- title: organize_valid_indices
125221
path: /ranking/api_docs/python/tfr/utils/organize_valid_indices
126222
- title: padded_nd_indices

tensorflow_ranking/g3doc/api_docs/python/index.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@
1616
* <a href="./tfr/data/read_batched_sequence_example_dataset.md"><code>tfr.data.read_batched_sequence_example_dataset</code></a>
1717
* <a href="./tfr/estimator.md"><code>tfr.estimator</code></a>
1818
* <a href="./tfr/estimator/EstimatorBuilder.md"><code>tfr.estimator.EstimatorBuilder</code></a>
19+
* <a href="./tfr/estimator/make_dnn_ranking_estimator.md"><code>tfr.estimator.make_dnn_ranking_estimator</code></a>
1920
* <a href="./tfr/ext.md"><code>tfr.ext</code></a>
2021
* <a href="./tfr/ext/pipeline.md"><code>tfr.ext.pipeline</code></a>
2122
* <a href="./tfr/ext/pipeline/RankingPipeline.md"><code>tfr.ext.pipeline.RankingPipeline</code></a>
@@ -27,6 +28,44 @@
2728
* <a href="./tfr/head.md"><code>tfr.head</code></a>
2829
* <a href="./tfr/head/create_multi_ranking_head.md"><code>tfr.head.create_multi_ranking_head</code></a>
2930
* <a href="./tfr/head/create_ranking_head.md"><code>tfr.head.create_ranking_head</code></a>
31+
* <a href="./tfr/keras.md"><code>tfr.keras</code></a>
32+
* <a href="./tfr/keras/canned.md"><code>tfr.keras.canned</code></a>
33+
* <a href="./tfr/keras/canned/DNNRankingNetwork.md"><code>tfr.keras.canned.DNNRankingNetwork</code></a>
34+
* <a href="./tfr/keras/canned/dnn.md"><code>tfr.keras.canned.dnn</code></a>
35+
* <a href="./tfr/keras/canned/DNNRankingNetwork.md"><code>tfr.keras.canned.dnn.DNNRankingNetwork</code></a>
36+
* <a href="./tfr/keras/estimator.md"><code>tfr.keras.estimator</code></a>
37+
* <a href="./tfr/keras/estimator/model_to_estimator.md"><code>tfr.keras.estimator.model_to_estimator</code></a>
38+
* <a href="./tfr/keras/feature.md"><code>tfr.keras.feature</code></a>
39+
* <a href="./tfr/keras/feature/EncodeListwiseFeatures.md"><code>tfr.keras.feature.EncodeListwiseFeatures</code></a>
40+
* <a href="./tfr/keras/feature/GenerateMask.md"><code>tfr.keras.feature.GenerateMask</code></a>
41+
* <a href="./tfr/keras/feature/create_keras_inputs.md"><code>tfr.keras.feature.create_keras_inputs</code></a>
42+
* <a href="./tfr/keras/losses.md"><code>tfr.keras.losses</code></a>
43+
* <a href="./tfr/keras/losses/ApproxMRRLoss.md"><code>tfr.keras.losses.ApproxMRRLoss</code></a>
44+
* <a href="./tfr/keras/losses/ApproxNDCGLoss.md"><code>tfr.keras.losses.ApproxNDCGLoss</code></a>
45+
* <a href="./tfr/keras/losses/GumbelApproxNDCGLoss.md"><code>tfr.keras.losses.GumbelApproxNDCGLoss</code></a>
46+
* <a href="./tfr/keras/losses/ListMLELoss.md"><code>tfr.keras.losses.ListMLELoss</code></a>
47+
* <a href="./tfr/keras/losses/MeanSquaredLoss.md"><code>tfr.keras.losses.MeanSquaredLoss</code></a>
48+
* <a href="./tfr/keras/losses/PairwiseHingeLoss.md"><code>tfr.keras.losses.PairwiseHingeLoss</code></a>
49+
* <a href="./tfr/keras/losses/PairwiseLogisticLoss.md"><code>tfr.keras.losses.PairwiseLogisticLoss</code></a>
50+
* <a href="./tfr/keras/losses/PairwiseSoftZeroOneLoss.md"><code>tfr.keras.losses.PairwiseSoftZeroOneLoss</code></a>
51+
* <a href="./tfr/keras/losses/RankingLossKey.md"><code>tfr.keras.losses.RankingLossKey</code></a>
52+
* <a href="./tfr/keras/losses/SigmoidCrossEntropyLoss.md"><code>tfr.keras.losses.SigmoidCrossEntropyLoss</code></a>
53+
* <a href="./tfr/keras/losses/SoftmaxLoss.md"><code>tfr.keras.losses.SoftmaxLoss</code></a>
54+
* <a href="./tfr/keras/losses/get.md"><code>tfr.keras.losses.get</code></a>
55+
* <a href="./tfr/keras/metrics.md"><code>tfr.keras.metrics</code></a>
56+
* <a href="./tfr/keras/metrics/ARPMetric.md"><code>tfr.keras.metrics.ARPMetric</code></a>
57+
* <a href="./tfr/keras/metrics/DCGMetric.md"><code>tfr.keras.metrics.DCGMetric</code></a>
58+
* <a href="./tfr/keras/metrics/MRRMetric.md"><code>tfr.keras.metrics.MRRMetric</code></a>
59+
* <a href="./tfr/keras/metrics/MeanAveragePrecisionMetric.md"><code>tfr.keras.metrics.MeanAveragePrecisionMetric</code></a>
60+
* <a href="./tfr/keras/metrics/NDCGMetric.md"><code>tfr.keras.metrics.NDCGMetric</code></a>
61+
* <a href="./tfr/keras/metrics/OPAMetric.md"><code>tfr.keras.metrics.OPAMetric</code></a>
62+
* <a href="./tfr/keras/metrics/PrecisionMetric.md"><code>tfr.keras.metrics.PrecisionMetric</code></a>
63+
* <a href="./tfr/keras/metrics/default_keras_metrics.md"><code>tfr.keras.metrics.default_keras_metrics</code></a>
64+
* <a href="./tfr/keras/model.md"><code>tfr.keras.model</code></a>
65+
* <a href="./tfr/keras/model/create_keras_model.md"><code>tfr.keras.model.create_keras_model</code></a>
66+
* <a href="./tfr/keras/network.md"><code>tfr.keras.network</code></a>
67+
* <a href="./tfr/keras/network/RankingNetwork.md"><code>tfr.keras.network.RankingNetwork</code></a>
68+
* <a href="./tfr/keras/network/UnivariateRankingNetwork.md"><code>tfr.keras.network.UnivariateRankingNetwork</code></a>
3069
* <a href="./tfr/losses.md"><code>tfr.losses</code></a>
3170
* <a href="./tfr/losses/RankingLossKey.md"><code>tfr.losses.RankingLossKey</code></a>
3271
* <a href="./tfr/losses/create_ndcg_lambda_weight.md"><code>tfr.losses.create_ndcg_lambda_weight</code></a>
@@ -52,6 +91,7 @@
5291
* <a href="./tfr/utils/approx_ranks.md"><code>tfr.utils.approx_ranks</code></a>
5392
* <a href="./tfr/utils/inverse_max_dcg.md"><code>tfr.utils.inverse_max_dcg</code></a>
5493
* <a href="./tfr/utils/is_label_valid.md"><code>tfr.utils.is_label_valid</code></a>
94+
* <a href="./tfr/utils/ndcg.md"><code>tfr.utils.ndcg</code></a>
5595
* <a href="./tfr/utils/organize_valid_indices.md"><code>tfr.utils.organize_valid_indices</code></a>
5696
* <a href="./tfr/utils/padded_nd_indices.md"><code>tfr.utils.padded_nd_indices</code></a>
5797
* <a href="./tfr/utils/reshape_first_ndims.md"><code>tfr.utils.reshape_first_ndims</code></a>

tensorflow_ranking/g3doc/api_docs/python/tfr.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,8 @@ library.
3333

3434
[`head`](./tfr/head.md) module: Defines `Head`s of TF ranking models.
3535

36+
[`keras`](./tfr/keras.md) module: TensorFlow Ranking Keras Module.
37+
3638
[`losses`](./tfr/losses.md) module: Defines ranking losses as TF ops.
3739

3840
[`metrics`](./tfr/metrics.md) module: Defines ranking metrics as TF ops.
@@ -43,4 +45,4 @@ library.
4345

4446
## Other Members
4547

46-
* `__version__ = '0.2.3.dev'` <a id="__version__"></a>
48+
* `__version__ = '0.2.4.dev'` <a id="__version__"></a>

0 commit comments

Comments
 (0)