earth2studio icon indicating copy to clipboard operation
earth2studio copied to clipboard

🐛[BUG]: incorrect docstring in CorrelatedSphericalGaussian

Open pzharrington opened this issue 11 months ago • 0 comments

Version

0.7.0

On which installation method(s) does this occur?

No response

Describe the issue

The documented args:

    noise_amplitude : float | Tensor, optional
        Noise amplitude, by default 0.05. If a tensor,
        this must be broadcastable with the input data.
    alpha : float, optional
        Regularity parameter. Larger means smoother, by default 2.0
    tau : float, optional
        Length-scale parameter. Larger means more scales, by default 3.0
    sigma : Union[float, None], optional
        Scale parameter. If None, sigma = tau**(0.5*(2*alpha - 2.0)), by default None

don't match the actual function args:

    def __init__(
        self,
        noise_amplitude: float | torch.Tensor | None = None,
        sigma: float = 1.0,
        length_scale: float = 5.0e5,
        time_scale: float = 48.0,
    ) -> None:

pzharrington avatar May 21 '25 21:05 pzharrington