Skip to content

Commit

Permalink
Update documentations for release 0.3.1
Browse files Browse the repository at this point in the history
PiperOrigin-RevId: 314207991
  • Loading branch information
TensorFlow Ranking authored and HongleiZhuang committed Jun 1, 2020
1 parent 63ad87b commit 99ab8ee
Show file tree
Hide file tree
Showing 109 changed files with 12,999 additions and 4,092 deletions.
2 changes: 2 additions & 0 deletions tensorflow_ranking/g3doc/api_docs/python/_redirects.yaml
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
redirects:
- from: /ranking/api_docs/python/tfr/keras/canned/dnn/DNNRankingNetwork
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
16 changes: 16 additions & 0 deletions tensorflow_ranking/g3doc/api_docs/python/_toc.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -33,8 +33,12 @@ toc:
path: /ranking/api_docs/python/tfr/estimator
- title: EstimatorBuilder
path: /ranking/api_docs/python/tfr/estimator/EstimatorBuilder
- title: GAMEstimatorBuilder
path: /ranking/api_docs/python/tfr/estimator/GAMEstimatorBuilder
- title: make_dnn_ranking_estimator
path: /ranking/api_docs/python/tfr/estimator/make_dnn_ranking_estimator
- title: make_gam_ranking_estimator
path: /ranking/api_docs/python/tfr/estimator/make_gam_ranking_estimator
- title: tfr.ext
section:
- title: Overview
Expand Down Expand Up @@ -75,10 +79,16 @@ toc:
path: /ranking/api_docs/python/tfr/keras/canned
- title: DNNRankingNetwork
path: /ranking/api_docs/python/tfr/keras/canned/DNNRankingNetwork
- title: GAMRankingNetwork
path: /ranking/api_docs/python/tfr/keras/canned/GAMRankingNetwork
- title: dnn
section:
- title: Overview
path: /ranking/api_docs/python/tfr/keras/canned/dnn
- title: gam
section:
- title: Overview
path: /ranking/api_docs/python/tfr/keras/canned/gam
- title: estimator
section:
- title: Overview
Expand All @@ -91,10 +101,14 @@ toc:
path: /ranking/api_docs/python/tfr/keras/feature
- title: create_keras_inputs
path: /ranking/api_docs/python/tfr/keras/feature/create_keras_inputs
- title: deserialize_feature_columns
path: /ranking/api_docs/python/tfr/keras/feature/deserialize_feature_columns
- title: EncodeListwiseFeatures
path: /ranking/api_docs/python/tfr/keras/feature/EncodeListwiseFeatures
- title: GenerateMask
path: /ranking/api_docs/python/tfr/keras/feature/GenerateMask
- title: serialize_feature_columns
path: /ranking/api_docs/python/tfr/keras/feature/serialize_feature_columns
- title: losses
section:
- title: Overview
Expand Down Expand Up @@ -211,6 +225,8 @@ toc:
path: /ranking/api_docs/python/tfr/utils
- title: approx_ranks
path: /ranking/api_docs/python/tfr/utils/approx_ranks
- title: de_noise
path: /ranking/api_docs/python/tfr/utils/de_noise
- title: inverse_max_dcg
path: /ranking/api_docs/python/tfr/utils/inverse_max_dcg
- title: is_label_valid
Expand Down
8 changes: 8 additions & 0 deletions tensorflow_ranking/g3doc/api_docs/python/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,9 @@
* <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/GAMEstimatorBuilder.md"><code>tfr.estimator.GAMEstimatorBuilder</code></a>
* <a href="./tfr/estimator/make_dnn_ranking_estimator.md"><code>tfr.estimator.make_dnn_ranking_estimator</code></a>
* <a href="./tfr/estimator/make_gam_ranking_estimator.md"><code>tfr.estimator.make_gam_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>
Expand All @@ -31,14 +33,19 @@
* <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/GAMRankingNetwork.md"><code>tfr.keras.canned.GAMRankingNetwork</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/canned/gam.md"><code>tfr.keras.canned.gam</code></a>
* <a href="./tfr/keras/canned/GAMRankingNetwork.md"><code>tfr.keras.canned.gam.GAMRankingNetwork</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/feature/deserialize_feature_columns.md"><code>tfr.keras.feature.deserialize_feature_columns</code></a>
* <a href="./tfr/keras/feature/serialize_feature_columns.md"><code>tfr.keras.feature.serialize_feature_columns</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>
Expand Down Expand Up @@ -89,6 +96,7 @@
* <a href="./tfr/model/make_groupwise_ranking_fn.md"><code>tfr.model.make_groupwise_ranking_fn</code></a>
* <a href="./tfr/utils.md"><code>tfr.utils</code></a>
* <a href="./tfr/utils/approx_ranks.md"><code>tfr.utils.approx_ranks</code></a>
* <a href="./tfr/utils/de_noise.md"><code>tfr.utils.de_noise</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>
Expand Down
5 changes: 3 additions & 2 deletions tensorflow_ranking/g3doc/api_docs/python/tfr.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,8 @@
<img src="https://www.tensorflow.org/images/GitHub-Mark-32px.png" />
View source on GitHub
</a>
</td></table>
</td>
</table>

TensorFlow Ranking, the project to build ranking models on TensorFlow.

Expand Down Expand Up @@ -45,4 +46,4 @@ library.

## Other Members

* `__version__ = '0.3.0.dev'` <a id="__version__"></a>
* `__version__ = '0.3.1.dev'` <a id="__version__"></a>
Loading

0 comments on commit 99ab8ee

Please sign in to comment.