Skip to content

Commit 26f6ac5

Browse files
stesCeliaBenquet
andcommitted
Update docstring for goodness_of_fit_score
Co-authored-by: Célia Benquet <[email protected]>
1 parent effb082 commit 26f6ac5

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

cebra/integrations/sklearn/metrics.py

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -113,9 +113,11 @@ def goodness_of_fit_score(cebra_model: cebra_sklearn_cebra.CEBRA,
113113
*y,
114114
session_id: Optional[int] = None,
115115
num_batches: int = 500) -> float:
116-
"""Compute the InfoNCE loss on a *single session* dataset on the model.
116+
"""Compute the goodness of fit score on a *single session* dataset on the model.
117117
118-
This function uses the :func:`infonce_loss` function to compute the InfoNCE loss.
118+
This function uses the :func:`infonce_loss` function to compute the InfoNCE loss
119+
for a given `cebra_model` and the :func:`infonce_to_goodness_of_fit` function
120+
to derive the goodness of fit from the InfoNCE loss.
119121
120122
Args:
121123
cebra_model: The model to use to compute the InfoNCE loss on the samples.

0 commit comments

Comments
 (0)