Skip to content

Commit e052061

Browse files
committed
add improved docstring description
1 parent 1db5152 commit e052061

1 file changed

Lines changed: 9 additions & 2 deletions

File tree

cebra/data/single_session.py

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -258,9 +258,16 @@ class MixedDataLoader(cebra_data.Loader):
258258
259259
Sampling can be configured in different modes:
260260
261-
1. Positive pairs always share their discrete variable.
261+
1. Positive pairs always share their discrete variable (positive_sampling = "discrete_variable").
262262
2. Positive pairs are drawn only based on their conditional,
263-
not discrete variable.
263+
not discrete variable (positive_sampling = "conditional").
264+
265+
When using the discrete variable, the prior distribution can either be uniform
266+
(discrete_sampling_prior = "uniform") or empirical (discrete_sampling_prior = "empirical").
267+
268+
Based on the selection of those parameters, the :py:class:`cebra.distributions.MixedTimeDeltaDistribution`,
269+
:py:class:`cebra.distributions.DiscreteEmpirical`, or :py:class:`cebra.distributions.DiscreteUniform`
270+
distributions are used for sampling.
264271
265272
Args:
266273
conditional (str): The conditional variable for sampling positive pairs. :py:attr:`cebra.CEBRA.conditional`

0 commit comments

Comments
 (0)