Skip to content

Commit 183def8

Browse files
committed
a few more doc strings
1 parent 29cd1ba commit 183def8

File tree

1 file changed

+19
-4
lines changed

1 file changed

+19
-4
lines changed

src/Microsoft.ML.Transforms/MissingValueReplacing.cs

+19-4
Original file line numberDiff line numberDiff line change
@@ -905,11 +905,26 @@ internal static class Defaults
905905
/// </summary>
906906
public sealed class ColumnInfo
907907
{
908+
/// <summary>
909+
/// The possible ways to replace missing values.
910+
/// </summary>
908911
public enum ReplacementMode : byte
909912
{
913+
/// <summary>
914+
/// Replace using default value.
915+
/// </summary>
910916
DefaultValue = 0,
917+
/// <summary>
918+
/// Replace using mean.
919+
/// </summary>
911920
Mean = 1,
921+
/// <summary>
922+
/// Replace using minimum
923+
/// </summary>
912924
Minimum = 2,
925+
/// <summary>
926+
/// Replace using maximum.
927+
/// </summary>
913928
Maximum = 3,
914929
}
915930

@@ -928,16 +943,18 @@ public enum ReplacementMode : byte
928943
/// </summary>
929944
public readonly bool ImputeBySlot;
930945
/// <summary>
931-
/// What to replace the missing value with.
946+
/// How to replace the missing values.
932947
/// </summary>
933948
public readonly ReplacementMode Replacement;
934949

950+
internal string ReplacementString { get; set; }
951+
935952
/// <summary>
936953
/// Describes how the transformer handles one column pair.
937954
/// </summary>
938955
/// <param name="name">Name of the column resulting from the transformation of <paramref name="inputColumnName"/>.</param>
939956
/// <param name="inputColumnName">Name of column to transform. If set to <see langword="null"/>, the value of the <paramref name="name"/> will be used as source.</param>
940-
/// <param name="replacementMode">What to replace the missing value with.</param>
957+
/// <param name="replacementMode">How to replace the missing values.</param>
941958
/// <param name="imputeBySlot">If true, per-slot imputation of replacement is performed.
942959
/// Otherwise, replacement value is imputed for the entire vector column. This setting is ignored for scalars and variable vectors,
943960
/// where imputation is always for the entire column.</param>
@@ -950,8 +967,6 @@ public ColumnInfo(string name, string inputColumnName = null, ReplacementMode re
950967
ImputeBySlot = imputeBySlot;
951968
Replacement = replacementMode;
952969
}
953-
954-
internal string ReplacementString { get; set; }
955970
}
956971

957972
private readonly IHost _host;

0 commit comments

Comments
 (0)