Skip to content

Commit

Permalink
Align documentation with up-to-date code.
Browse files Browse the repository at this point in the history
PiperOrigin-RevId: 649803828
  • Loading branch information
rjagerman authored and Rax Developers committed Jul 6, 2024
1 parent 3991838 commit df63da5
Showing 1 changed file with 7 additions and 4 deletions.
11 changes: 7 additions & 4 deletions docs/api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,7 @@ Lambdaweights (``rax.*_lambdaweight``)
Utilities
=========

.. automodule:: rax._src.utils
.. currentmodule:: rax.utils

.. autosummary::
Expand All @@ -102,11 +103,17 @@ Utilities
cutoff
approx_ranks
approx_cutoff
pairwise_loss
compute_pairs
safe_reduce

.. autofunction:: ranks
.. autofunction:: cutoff
.. autofunction:: approx_ranks
.. autofunction:: approx_cutoff
.. autofunction:: pairwise_loss
.. autofunction:: compute_pairs
.. autofunction:: safe_reduce

Types
=====
Expand All @@ -122,7 +129,6 @@ Types
MetricFn
RankFn
ReduceFn
WeightFn

.. autoclass:: CutoffFn
:members: __call__
Expand All @@ -142,9 +148,6 @@ Types
.. autoclass:: ReduceFn
:members: __call__

.. autoclass:: WeightFn
:members: __call__

References
==========

Expand Down

0 comments on commit df63da5

Please sign in to comment.