matchzoo.tasks.ranking

Ranking task.

Module Contents

Classes

Ranking

Ranking Task.

class matchzoo.tasks.ranking.Ranking(losses=None, metrics=None)

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

classmethod list_available_losses(cls) → list

Returns

a list of available losses.

classmethod list_available_metrics(cls) → list

Returns

a list of available metrics.

property output_shape(self) → tuple

Returns

output shape of a single sample of the task.

property output_dtype(self)

Returns

target data type, expect float as output.

__str__(self)

Returns

Task name as string.