textattack.metrics package

metrics package: to calculate advanced metrics for evaluting attacks and augmented text

Subpackages

Submodules

Metric Class

class textattack.metrics.metric.Metric(**kwargs)[source]

Bases: ABC

A metric for evaluating results and data quality.

abstract calculate(results)[source]

Abstract function for computing any values which are to be calculated as a whole during initialization :param results: Attack results for each instance in dataset :type results: AttackResult objects

Attack Metric Quality Recipes:

class textattack.metrics.recipe.AdvancedAttackMetric(choices=['use'])[source]

Bases: Metric

Calculate a suite of advanced metrics to evaluate attackResults’ quality.

calculate(results)[source]

Abstract function for computing any values which are to be calculated as a whole during initialization :param results: Attack results for each instance in dataset :type results: AttackResult objects