Skip to content

Commit a437640

Browse files
Update README.md
1 parent 98383a9 commit a437640

1 file changed

Lines changed: 1 addition & 1 deletion

File tree

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -258,7 +258,7 @@ Subsections below detail all the parameters for each of the concepts, including
258258

259259
## Metrics
260260
* `metrics | Dictionary`: Specification of all the evaluation metrics to use. Defined by a dictionary where:
261-
* *key* corresponds to the `metric_name | String`. When processed, the value is split by the underscore ("_") character. The first part of the split, or the entire string if no underscore exists, is used as the `metric_key`. This must match one the name of a class in the `metrics` folder that inherits from `MetricABC`. By default, the available options are: `["Precision", "PrecisionWeighted", "TPI", "TPS", "NMI", "Recall", "RecallPerEntityType", "TRIR"]`. Custom metrics added following the [Extensions guidelines](#extension-guidelines) will also be considered. If the `metric_key` is invalid (for instance, because `metric_name` starts with an underscore) this triggers a warning log and prevents the metric from being computed. Any text following the first underscore is independent of the `metric_key`, and can be used to indicate variations of the same metric (*e.g.*, "TPS", "TPS_TA=4", "TPS_TA=4_bert").
261+
* *key* corresponds to the `metric_name | String`. When processed, the value is split by the underscore ("_") character. The first part of the split, or the entire string if no underscore exists, is used as the `metric_key`. This must match (not case-sensitive) one the name of a class in the `metrics` folder that inherits from `MetricABC`. By default, the available options are: `["Precision", "PrecisionWeighted", "TPI", "TPS", "NMI", "Recall", "RecallPerEntityType", "TRIR"]`. Custom metrics added following the [Extensions guidelines](#extension-guidelines) will also be considered. If the `metric_key` is invalid (for instance, because `metric_name` starts with an underscore) this triggers a warning log and prevents the metric from being computed. Any text following the first underscore is independent of the `metric_key`, and can be used to indicate variations of the same metric (*e.g.*, "TPS", "TPS_TA=4", "TPS_TA=4_bert").
262262

263263
* *value* corresponds to the `metric_parameters | Dictionary`, which specifies the configurable parameters of a metric that are either mandatory or different from the default ones. This dictionary uses the `parameter_name | String` as *key* and the corresponding `parameter_value`, of varying type, as *value*. For all metrics except [TRIR](#trir), no parameters are mandatory, so `metric_parameters` can be empty, in which case the default settings are applied. **The following subsections describe the configurable parameters for each metric.**
264264

0 commit comments

Comments
 (0)