Stay organized with collections Save and categorize content based on your preferences.

The tf-ranking BERT task config.

Inherits From: RankingTaskConfig


default_params Dataclass field
restrictions Dataclass field
init_checkpoint Dataclass field
model Dataclass field
train_data Dataclass field
validation_data Dataclass field
name Dataclass field
differential_privacy_config Dataclass field
loss Dataclass field
loss_reduction Dataclass field
aggregated_metrics Dataclass field
output_preds Dataclass field



Returns a dict representation of params_dict.ParamsDict.

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


Builds a config from the given list of arguments.


Wrapper for from_yaml.



Accesses through built-in dictionary get method.


Makes the ParamsDict immutable.


Override the ParamsDict with a set of given params.

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.


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


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 specfiies 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

  a1: 1
  a2: 2
    bb1: 10
    bb2: 20
    a1: 1
    a3: 3

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

What it enforces are

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

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.


Implements the membership test operator.


IMMUTABLE_TYPES (<class 'str'>, <class 'int'>, <class 'float'>, <class 'bool'>, <class 'NoneType'>)
RESERVED_ATTR ['_locked', '_restrictions']
SEQUENCE_TYPES (<class 'list'>, <class 'tuple'>)
aggregated_metrics False
default_params None
differential_privacy_config None
init_checkpoint ''
loss 'softmax_loss'
loss_reduction 'none'
model Instance of tfr.extension.premade.TFRBertModelConfig
name None
output_preds False
restrictions None
train_data None
validation_data None