rtbgym.envs.simulator.base.BaseClickAndConversionRate#

class rtbgym.envs.simulator.base.BaseClickAndConversionRate[source]#

Base class to Class to define ground-truth CTR/CVR.

Imported as: class:rtbgym.BaseClickAndConversionRate

Methods

calc_prob(ad_ids, user_ids, ...)

Calculate Click Through Rate (CTR) / Conversion Rate (CVR).

sample_outcome(ad_ids, user_ids, ...)

Stochastically determine whether click/conversion occurs or not.
abstract calc_prob(ad_ids, user_ids, ad_feature_vector, user_feature_vector, timestep)[source]#

Calculate Click Through Rate (CTR) / Conversion Rate (CVR).

Parameters:

  • ad_ids (array-like of shape (search_volume/n_samples, )) – Ad ids used for each auction.

  • user_ids (array-like of shape (search_volume/n_samples, )) – User ids used for each auction.

  • ad_feature_vector (array-like of shape (search_volume/n_samples, ad_feature_dim)) – Ad feature vector for each auction.

  • user_feature_vector (array-like of shape (search_volume/n_samples, user_feature_dim)) – User feature vector for each auction.

  • timestep ({int, array-like of shape (n_samples, )}) – Timestep in the RL environment.

Returns:

ctrs/cvrs – Ground-truth CTR (i.e., click per impression) or CVR (i.e., conversion per click) for each auction.

Return type:

ndarray of shape (search_volume/n_samples, )

abstract sample_outcome(ad_ids, user_ids, ad_feature_vector, user_feature_vector, timestep)[source]#

Stochastically determine whether click/conversion occurs or not.

Parameters:

  • ad_ids (array-like of shape (search_volume/n_samples, )) – Ad ids used for each auction.

  • user_ids (array-like of shape (search_volume/n_samples, )) – User ids used for each auction.

  • ad_feature_vector (array-like of shape (search_volume/n_samples, ad_feature_dim)) – Ad feature vector for each auction.

  • user_feature_vector (array-like of shape (search_volume/n_samples, user_feature_dim)) – User feature vector for each auction.

  • timestep ({int, array-like of shape (n_samples, )}) – Timestep in the RL environment.

Returns:

clicks/conversions – Whether click occurs (when impression=True) or whether conversion occurs (when click=True).

Return type:

array-like of shape (search_volume/n_samples, )

Methods