matchzoo.tasks

Submodules

• matchzoo.tasks.classification
• matchzoo.tasks.ranking

Package Contents

Classes

Classification	Classification task.
Ranking	Ranking Task.

class matchzoo.tasks.Classification(num_classes: int = 2, **kwargs)

Bases: matchzoo.engine.base_task.BaseTask

Classification task.

Examples

>>> classification_task = Classification(num_classes=2)
>>> classification_task.metrics = ['acc']
>>> classification_task.num_classes
2
>>> classification_task.output_shape
(2,)
>>> classification_task.output_dtype
<class 'int'>
>>> print(classification_task)
Classification Task with 2 classes

TYPE = classification

property num_classes(self) → int

Returns

number of classes to classify.

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 int as output.

__str__(self)

Returns

Task name as string.

class matchzoo.tasks.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.