Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

more transform => transformer renaming #1590

Merged
merged 6 commits into from
Nov 12, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 24 additions & 24 deletions src/Microsoft.ML.Legacy/CSharpApi.cs
Original file line number Diff line number Diff line change
Expand Up @@ -14781,7 +14781,7 @@ public MinMaxNormalizerPipelineStep(Output output)

namespace Legacy.Transforms
{
public enum NAHandleTransformReplacementKind : byte
public enum MissingValueHandlingTransformerReplacementKind : byte
{
DefaultValue = 0,
Mean = 1,
Expand All @@ -14790,12 +14790,12 @@ public enum NAHandleTransformReplacementKind : byte
}


public sealed partial class NAHandleTransformColumn : OneToOneColumn<NAHandleTransformColumn>, IOneToOneColumn
public sealed partial class MissingValueHandlingTransformerColumn : OneToOneColumn<MissingValueHandlingTransformerColumn>, IOneToOneColumn
{
/// <summary>
/// The replacement method to utilize
/// </summary>
public NAHandleTransformReplacementKind? Kind { get; set; }
public MissingValueHandlingTransformerReplacementKind? Kind { get; set; }

/// <summary>
/// Whether to impute values by slot
Expand Down Expand Up @@ -14852,28 +14852,28 @@ public MissingValueHandler(params (string inputColumn, string outputColumn)[] in

public void AddColumn(string inputColumn)
{
var list = Column == null ? new List<Microsoft.ML.Legacy.Transforms.NAHandleTransformColumn>() : new List<Microsoft.ML.Legacy.Transforms.NAHandleTransformColumn>(Column);
list.Add(OneToOneColumn<Microsoft.ML.Legacy.Transforms.NAHandleTransformColumn>.Create(inputColumn));
var list = Column == null ? new List<Microsoft.ML.Legacy.Transforms.MissingValueHandlingTransformerColumn>() : new List<Microsoft.ML.Legacy.Transforms.MissingValueHandlingTransformerColumn>(Column);
list.Add(OneToOneColumn<Microsoft.ML.Legacy.Transforms.MissingValueHandlingTransformerColumn>.Create(inputColumn));
Column = list.ToArray();
}

public void AddColumn(string outputColumn, string inputColumn)
{
var list = Column == null ? new List<Microsoft.ML.Legacy.Transforms.NAHandleTransformColumn>() : new List<Microsoft.ML.Legacy.Transforms.NAHandleTransformColumn>(Column);
list.Add(OneToOneColumn<Microsoft.ML.Legacy.Transforms.NAHandleTransformColumn>.Create(outputColumn, inputColumn));
var list = Column == null ? new List<Microsoft.ML.Legacy.Transforms.MissingValueHandlingTransformerColumn>() : new List<Microsoft.ML.Legacy.Transforms.MissingValueHandlingTransformerColumn>(Column);
list.Add(OneToOneColumn<Microsoft.ML.Legacy.Transforms.MissingValueHandlingTransformerColumn>.Create(outputColumn, inputColumn));
Column = list.ToArray();
}


/// <summary>
/// New column definition(s) (optional form: name:rep:src)
/// </summary>
public NAHandleTransformColumn[] Column { get; set; }
public MissingValueHandlingTransformerColumn[] Column { get; set; }

/// <summary>
/// The replacement method to utilize
/// </summary>
public NAHandleTransformReplacementKind ReplaceWith { get; set; } = NAHandleTransformReplacementKind.DefaultValue;
public MissingValueHandlingTransformerReplacementKind ReplaceWith { get; set; } = MissingValueHandlingTransformerReplacementKind.DefaultValue;

/// <summary>
/// Whether to impute values by slot
Expand Down Expand Up @@ -15056,7 +15056,7 @@ public MissingValueIndicatorPipelineStep(Output output)
namespace Legacy.Transforms
{

public sealed partial class NADropTransformColumn : OneToOneColumn<NADropTransformColumn>, IOneToOneColumn
public sealed partial class MissingValueDroppingTransformerColumn : OneToOneColumn<MissingValueDroppingTransformerColumn>, IOneToOneColumn
{
/// <summary>
/// Name of the new column
Expand Down Expand Up @@ -15103,23 +15103,23 @@ public MissingValuesDropper(params (string inputColumn, string outputColumn)[] i

public void AddColumn(string inputColumn)
{
var list = Column == null ? new List<Microsoft.ML.Legacy.Transforms.NADropTransformColumn>() : new List<Microsoft.ML.Legacy.Transforms.NADropTransformColumn>(Column);
list.Add(OneToOneColumn<Microsoft.ML.Legacy.Transforms.NADropTransformColumn>.Create(inputColumn));
var list = Column == null ? new List<Microsoft.ML.Legacy.Transforms.MissingValueDroppingTransformerColumn>() : new List<Microsoft.ML.Legacy.Transforms.MissingValueDroppingTransformerColumn>(Column);
list.Add(OneToOneColumn<Microsoft.ML.Legacy.Transforms.MissingValueDroppingTransformerColumn>.Create(inputColumn));
Column = list.ToArray();
}

public void AddColumn(string outputColumn, string inputColumn)
{
var list = Column == null ? new List<Microsoft.ML.Legacy.Transforms.NADropTransformColumn>() : new List<Microsoft.ML.Legacy.Transforms.NADropTransformColumn>(Column);
list.Add(OneToOneColumn<Microsoft.ML.Legacy.Transforms.NADropTransformColumn>.Create(outputColumn, inputColumn));
var list = Column == null ? new List<Microsoft.ML.Legacy.Transforms.MissingValueDroppingTransformerColumn>() : new List<Microsoft.ML.Legacy.Transforms.MissingValueDroppingTransformerColumn>(Column);
list.Add(OneToOneColumn<Microsoft.ML.Legacy.Transforms.MissingValueDroppingTransformerColumn>.Create(outputColumn, inputColumn));
Column = list.ToArray();
}


/// <summary>
/// Columns to drop the NAs for
/// </summary>
public NADropTransformColumn[] Column { get; set; }
public MissingValueDroppingTransformerColumn[] Column { get; set; }

/// <summary>
/// Input dataset
Expand Down Expand Up @@ -15242,7 +15242,7 @@ public MissingValuesRowDropperPipelineStep(Output output)

namespace Legacy.Transforms
{
public enum NAReplaceTransformReplacementKind : byte
public enum MissingValueReplacingTransformerReplacementKind : byte
{
DefaultValue = 0,
Mean = 1,
Expand All @@ -15252,7 +15252,7 @@ public enum NAReplaceTransformReplacementKind : byte
}


public sealed partial class NAReplaceTransformColumn : OneToOneColumn<NAReplaceTransformColumn>, IOneToOneColumn
public sealed partial class MissingValueReplacingTransformerColumn : OneToOneColumn<MissingValueReplacingTransformerColumn>, IOneToOneColumn
{
/// <summary>
/// Replacement value for NAs (uses default value if not given)
Expand All @@ -15262,7 +15262,7 @@ public sealed partial class NAReplaceTransformColumn : OneToOneColumn<NAReplaceT
/// <summary>
/// The replacement method to utilize
/// </summary>
public NAReplaceTransformReplacementKind? Kind { get; set; }
public MissingValueReplacingTransformerReplacementKind? Kind { get; set; }

/// <summary>
/// Whether to impute values by slot
Expand Down Expand Up @@ -15314,28 +15314,28 @@ public MissingValueSubstitutor(params (string inputColumn, string outputColumn)[

public void AddColumn(string inputColumn)
{
var list = Column == null ? new List<Microsoft.ML.Legacy.Transforms.NAReplaceTransformColumn>() : new List<Microsoft.ML.Legacy.Transforms.NAReplaceTransformColumn>(Column);
list.Add(OneToOneColumn<Microsoft.ML.Legacy.Transforms.NAReplaceTransformColumn>.Create(inputColumn));
var list = Column == null ? new List<Microsoft.ML.Legacy.Transforms.MissingValueReplacingTransformerColumn>() : new List<Microsoft.ML.Legacy.Transforms.MissingValueReplacingTransformerColumn>(Column);
list.Add(OneToOneColumn<Microsoft.ML.Legacy.Transforms.MissingValueReplacingTransformerColumn>.Create(inputColumn));
Column = list.ToArray();
}

public void AddColumn(string outputColumn, string inputColumn)
{
var list = Column == null ? new List<Microsoft.ML.Legacy.Transforms.NAReplaceTransformColumn>() : new List<Microsoft.ML.Legacy.Transforms.NAReplaceTransformColumn>(Column);
list.Add(OneToOneColumn<Microsoft.ML.Legacy.Transforms.NAReplaceTransformColumn>.Create(outputColumn, inputColumn));
var list = Column == null ? new List<Microsoft.ML.Legacy.Transforms.MissingValueReplacingTransformerColumn>() : new List<Microsoft.ML.Legacy.Transforms.MissingValueReplacingTransformerColumn>(Column);
list.Add(OneToOneColumn<Microsoft.ML.Legacy.Transforms.MissingValueReplacingTransformerColumn>.Create(outputColumn, inputColumn));
Column = list.ToArray();
}


/// <summary>
/// New column definition(s) (optional form: name:rep:src)
/// </summary>
public NAReplaceTransformColumn[] Column { get; set; }
public MissingValueReplacingTransformerColumn[] Column { get; set; }

/// <summary>
/// The replacement method to utilize
/// </summary>
public NAReplaceTransformReplacementKind ReplacementKind { get; set; } = NAReplaceTransformReplacementKind.DefaultValue;
public MissingValueReplacingTransformerReplacementKind ReplacementKind { get; set; } = MissingValueReplacingTransformerReplacementKind.DefaultValue;

/// <summary>
/// Whether to impute values by slot
Expand Down
2 changes: 1 addition & 1 deletion src/Microsoft.ML.PipelineInference/TransformInference.cs
Original file line number Diff line number Diff line change
Expand Up @@ -1292,7 +1292,7 @@ public override IEnumerable<SuggestedTransform> Apply(IntermediateColumn[] colum
{
Column = new[]
{
new ML.Legacy.Transforms.NAHandleTransformColumn
new ML.Legacy.Transforms.MissingValueHandlingTransformerColumn
{
Name = name,
Source = name
Expand Down
6 changes: 3 additions & 3 deletions src/Microsoft.ML.Transforms/ExtensionsCatalog.cs
Original file line number Diff line number Diff line change
Expand Up @@ -41,19 +41,19 @@ public static class MissingValueReplacerCatalog
/// <param name="inputColumn">The name of the input column.</param>
/// <param name="outputColumn">The optional name of the output column,
/// If not provided, the <paramref name="inputColumn"/> will be replaced with the results of the transforms.</param>
/// <param name="replacementKind">The type of replacement to use as specified in <see cref="NAReplaceTransform.ColumnInfo.ReplacementMode"/></param>
/// <param name="replacementKind">The type of replacement to use as specified in <see cref="MissingValueReplacingTransformer.ColumnInfo.ReplacementMode"/></param>
public static MissingValueReplacingEstimator ReplaceMissingValues(this TransformsCatalog catalog,
string inputColumn,
string outputColumn = null,
NAReplaceTransform.ColumnInfo.ReplacementMode replacementKind = MissingValueReplacingEstimator.Defaults.ReplacementMode)
MissingValueReplacingTransformer.ColumnInfo.ReplacementMode replacementKind = MissingValueReplacingEstimator.Defaults.ReplacementMode)
=> new MissingValueReplacingEstimator(CatalogUtils.GetEnvironment(catalog), inputColumn, outputColumn, replacementKind);

/// <summary>
/// Initializes a new instance of <see cref="MissingValueReplacingEstimator"/>
/// </summary>
/// <param name="catalog">The transform's catalog.</param>
/// <param name="columns">The name of the columns to use, and per-column transformation configuraiton.</param>
public static MissingValueReplacingEstimator ReplaceMissingValues(this TransformsCatalog catalog, params NAReplaceTransform.ColumnInfo[] columns)
public static MissingValueReplacingEstimator ReplaceMissingValues(this TransformsCatalog catalog, params MissingValueReplacingTransformer.ColumnInfo[] columns)
=> new MissingValueReplacingEstimator(CatalogUtils.GetEnvironment(catalog), columns);
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,16 +13,16 @@
using Microsoft.ML.Runtime.Internal.Utilities;
using Microsoft.ML.Runtime.Model;

[assembly: LoadableClass(NADropTransform.Summary, typeof(NADropTransform), typeof(NADropTransform.Arguments), typeof(SignatureDataTransform),
NADropTransform.FriendlyName, NADropTransform.ShortName, "NADropTransform")]
[assembly: LoadableClass(MissingValueDroppingTransformer.Summary, typeof(MissingValueDroppingTransformer), typeof(MissingValueDroppingTransformer.Arguments), typeof(SignatureDataTransform),
MissingValueDroppingTransformer.FriendlyName, MissingValueDroppingTransformer.ShortName, "NADropTransform")]

[assembly: LoadableClass(NADropTransform.Summary, typeof(NADropTransform), null, typeof(SignatureLoadDataTransform),
NADropTransform.FriendlyName, NADropTransform.LoaderSignature)]
[assembly: LoadableClass(MissingValueDroppingTransformer.Summary, typeof(MissingValueDroppingTransformer), null, typeof(SignatureLoadDataTransform),
MissingValueDroppingTransformer.FriendlyName, MissingValueDroppingTransformer.LoaderSignature)]

namespace Microsoft.ML.Runtime.Data
{
/// <include file='doc.xml' path='doc/members/member[@name="NADrop"]'/>
Copy link
Contributor

@Ivanidzo4ka Ivanidzo4ka Nov 12, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

NADrop [](start = 64, length = 6)

nit: these names can potentially backfire, but I'm don't know what our plans for them, and documentation in general. #Pending

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

documentation needs to be scrubbed from the term transform, and adapted to transformer/estimator. Didn't want to bundle those changes together with the renames, because the renames have to finish on this release.


In reply to: 232742005 [](ancestors = 232742005)

public sealed class NADropTransform : OneToOneTransformBase
public sealed class MissingValueDroppingTransformer : OneToOneTransformBase
{
public sealed class Arguments : TransformInputBase
{
Expand Down Expand Up @@ -60,7 +60,7 @@ private static VersionInfo GetVersionInfo()
verReadableCur: 0x00010001,
verWeCanReadBack: 0x00010001,
loaderSignature: LoaderSignature,
loaderAssemblyName: typeof(NADropTransform).Assembly.FullName);
loaderAssemblyName: typeof(MissingValueDroppingTransformer).Assembly.FullName);
}

private const string RegistrationName = "DropNAs";
Expand All @@ -75,12 +75,12 @@ private static VersionInfo GetVersionInfo()
/// <param name="input">Input <see cref="IDataView"/>. This is the output from previous transform or loader.</param>
/// <param name="name">Name of the output column.</param>
/// <param name="source">Name of the column to be transformed. If this is null '<paramref name="name"/>' will be used.</param>
public NADropTransform(IHostEnvironment env, IDataView input, string name, string source = null)
public MissingValueDroppingTransformer(IHostEnvironment env, IDataView input, string name, string source = null)
: this(env, new Arguments() { Column = new[] { new Column() { Source = source ?? name, Name = name } } }, input)
{
}

public NADropTransform(IHostEnvironment env, Arguments args, IDataView input)
public MissingValueDroppingTransformer(IHostEnvironment env, Arguments args, IDataView input)
: base(Contracts.CheckRef(env, nameof(env)), RegistrationName, env.CheckRef(args, nameof(args)).Column, input, TestType)
{
Host.CheckNonEmpty(args.Column, nameof(args.Column));
Expand Down Expand Up @@ -147,17 +147,17 @@ private static string TestType<T>(ColumnType type)
return null;
}

public static NADropTransform Create(IHostEnvironment env, ModelLoadContext ctx, IDataView input)
public static MissingValueDroppingTransformer Create(IHostEnvironment env, ModelLoadContext ctx, IDataView input)
{
Contracts.CheckValue(env, nameof(env));
var h = env.Register(RegistrationName);
h.CheckValue(ctx, nameof(ctx));
h.CheckValue(input, nameof(input));
ctx.CheckAtModel(GetVersionInfo());
return h.Apply("Loading Model", ch => new NADropTransform(h, ctx, input));
return h.Apply("Loading Model", ch => new MissingValueDroppingTransformer(h, ctx, input));
}

private NADropTransform(IHost host, ModelLoadContext ctx, IDataView input)
private MissingValueDroppingTransformer(IHost host, ModelLoadContext ctx, IDataView input)
: base(host, ctx, input, TestType)
{
Host.AssertValue(ctx);
Expand Down
Loading