Skip to content

Commit e192a18

Browse files
najeeb-kazmiIvanidzo4ka
authored andcommitted
Make KeyToValueMapping API consistent (#2426)
1 parent e08a329 commit e192a18

File tree

2 files changed

+8
-7
lines changed

2 files changed

+8
-7
lines changed

src/Microsoft.ML.Data/Transforms/ConversionsExtensionsCatalog.cs

+4-3
Original file line numberDiff line numberDiff line change
@@ -62,15 +62,16 @@ public static TypeConvertingEstimator ConvertType(this TransformsCatalog.Convers
6262
/// Convert the key types back to their original values.
6363
/// </summary>
6464
/// <param name="catalog">The categorical transform's catalog.</param>
65-
/// <param name="inputColumnName">Name of the column to transform.</param>
65+
/// <param name="outputColumnName">Name of the column resulting from the transformation of <paramref name="inputColumnName"/>.</param>
66+
/// <param name="inputColumnName">Name of the column to transform. If set to <see langword="null"/>, the value of the <paramref name="outputColumnName"/> will be used as source.</param>
6667
/// <example>
6768
/// <format type="text/markdown">
6869
/// <![CDATA[
6970
/// [!code-csharp[KeyToValueMappingEstimator](~/../docs/samples/docs/samples/Microsoft.ML.Samples/Dynamic/ValueMappingStringToKeyType.cs)]
7071
/// ]]></format>
7172
/// </example>
72-
public static KeyToValueMappingEstimator MapKeyToValue(this TransformsCatalog.ConversionTransforms catalog, string inputColumnName)
73-
=> new KeyToValueMappingEstimator(CatalogUtils.GetEnvironment(catalog), inputColumnName);
73+
public static KeyToValueMappingEstimator MapKeyToValue(this TransformsCatalog.ConversionTransforms catalog, string outputColumnName, string inputColumnName = null)
74+
=> new KeyToValueMappingEstimator(CatalogUtils.GetEnvironment(catalog), outputColumnName, inputColumnName);
7475

7576
/// <summary>
7677
/// Convert the key types (name of the column specified in the first item of the tuple) back to their original values

src/Microsoft.ML.Data/Transforms/KeyToValue.cs

+4-4
Original file line numberDiff line numberDiff line change
@@ -87,8 +87,8 @@ private static VersionInfo GetVersionInfo()
8787
/// <summary>
8888
/// Create a <see cref="KeyToValueMappingTransformer"/> that takes and transforms one column.
8989
/// </summary>
90-
internal KeyToValueMappingTransformer(IHostEnvironment env, string columnName)
91-
: this(env, (columnName, columnName))
90+
internal KeyToValueMappingTransformer(IHostEnvironment env, string outputColumnName, string inputColumnName = null)
91+
: this(env, (outputColumnName, inputColumnName ?? outputColumnName))
9292
{
9393
}
9494

@@ -507,8 +507,8 @@ public override JToken SavePfa(BoundPfaContext ctx, JToken srcToken)
507507

508508
public sealed class KeyToValueMappingEstimator : TrivialEstimator<KeyToValueMappingTransformer>
509509
{
510-
internal KeyToValueMappingEstimator(IHostEnvironment env, string columnName)
511-
: base(Contracts.CheckRef(env, nameof(env)).Register(nameof(KeyToValueMappingEstimator)), new KeyToValueMappingTransformer(env, columnName))
510+
internal KeyToValueMappingEstimator(IHostEnvironment env, string outputColumnName, string inputColumnName = null)
511+
: base(Contracts.CheckRef(env, nameof(env)).Register(nameof(KeyToValueMappingEstimator)), new KeyToValueMappingTransformer(env, outputColumnName, inputColumnName ?? outputColumnName))
512512
{
513513
}
514514

0 commit comments

Comments
 (0)