Function get_embedding_function

pointersect/models/model_utils.py:253–276

r""" Returns a lambda function that internally calls positional_encoding. Args: num_encoding_functions: Number of encoding functions used to compute a positional encoding (default: 6). include_input: Whether to include the input in the positional enco

(
        num_encoding_functions: int = 6,
        include_input: bool = True,
        log_sampling: bool = True,
)

def get_embedding_function(
        num_encoding_functions: int = 6,
        include_input: bool = True,
        log_sampling: bool = True,
):
    r"""
    Returns a lambda function that internally calls positional_encoding.

    Args:
        num_encoding_functions:
            Number of encoding functions used to compute a positional encoding (default: 6).
        include_input:
            Whether to include the input in the positional encoding (default: True).
        log_sampling:
            whether to sample the sinusoid frequencies in log scale.

    Returns:
        A lambda function that convert input to positional encoding.
        the output dimension is (*, dim_out), where
        :math:`dim_{out} = d_{in} * include_input + num_encoding_functions * 2`
    """
    return lambda x: positional_encoding(
        x, num_encoding_functions, include_input, log_sampling
    )