Skip to content

Commit 198d3bf

Browse files
timonmerkstes
authored andcommitted
add improved docstring description
1 parent e202b82 commit 198d3bf

File tree

1 file changed

+9
-2
lines changed

1 file changed

+9
-2
lines changed

cebra/data/single_session.py

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -265,9 +265,16 @@ class MixedDataLoader(cebra_data.Loader):
265265
266266
Sampling can be configured in different modes:
267267
268-
1. Positive pairs always share their discrete variable.
268+
1. Positive pairs always share their discrete variable (positive_sampling = "discrete_variable").
269269
2. Positive pairs are drawn only based on their conditional,
270-
not discrete variable.
270+
not discrete variable (positive_sampling = "conditional").
271+
272+
When using the discrete variable, the prior distribution can either be uniform
273+
(discrete_sampling_prior = "uniform") or empirical (discrete_sampling_prior = "empirical").
274+
275+
Based on the selection of those parameters, the :py:class:`cebra.distributions.MixedTimeDeltaDistribution`,
276+
:py:class:`cebra.distributions.DiscreteEmpirical`, or :py:class:`cebra.distributions.DiscreteUniform`
277+
distributions are used for sampling.
271278
272279
Args:
273280
conditional (str): The conditional variable for sampling positive pairs. :py:attr:`cebra.CEBRA.conditional`

0 commit comments

Comments
 (0)