Skip to content

Commit 68ae084

Browse files
committed
cleanup: remove verbose docstrings from MDN
1 parent 7fa8bd8 commit 68ae084

1 file changed

Lines changed: 1 addition & 10 deletions

File tree

sbi/neural_nets/estimators/mixture_density_estimator.py

Lines changed: 1 addition & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -356,8 +356,7 @@ def __init__(
356356
evaluation, and samples are inverse transformed as:
357357
x = z * scale + shift.
358358
This is used for z-scoring inputs to improve numerical stability.
359-
input_transform: Optional PyTorch Transform for general bijective
360-
transformation of inputs. Mutually exclusive with transform_input.
359+
input_transform: Optional Transform for general bijective transformation.
361360
"""
362361
super().__init__(net, input_shape, condition_shape)
363362
self._embedding_net = (
@@ -410,19 +409,16 @@ def embedding_net(self) -> nn.Module:
410409

411410
@property
412411
def has_input_transform(self) -> bool:
413-
"""Whether input transform is enabled (z-score or general transform)."""
414412
return self._input_transform is not None or self._transform_shift is not None
415413

416414
def _transform_input(self, input: Tensor) -> Tensor:
417-
"""Apply input transform: z = transform(x) or z = (x - shift) / scale."""
418415
if self._input_transform is not None:
419416
return self._input_transform(input)
420417
if self._transform_shift is None:
421418
return input
422419
return (input - self._transform_shift) / self._transform_scale
423420

424421
def _inverse_transform_input(self, z: Tensor) -> Tensor:
425-
"""Apply inverse input transform: x = transform.inv(z) or x = z * scale + shift."""
426422
if self._input_transform is not None:
427423
return self._input_transform.inv(z)
428424
if self._transform_shift is None:
@@ -432,11 +428,6 @@ def _inverse_transform_input(self, z: Tensor) -> Tensor:
432428
def _log_det_jacobian_forward(
433429
self, input: Tensor, transformed_input: Tensor
434430
) -> Tensor:
435-
"""Log determinant of the forward input transform Jacobian.
436-
437-
For the affine z-score transform: -sum(log(scale)).
438-
For a general transform: transform.log_abs_det_jacobian(x, z).sum(dim=-1).
439-
"""
440431
if self._input_transform is not None:
441432
jac = self._input_transform.log_abs_det_jacobian(
442433
input, transformed_input

0 commit comments

Comments
 (0)