tfm.nlp.encoders.FunnelEncoderConfig

Funnel encoder configuration.

Inherits From: Config, ParamsDict

tfm.nlp.encoders.FunnelEncoderConfig(
    default_params: dataclasses.InitVar[Optional[Mapping[str, Any]]] = None,
    restrictions: dataclasses.InitVar[Optional[List[str]]] = None,
    vocab_size: int = 30522,
    hidden_size: int = 768,
    num_layers: int = 12,
    num_attention_heads: int = 12,
    max_position_embeddings: int = 512,
    type_vocab_size: int = 16,
    inner_dim: int = 3072,
    hidden_activation: str = 'gelu',
    approx_gelu: bool = True,
    dropout_rate: float = 0.1,
    attention_dropout_rate: float = 0.1,
    pool_type: str = 'max',
    pool_stride: Union[int, Sequence[Union[int, float]]] = 2,
    unpool_length: int = 0,
    initializer_range: float = 0.02,
    output_range: Optional[int] = None,
    embedding_width: Optional[int] = None,
    embedding_layer: Optional[tf.keras.layers.Layer] = None,
    norm_first: bool = False,
    share_rezero: bool = False,
    append_dense_inputs: bool = False,
    transformer_cls: str = 'TransformerEncoderBlock'
)

BUILDER

default_params Dataclass field
restrictions Dataclass field
vocab_size Dataclass field
hidden_size Dataclass field
num_layers Dataclass field
num_attention_heads Dataclass field
max_position_embeddings Dataclass field
type_vocab_size Dataclass field
inner_dim Dataclass field
hidden_activation Dataclass field
approx_gelu Dataclass field
dropout_rate Dataclass field
attention_dropout_rate Dataclass field
pool_type Dataclass field
pool_stride Dataclass field
unpool_length Dataclass field
initializer_range Dataclass field
output_range Dataclass field
embedding_width Dataclass field
embedding_layer Dataclass field
norm_first Dataclass field
share_rezero Dataclass field
append_dense_inputs Dataclass field
transformer_cls Dataclass field

Methods

as_dict

View source

as_dict()

Returns a dict representation of params_dict.ParamsDict.

For the nested params_dict.ParamsDict, a nested dict will be returned.

from_args

View source

@classmethod
from_args(
    *args, **kwargs
)

Builds a config from the given list of arguments.

from_json

View source

@classmethod
from_json(
    file_path: str
)

Wrapper for from_yaml.

from_yaml

View source

@classmethod
from_yaml(
    file_path: str
)

get

View source

get(
    key, value=None
)

Accesses through built-in dictionary get method.

lock

View source

lock()

Makes the ParamsDict immutable.

override

View source

override(
    override_params, is_strict=True
)

Override the ParamsDict with a set of given params.

Args
override_params a dict or a ParamsDict specifying the parameters to be overridden.
is_strict a boolean specifying whether override is strict or not. If True, keys in override_params must be present in the ParamsDict. If False, keys in override_params can be different from what is currently defined in the ParamsDict. In this case, the ParamsDict will be extended to include the new keys.

replace

View source

replace(
    **kwargs
)

Overrides/returns a unlocked copy with the current config unchanged.

validate

View source

validate()

Validate the parameters consistency based on the restrictions.

This method validates the internal consistency using the pre-defined list of restrictions. A restriction is defined as a string which specifies a binary operation. The supported binary operations are {'==', '!=', '<', '<=', '>', '>='}. Note that the meaning of these operators are consistent with the underlying Python immplementation. Users should make sure the define restrictions on their type make sense.

For example, for a ParamsDict like the following

a:
  a1: 1
  a2: 2
b:
  bb:
    bb1: 10
    bb2: 20
  ccc:
    a1: 1
    a3: 3

one can define two restrictions like this ['a.a1 == b.ccc.a1', 'a.a2 <= b.bb.bb2']

What it enforces are

  • a.a1 = 1 == b.ccc.a1 = 1
  • a.a2 = 2 <= b.bb.bb2 = 20

Raises
KeyError if any of the following happens (1) any of parameters in any of restrictions is not defined in ParamsDict, (2) any inconsistency violating the restriction is found.
ValueError if the restriction defined in the string is not supported.

__contains__

View source

__contains__(
    key
)

Implements the membership test operator.

__eq__

__eq__(
    other
)

IMMUTABLE_TYPES (<class 'str'>, <class 'int'>, <class 'float'>, <class 'bool'>, <class 'NoneType'>)
RESERVED_ATTR ['_locked', '_restrictions']
SEQUENCE_TYPES (<class 'list'>, <class 'tuple'>)
append_dense_inputs False
approx_gelu True
attention_dropout_rate 0.1
default_params None
dropout_rate 0.1
embedding_layer None
embedding_width None
hidden_activation 'gelu'
hidden_size 768
initializer_range 0.02
inner_dim 3072
max_position_embeddings 512
norm_first False
num_attention_heads 12
num_layers 12
output_range None
pool_stride 2
pool_type 'max'
restrictions None
share_rezero False
transformer_cls 'TransformerEncoderBlock'
type_vocab_size 16
unpool_length 0
vocab_size 30522