canberra_distance_interdependence

Bases: numerical_kernel_based_interdependence

A kernel-based interdependence class using the Canberra distance kernel.

Notes

Canberra Distance based Kernel:

\[
    \begin{equation}
    \text{kernel}(\mathbf{x}, \mathbf{y}) = \sum_{i} \frac{|\mathbf{x}(i) - \mathbf{y}(i)|}{|\mathbf{x}(i)| + |\mathbf{y}(i)|}.
    \end{equation}
\]

Attributes:

Name	Type	Description
kernel	Callable	The Canberra distance kernel function.

Methods:

Name	Description
__init__	Initializes the Canberra distance interdependence function.

Source code in tinybig/interdependence/numerical_kernel_interdependence.py

class canberra_distance_interdependence(numerical_kernel_based_interdependence):
    r"""
        A kernel-based interdependence class using the Canberra distance kernel.

        Notes
        ----------
        __Canberra Distance based Kernel:__

        $$
            \begin{equation}
            \text{kernel}(\mathbf{x}, \mathbf{y}) = \sum_{i} \frac{|\mathbf{x}(i) - \mathbf{y}(i)|}{|\mathbf{x}(i)| + |\mathbf{y}(i)|}.
            \end{equation}
        $$

        Attributes
        ----------
        kernel : Callable
            The Canberra distance kernel function.

        Methods
        -------
        __init__(...)
            Initializes the Canberra distance interdependence function.
    """
    def __init__(self, name: str = 'canberra_distance_interdependence', *args, **kwargs):
        """
            Initializes the Canberra distance interdependence function.

            Parameters
            ----------
            name : str, optional
                Name of the interdependence function. Defaults to 'canberra_distance_interdependence'.
            *args : tuple
                Additional positional arguments for the parent class.
            **kwargs : dict
                Additional keyword arguments for the parent class.
        """
        super().__init__(kernel=canberra_distance_kernel, name=name, *args, **kwargs)

__init__(name='canberra_distance_interdependence', *args, **kwargs)

Initializes the Canberra distance interdependence function.

Parameters:

Name	Type	Description	Default
name	str	Name of the interdependence function. Defaults to 'canberra_distance_interdependence'.	'canberra_distance_interdependence'
*args	tuple	Additional positional arguments for the parent class.	()
**kwargs	dict	Additional keyword arguments for the parent class.	{}

Source code in tinybig/interdependence/numerical_kernel_interdependence.py

def __init__(self, name: str = 'canberra_distance_interdependence', *args, **kwargs):
    """
        Initializes the Canberra distance interdependence function.

        Parameters
        ----------
        name : str, optional
            Name of the interdependence function. Defaults to 'canberra_distance_interdependence'.
        *args : tuple
            Additional positional arguments for the parent class.
        **kwargs : dict
            Additional keyword arguments for the parent class.
    """
    super().__init__(kernel=canberra_distance_kernel, name=name, *args, **kwargs)