Module fast_transformers.builders.base

Provide a class for the others to inherit some useful functionality.

#
# Copyright (c) 2020 Idiap Research Institute, http://www.idiap.ch/
# Written by Angelos Katharopoulos <angelos.katharopoulos@idiap.ch>,
# Apoorv Vyas <avyas@idiap.ch>
#

"""Provide a class for the others to inherit some useful functionality."""


class BaseBuilder(object):
    @classmethod
    def from_kwargs(cls, **kwargs):
        """Construct a builder and set all the keyword arguments as parameters.

        The keyword argument strict is passed to
        BaseBuilder.from_dictionary separately.

        See BaseBuilder.from_dictionary().
        """
        strict = kwargs.pop("strict", True)
        return cls.from_dictionary(kwargs, strict=strict)

    @classmethod
    def from_namespace(cls, args, strict=False):
        """Construct a builder from an argparse Namespace.

        To be used for building transformers from command line arguments.

        See BaseBuilder.from_dictionary().
        """
        return cls.from_dictionary(vars(args), strict=strict)

    @classmethod
    def from_dictionary(cls, dictionary, strict=True):
        """Construct a builder and set all the parameters in the dictionary.

        Given a dictionary

            d = {"foo": "bar"}

        then

            builder = TransformerEncoderBuilder.from_dictionary(d)

        is equivalent to

            builder = TransformerEncoderBuilder()
            builder.foo = "bar"

        Arguments
        ---------
            dictionary: A dictionary of parameters to set to the builder.
            strict: bool, If a key is not a parameter and strict is set to True
                    then a ValueError is raised, otherwise that dictionary key
                    is ignored (default: True)
        """
        builder = cls()
        for k, v in dictionary.items():
            try:
                setattr(builder, k, v)
            except AttributeError:
                if strict:
                    raise ValueError(("The builder has no "
                                      "parameter {!r}").format(k))
                else:
                    continue
        return builder

Classes

class BaseBuilder

Expand source code

class BaseBuilder(object):
    @classmethod
    def from_kwargs(cls, **kwargs):
        """Construct a builder and set all the keyword arguments as parameters.

        The keyword argument strict is passed to
        BaseBuilder.from_dictionary separately.

        See BaseBuilder.from_dictionary().
        """
        strict = kwargs.pop("strict", True)
        return cls.from_dictionary(kwargs, strict=strict)

    @classmethod
    def from_namespace(cls, args, strict=False):
        """Construct a builder from an argparse Namespace.

        To be used for building transformers from command line arguments.

        See BaseBuilder.from_dictionary().
        """
        return cls.from_dictionary(vars(args), strict=strict)

    @classmethod
    def from_dictionary(cls, dictionary, strict=True):
        """Construct a builder and set all the parameters in the dictionary.

        Given a dictionary

            d = {"foo": "bar"}

        then

            builder = TransformerEncoderBuilder.from_dictionary(d)

        is equivalent to

            builder = TransformerEncoderBuilder()
            builder.foo = "bar"

        Arguments
        ---------
            dictionary: A dictionary of parameters to set to the builder.
            strict: bool, If a key is not a parameter and strict is set to True
                    then a ValueError is raised, otherwise that dictionary key
                    is ignored (default: True)
        """
        builder = cls()
        for k, v in dictionary.items():
            try:
                setattr(builder, k, v)
            except AttributeError:
                if strict:
                    raise ValueError(("The builder has no "
                                      "parameter {!r}").format(k))
                else:
                    continue
        return builder

Subclasses

• BaseAttentionBuilder
• BaseTransformerBuilder

Static methods

def from_dictionary(dictionary, strict=True)

Construct a builder and set all the parameters in the dictionary.

Given a dictionary

d = {"foo": "bar"}

then

builder = TransformerEncoderBuilder.from_dictionary(d)

is equivalent to

builder = TransformerEncoderBuilder()
builder.foo = "bar"

Arguments

dictionary: A dictionary of parameters to set to the builder.
strict: bool, If a key is not a parameter and strict is set to True
        then a ValueError is raised, otherwise that dictionary key
        is ignored (default: True)

Expand source code

@classmethod
def from_dictionary(cls, dictionary, strict=True):
    """Construct a builder and set all the parameters in the dictionary.

    Given a dictionary

        d = {"foo": "bar"}

    then

        builder = TransformerEncoderBuilder.from_dictionary(d)

    is equivalent to

        builder = TransformerEncoderBuilder()
        builder.foo = "bar"

    Arguments
    ---------
        dictionary: A dictionary of parameters to set to the builder.
        strict: bool, If a key is not a parameter and strict is set to True
                then a ValueError is raised, otherwise that dictionary key
                is ignored (default: True)
    """
    builder = cls()
    for k, v in dictionary.items():
        try:
            setattr(builder, k, v)
        except AttributeError:
            if strict:
                raise ValueError(("The builder has no "
                                  "parameter {!r}").format(k))
            else:
                continue
    return builder

def from_kwargs(**kwargs)

Construct a builder and set all the keyword arguments as parameters.

The keyword argument strict is passed to BaseBuilder.from_dictionary separately.

See BaseBuilder.from_dictionary().

Expand source code

@classmethod
def from_kwargs(cls, **kwargs):
    """Construct a builder and set all the keyword arguments as parameters.

    The keyword argument strict is passed to
    BaseBuilder.from_dictionary separately.

    See BaseBuilder.from_dictionary().
    """
    strict = kwargs.pop("strict", True)
    return cls.from_dictionary(kwargs, strict=strict)

def from_namespace(args, strict=False)

Construct a builder from an argparse Namespace.

To be used for building transformers from command line arguments.

See BaseBuilder.from_dictionary().

Expand source code

@classmethod
def from_namespace(cls, args, strict=False):
    """Construct a builder from an argparse Namespace.

    To be used for building transformers from command line arguments.

    See BaseBuilder.from_dictionary().
    """
    return cls.from_dictionary(vars(args), strict=strict)