-
Notifications
You must be signed in to change notification settings - Fork 31
/
ClusteringMetrics.xml
98 lines (98 loc) · 5.05 KB
/
ClusteringMetrics.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
<Type Name="ClusteringMetrics" FullName="Microsoft.ML.Data.ClusteringMetrics">
<TypeSignature Language="C#" Value="public sealed class ClusteringMetrics" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit ClusteringMetrics extends System.Object" />
<TypeSignature Language="DocId" Value="T:Microsoft.ML.Data.ClusteringMetrics" />
<TypeSignature Language="VB.NET" Value="Public NotInheritable Class ClusteringMetrics" />
<TypeSignature Language="F#" Value="type ClusteringMetrics = class" />
<AssemblyInfo>
<AssemblyName>Microsoft.ML.Data</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>
The metrics generated after evaluating the clustering predictions.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName="AverageDistance">
<MemberSignature Language="C#" Value="public double AverageDistance { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance float64 AverageDistance" />
<MemberSignature Language="DocId" Value="P:Microsoft.ML.Data.ClusteringMetrics.AverageDistance" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property AverageDistance As Double" />
<MemberSignature Language="F#" Value="member this.AverageDistance : double" Usage="Microsoft.ML.Data.ClusteringMetrics.AverageDistance" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ML.Data</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Double</ReturnType>
</ReturnValue>
<Docs>
<summary>
Average Score. For the K-Means algorithm, the 'score' is the distance from the centroid to the example.
The average score is, therefore, a measure of proximity of the examples to cluster centroids.
In other words, it is a measure of 'cluster tightness'.
Note however, that this metric will only decrease if the number of clusters is increased,
and in the extreme case (where each distinct example is its own cluster) it will be equal to zero.
</summary>
<value>Distance is to the nearest centroid.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="DaviesBouldinIndex">
<MemberSignature Language="C#" Value="public double DaviesBouldinIndex { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance float64 DaviesBouldinIndex" />
<MemberSignature Language="DocId" Value="P:Microsoft.ML.Data.ClusteringMetrics.DaviesBouldinIndex" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property DaviesBouldinIndex As Double" />
<MemberSignature Language="F#" Value="member this.DaviesBouldinIndex : double" Usage="Microsoft.ML.Data.ClusteringMetrics.DaviesBouldinIndex" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ML.Data</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Double</ReturnType>
</ReturnValue>
<Docs>
<summary>
Davies-Bouldin Index is measure of the how much scatter is in the cluster and the cluster separation.
</summary>
<value>To be added.</value>
<remarks>
<a href="https://en.wikipedia.org/wiki/Davies%E2%80%93Bouldin_index">Davies-Bouldin Index.</a>
</remarks>
</Docs>
</Member>
<Member MemberName="NormalizedMutualInformation">
<MemberSignature Language="C#" Value="public double NormalizedMutualInformation { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance float64 NormalizedMutualInformation" />
<MemberSignature Language="DocId" Value="P:Microsoft.ML.Data.ClusteringMetrics.NormalizedMutualInformation" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property NormalizedMutualInformation As Double" />
<MemberSignature Language="F#" Value="member this.NormalizedMutualInformation : double" Usage="Microsoft.ML.Data.ClusteringMetrics.NormalizedMutualInformation" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ML.Data</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Double</ReturnType>
</ReturnValue>
<Docs>
<summary>
Normalized Mutual Information is a measure of the mutual dependence of the variables.
This metric is only calculated if the Label column is provided.
</summary>
<value> Its value ranges from 0 to 1, where higher numbers are better.</value>
<remarks>
<a href="http://en.wikipedia.org/wiki/Mutual_information#Normalized_variants">Normalized variants.</a>
</remarks>
</Docs>
</Member>
</Members>
</Type>