corrint module

class corrdim.corrint.CorrIntBackend(value)[source]

Bases: str, Enum

Correlation integral backend selector.

AUTO = 'auto'
PYTORCH = 'pytorch'
PYTORCH_FAST = 'pytorch_fast'
TRITON = 'triton'
corrdim.corrint.available_corrint_backends()[source]

Return availability of known backends.

Return type:

Dict[str, bool]

corrdim.corrint.correlation_counts(vecs, epsilons, vecs_other=None, *, backend=None, **kwargs)[source]

Return counts (unnormalized); implemented by the selected backend module.

Parameters:

  • vecs (torch.FloatTensor)

  • epsilons (torch.FloatTensor)

  • vecs_other (torch.FloatTensor | None)

  • backend (str | CorrIntBackend | None)

  • kwargs (Any)

Return type:

torch.Tensor

corrdim.corrint.correlation_integral(vecs, epsilons, vecs_other=None, return_counts=False, *, backend=None, **kwargs)[source]

Return correlation integral; if return_counts=True, return counts instead.

Parameters:

  • vecs (torch.FloatTensor)

  • epsilons (torch.FloatTensor)

  • vecs_other (torch.FloatTensor | None)

  • return_counts (bool)

  • backend (str | CorrIntBackend | None)

  • kwargs (Any)

Return type:

torch.Tensor

corrdim.corrint.get_corrint_backend()[source]

Get the current default backend (AUTO is resolved).

Return type:

str

corrdim.corrint.progressive_correlation_counts(vecs, epsilons, *, backend=None, **kwargs)[source]

Progressive counts over sequence prefixes (if implemented by backend).

Parameters:

  • vecs (torch.FloatTensor)

  • epsilons (torch.FloatTensor)

  • backend (str | CorrIntBackend | None)

  • kwargs (Any)

Return type:

torch.Tensor

corrdim.corrint.progressive_correlation_integral(vecs, epsilons, return_counts=False, *, backend=None, **kwargs)[source]

Progressive correlation integral over sequence prefixes (if implemented by backend).

Parameters:

  • vecs (torch.FloatTensor)

  • epsilons (torch.FloatTensor)

  • return_counts (bool)

  • backend (str | CorrIntBackend | None)

  • kwargs (Any)

Return type:

torch.Tensor

corrdim.corrint.resolve_corrint_backend(backend=None)[source]

Resolve AUTO to a concrete backend name.

Parameters:

backend (str | CorrIntBackend | None)

Return type:

str

corrdim.corrint.set_corrint_backend(backend='auto')[source]

Set process-wide default backend; returns the resolved backend name.

Parameters:

backend (str | CorrIntBackend | None)

Return type:

str