kiwi.metrics.metrics

Module Contents

Classes

Metric
NLLMetric
LabeledMetric	Helper class that provides a standard way to create an ABC using
CorrectMetric	Helper class that provides a standard way to create an ABC using
F1MultMetric	Helper class that provides a standard way to create an ABC using
MatthewsMetric	Helper class that provides a standard way to create an ABC using
SentenceMetric	Helper class that provides a standard way to create an ABC using
PearsonMetric	Helper class that provides a standard way to create an ABC using
SpearmanMetric	Helper class that provides a standard way to create an ABC using
RMSEMetric	Helper class that provides a standard way to create an ABC using
PerplexityMetric
ExpectedErrorMetric	Helper class that provides a standard way to create an ABC using

class kiwi.metrics.metrics.Metric(*targets, prefix=None)

_name

best_ordering = max

abstract step(self, model_out, batch, losses)

abstract compute(self, steps, prefix='')

property name(self)

num_tokens(self, batch, *targets)

class kiwi.metrics.metrics.NLLMetric(*targets, prefix=None)

Bases: kiwi.metrics.metrics.Metric

_name = NLL

best_ordering = min

step(self, model_out, batch, losses)

compute(self, steps, prefix='')

class kiwi.metrics.metrics.LabeledMetric(*args, labels=None, **kwargs)

Bases: kiwi.metrics.metrics.Metric, abc.ABC

Helper class that provides a standard way to create an ABC using inheritance.

step(self, model_out, batch, losses)

get_target_flat(self, batch)

get_predictions_flat(self, model_out, batch)

class kiwi.metrics.metrics.CorrectMetric(*args, labels=None, **kwargs)

Bases: kiwi.metrics.metrics.LabeledMetric

Helper class that provides a standard way to create an ABC using inheritance.

_name = CORRECT

step(self, model_out, batch, losses)

compute(self, steps, prefix='')

class kiwi.metrics.metrics.F1MultMetric(*args, labels=None, **kwargs)

Bases: kiwi.metrics.metrics.LabeledMetric

Helper class that provides a standard way to create an ABC using inheritance.

_name = F1_MULT

compute(self, steps, prefix='')

class kiwi.metrics.metrics.MatthewsMetric(*args, labels=None, **kwargs)

Bases: kiwi.metrics.metrics.LabeledMetric

Helper class that provides a standard way to create an ABC using inheritance.

_name = MCC

compute(self, steps, prefix='')

class kiwi.metrics.metrics.SentenceMetric(*targets, prefix=None)

Bases: kiwi.metrics.metrics.Metric, abc.ABC

Helper class that provides a standard way to create an ABC using inheritance.

step(self, model_out, batch, losses)

class kiwi.metrics.metrics.PearsonMetric(*targets, prefix=None)

Bases: kiwi.metrics.metrics.SentenceMetric

Helper class that provides a standard way to create an ABC using inheritance.

_name = PEARSON

compute(self, steps, prefix='')

class kiwi.metrics.metrics.SpearmanMetric(*targets, prefix=None)

Bases: kiwi.metrics.metrics.SentenceMetric

Helper class that provides a standard way to create an ABC using inheritance.

_name = SPEARMAN

compute(self, steps, prefix='')

class kiwi.metrics.metrics.RMSEMetric(*targets, prefix=None)

Bases: kiwi.metrics.metrics.SentenceMetric

Helper class that provides a standard way to create an ABC using inheritance.

_name = RMSE

best_ordering = min

compute(self, steps, prefix='')

class kiwi.metrics.metrics.PerplexityMetric(*targets, prefix=None)

Bases: kiwi.metrics.metrics.Metric

_name = PERP

best_ordering = min

step(self, model_out, batch, losses)

compute(self, steps, prefix='')

class kiwi.metrics.metrics.ExpectedErrorMetric(*args, labels=None, **kwargs)

Bases: kiwi.metrics.metrics.LabeledMetric

Helper class that provides a standard way to create an ABC using inheritance.

_name = ExpErr

best_ordering = min

step(self, model_out, batch, losses)

compute(self, steps, prefix='')

kiwi.metrics.functions kiwi.modules