TopKCategoricalAccuracy

class ignite.metrics.TopKCategoricalAccuracy(k=5, output_transform=<function TopKCategoricalAccuracy.<lambda>>, device=device(type='cpu'))

Calculates the top-k categorical accuracy.

• update must receive output of the form (y_pred, y) or {'y_pred': y_pred, 'y': y}.

Parameters

• k (int) – the k in “top-k”.

• output_transform (Callable) – a callable that is used to transform the Engine’s process_function’s output into the form expected by the metric. This can be useful if, for example, you have a multi-output model and you want to compute the metric with respect to one of the outputs. By default, metrics require the output as (y_pred, y) or {'y_pred': y_pred, 'y': y}.

• device (Union[str, device]) – specifies which device updates are accumulated on. Setting the metric’s device to be the same as your update arguments ensures the update method is non-blocking. By default, CPU.

Methods

compute	Computes the metric based on it's accumulated state.
reset	Resets the metric to it's initial state.
update	Updates the metric's state using the passed batch output.

compute()

Computes the metric based on it’s accumulated state.

By default, this is called at the end of each epoch.

Returns

the actual quantity of interest. However, if a Mapping is returned, it will be (shallow) flattened into engine.state.metrics when completed() is called.

Return type

Any

Raises

NotComputableError – raised when the metric cannot be computed.

reset()

Resets the metric to it’s initial state.

By default, this is called at the start of each epoch.

Return type

None

update(output)

Updates the metric’s state using the passed batch output.

By default, this is called once for each batch.

Parameters

output (Sequence[Tensor]) – the is the output from the engine’s process function.

Return type

None