lerot.environment

class lerot.environment.CascadeUserModel(arg_str)[source]

Bases: lerot.environment.AbstractUserModel.AbstractUserModel

Defines a cascade user model, simulating a user that inspects results starting from the top of a result list.

get_clicks(result_list, labels, **kwargs)[source]

simulate clicks on list l

class lerot.environment.FederatedClickModel(arg_str)[source]

Bases: lerot.environment.AbstractUserModel.AbstractUserModel

b(i, vert)[source]
static getParamRescaled(rank, serp_len, param_vector)[source]
static getVertClass(vert_type)[source]
get_clicks(result_list, labels, **kwargs)[source]

Simulate clicks on the result_list. - labels contain relevance labels indexed by the docid

get_examination_prob(result_list, **kwargs)[source]
h(i, serp_len, vert)[source]
p(i, serp_len)[source]
class lerot.environment.PositionBasedUserModel(p)[source]

Bases: lerot.environment.AbstractUserModel.AbstractUserModel

Defines a positions based user model.

get_clicks(result_list, labels, **kwargs)[source]

simulate clicks on list l

get_examination_prob(result_list, **kwargs)[source]
p(i)[source]
class lerot.environment.RandomClickModel(p=0.5)[source]

Bases: lerot.environment.AbstractUserModel.AbstractUserModel

Defines a positions based user model.

get_clicks(result_list, labels, **kwargs)[source]

simulate clicks on list l

class lerot.environment.LivingLabsRealUser(key, doc_ids)[source]

Bases: lerot.environment.AbstractUserModel.AbstractUserModel

KEY = ''
get_clicks(result_list, labels, **kwargs)[source]
get_win(query, feedback_list, lerot_ranked_list)[source]

Used for seznam site which interleaves ranked list with it’s own list Returns ‘ranked list winner’ with number of clicks of each ranker e.g. [0 2] where [lerot_list_score seznam_list_score]

runs = {}
upload_run(query, upload_list, runid)[source]

Uploads a run to living-labs api.

class lerot.environment.RelevantUserModel(arg_str)[source]

Bases: lerot.environment.AbstractUserModel.AbstractUserModel

Defines a user model that clicks on all relevant documents in a list with an optional limit

get_clicks(result_list, labels, **kwargs)[source]