AlvisNLP

corpus processing engine

CompareElements

Synopsis

Compares two sets of elements.

Description

CompareElements evaluates predicted and reference as element lists and compares them according to similarity . Detailed comparison, recall, precision and F-Score are written in outFile .

Snippet

<compareelements class="CompareElements">
    <face></face>
    <outFile></outFile>
    <predicted></predicted>
    <reference></reference>
    <sections></sections>
    <similarity></similarity>
</compareelements>

Mandatory parameters

face

Mandatory
Type: Expression

Expression evaluated from a reference or predicted element as a string that will be written in outFile .

outFile

Mandatory

File where to write results.

predicted

Mandatory
Type: Expression

Set of predicted elements.

reference

Mandatory
Type: Expression

Set of reference elements.

sections

Mandatory
Type: Expression

Elements from which predicted and reference are evaluated.

similarity

Mandatory

Similarity function between two elements.

Optional parameters

showFullMatches

Default value: `true`
Type: Boolean

Either to write matches where the similarity equals 1 (true positives).

showPrecision

Default value: `true`
Type: Boolean

Either to write the precision.

showRecall

Default value: `true`
Type: Boolean

Either to write the recall.

Deprecated parameters