Skip to content

Latest commit

 

History

History
82 lines (60 loc) · 2.24 KB

voi.md

File metadata and controls

82 lines (60 loc) · 2.24 KB
Raw

@wholebuzz/cluster / Exports / voi

Module: voi

Table of contents

Functions

Functions

variationOfInformation

▸ variationOfInformation<Item>(truth: Item[], pred: Item[], getItemLabel: GetItemLabel<Item>, ignoreUnlabeled?: boolean): object

Type parameters

Name
Item

Parameters

Name Type Default value
truth Item[] -
pred Item[] -
getItemLabel GetItemLabel<Item> -
ignoreUnlabeled boolean false

Returns: object

Name Type
H0 number
H1 number
I number
N number
pj ItemClustering
pjk Record<string, ItemClustering>
pk ItemClustering
precision number
recall number
value number

Defined in: voi.ts:6

variationOfInformationFromLabels

▸ variationOfInformationFromLabels(truth: ItemClustering, pred: ItemClustering, ignoreUnlabeled?: boolean): object

Parameters

Name Type Default value
truth ItemClustering -
pred ItemClustering -
ignoreUnlabeled boolean false

Returns: object

Name Type
H0 number
H1 number
I number
N number
mergedKeys string[]
pj ItemClustering
pjk Record<string, ItemClustering>
pk ItemClustering
precision number
predKeys string[]
recall number
truthKeys string[]
value number

Defined in: voi.ts:66