Add type hints and standardize docstrings in torchutils

[khaledeslam20]

Summary

Adds type hints and improves docstrings for 16 utility functions in sbi/utils/torchutils.py, as discussed in #1805.

Changes

Added type hints to all 16 functions that were missing them:
tile, sum_except_batch, split_leading_dim, merge_leading_dims, repeat_rows, tensor2numpy, logabsdet, random_orthogonal, get_num_parameters, create_alternating_binary_mask, create_mid_split_binary_mask, create_random_binary_mask, searchsorted, cbrt, get_temperature, gaussian_kde_log_eval

Also standardized docstrings to Google style (Args/Returns) for the functions that were still using the old :param/:return format, to be consistent with the rest of the file.

Small fix in get_temperature: changed 1 to torch.ones(1) for correct tensor comparison in torch.min.

Testing

All tests pass: pytest tests/ -k torchutils -v → 18 passed, 1 skipped

No functionality changes (except minor get_temperature fix).

Closes #1805

[codecov]

Codecov Report

❌ Patch coverage is 84.21053% with 3 lines in your changes missing coverage. Please review.
✅ Project coverage is 87.86%. Comparing base (cfed0a1) to head (8919eb1).
⚠️ Report is 1 commits behind head on main.

Files with missing lines	Patch %	Lines
sbi/utils/torchutils.py	84.21%	3 Missing ⚠️

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #1815   +/-   ##
=======================================
  Coverage   87.86%   87.86%           
=======================================
  Files         140      140           
  Lines       12726    12726           
=======================================
  Hits        11182    11182           
  Misses       1544     1544           

Flag	Coverage Δ
fast	82.72% <84.21%> (?)

Flags with carried forward coverage won't be shown. Click here to find out more.

Files with missing lines	Coverage Δ
sbi/utils/torchutils.py	68.11% <84.21%> (ø)

[janfb]

thanks a lot @khaledeslam20 , this looks good!

Added a couple of minor comments.

[janfb]

duplicate import, please run ruff or all pre-commit hooks locally.

[janfb]

this docstring is not correct, it describes sth like the create_mid_split_binary_mask function.

please contruct the new docstring from the old docstring description. only adapt the format to Google docstring format.

[khaledeslam20]

Both are fixed, thanks for your guidance.

[janfb]

Looks good, thanks again @khaledeslam20 🙏

[janfb]

@khaledeslam20 before we can merge you would need to address the one type mismatch between Tensor and float. Please fix and then verify locally by running pyright sbi in the root dir of the repo. Thanks!

[khaledeslam20]

Fixed the type mismatch in get_temperature by using separate variable names for the tensor conversions. Verified locally with pyright sbi, 0 errors.