Skip to content

Commit 5f7c566

Browse files
authored
Fixed the documentation issue for 'OneHotHashEncoding' method. (#3528)
1 parent 1e27b67 commit 5f7c566

File tree

1 file changed

+3
-4
lines changed

1 file changed

+3
-4
lines changed

src/Microsoft.ML.Transforms/CategoricalCatalog.cs

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -114,21 +114,20 @@ internal static OneHotEncodingEstimator OneHotEncoding(this TransformsCatalog.Ca
114114
/// Create a <see cref="OneHotHashEncodingEstimator"/>, which converts a text column specified by <paramref name="inputColumnName"/>
115115
/// into a hash-based one-hot encoded vector column named <paramref name="outputColumnName"/>.
116116
/// </summary>
117-
/// <param name="catalog">The transform catalog</param>
117+
/// <param name="catalog">The transform catalog.</param>
118118
/// <param name="outputColumnName">Name of the column resulting from the transformation of <paramref name="inputColumnName"/>.
119119
/// This column's data type will be a vector of <see cref="System.Single"/> if <paramref name="outputKind"/> is
120120
/// <see cref="OneHotEncodingEstimator.OutputKind.Bag"/>, <see cref="OneHotEncodingEstimator.OutputKind.Indicator"/>, and <see cref="OneHotEncodingEstimator.OutputKind.Binary"/>.
121121
/// If <paramref name="outputKind"/> is <see cref="OneHotEncodingEstimator.OutputKind.Key"/>, this column's data type will be a key in the case of a scalar input column
122-
/// or a vector of keys in the case of a vector input column.
122+
/// or a vector of keys in the case of a vector input column. </param>
123123
/// <param name="inputColumnName">Name of column to transform. If set to <see langword="null"/>, the value of the <paramref name="outputColumnName"/> will be used as source.
124124
/// This column's data type can be scalar or vector of numeric, text, boolean, <see cref="System.DateTime"/> or <see cref="System.DateTimeOffset"/>.</param>
125125
/// <param name="outputKind">The conversion mode.</param>
126126
/// <param name="numberOfBits">Number of bits to hash into. Must be between 1 and 30, inclusive.</param>
127127
/// <param name="seed">Hashing seed.</param>
128128
/// <param name="useOrderedHashing">Whether the position of each term should be included in the hash.</param>
129129
/// <param name="maximumNumberOfInverts">During hashing we constuct mappings between original values and the produced hash values.
130-
/// Text representation of original values are stored in the slot names of the metadata for the new column.Hashing,
131-
/// as such, can map many initial values to one.</param>
130+
/// Text representation of original values are stored in the slot names of the metadata for the new column.Hashing, as such, can map many initial values to one.
132131
/// <paramref name="maximumNumberOfInverts"/> specifies the upper bound of the number of distinct input values mapping to a hash that should be retained.
133132
/// <value>0</value> does not retain any input values. <value>-1</value> retains all input values mapping to each hash.</param>
134133
/// <example>

0 commit comments

Comments
 (0)