AdmitAndEvictConfig

Function

This API indicates the access and eviction configuration of a single embedding table. This class provides parameters for configuring the feature access and eviction functions of an embedding table, allowing users to control the feature access and eviction behaviors based on specific conditions.

Prototype

class AdmitAndEvictConfig: 
     admit_threshold: Optional[int] = _DEFAULT_ADMIT_THRESHOLD 
     not_admitted_default_value: Optional[float] = 0.0 
     evict_threshold: Optional[int] = _DEFAULT_EVICT_THRESHOLD  # unit: seconds 
     evict_step_interval: Optional[int] = 0

Parameters

Parameter	Data Type	Mandatory/Optional	Description
admit_threshold	int	Optional	Feature access threshold. A feature (after input distribution) is admitted when the number of repetitions is greater than the value of admit_threshold. The default value is –1, indicating that the feature admission function is disabled.
not_admitted_default_value	float	Optional	Embedding value of the ID of an unadmitted feature. The default value is 0.0, which takes effect only when the value of admit_threshold is not the default value.
evict_threshold	int	Optional	Feature eviction threshold, in seconds. The default value is 0, indicating that the feature eviction function is disabled.
evict_step_interval	int	Optional	Step interval of the feature eviction function. The default value is 0, which takes effect only when the value of evict_threshold is not the default value.

Parent topic: Access and Eviction Management APIs