matchzoo.tasks.ranking

Ranking task.

Module Contents

class matchzoo.tasks.ranking.Ranking

Bases: matchzoo.engine.base_task.BaseTask

Ranking Task.

Examples

>>> ranking_task = Ranking()
>>> ranking_task.metrics = ['map', 'ndcg']
>>> ranking_task.output_shape
(1,)
>>> ranking_task.output_dtype
<class 'float'>
>>> print(ranking_task)
Ranking Task
TYPE = ranking
output_shape

output shape of a single sample of the task.

Type:return
output_dtype

target data type, expect float as output.

Type:return
classmethod list_available_losses(cls)
Returns:a list of available losses.
classmethod list_available_metrics(cls)
Returns:a list of available metrics.
__str__(self)
Returns:Task name as string.