Skip to content

Commit 1d924ae

Browse files
committed
applying the dotnet#3204 template to columnCopying.
1 parent 43d4c18 commit 1d924ae

File tree

2 files changed

+23
-5
lines changed

2 files changed

+23
-5
lines changed

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

+15-1
Original file line numberDiff line numberDiff line change
@@ -31,8 +31,18 @@
3131
namespace Microsoft.ML.Transforms
3232
{
3333
/// <summary>
34-
/// <see cref="ColumnCopyingEstimator"/> copies the input column to another column named as specified in the parameters of the transformation.
34+
/// Estimator creating the <see cref="ColumnCopyingTransformer"/>.
3535
/// </summary>
36+
/// <remarks>
37+
/// <format type="text/markdown"><![CDATA[
38+
/// ### Estimator FAQ
39+
/// | Question | Answer |
40+
/// | -- | -- |
41+
/// | Does this estimator need to look at the data to train its parameters? | No |
42+
/// | Is the transformer created convertible to ONNX format? | Yes |
43+
/// ]]>
44+
/// </format>
45+
/// </remarks>
3646
public sealed class ColumnCopyingEstimator : TrivialEstimator<ColumnCopyingTransformer>
3747
{
3848
[BestFriend]
@@ -67,6 +77,10 @@ public override SchemaShape GetOutputSchema(SchemaShape inputSchema)
6777
}
6878
}
6979

80+
/// <summary>
81+
/// Transformer that creates a new column, named as specified in the output column name parameters, and
82+
/// copies the data from the input column Name.
83+
/// </summary>
7084
public sealed class ColumnCopyingTransformer : OneToOneTransformerBase
7185
{
7286
[BestFriend]

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

+8-4
Original file line numberDiff line numberDiff line change
@@ -51,11 +51,13 @@ internal static IReadOnlyList<InputOutputColumnPair> ConvertFromValueTuples((str
5151
public static class TransformExtensionsCatalog
5252
{
5353
/// <summary>
54-
/// Copies the input column to another column named as specified in <paramref name="outputColumnName"/>.
54+
/// Creates a <see cref="ColumnCopyingEstimator"/> that copies the data from the column specified in <paramref name="inputColumnName"/>
55+
/// to a new column: <paramref name="outputColumnName"/>.
5556
/// </summary>
57+
/// <remarks>For more information on this estimator see <see cref="ColumnCopyingEstimator"/>.</remarks>
5658
/// <param name="catalog">The transform's catalog.</param>
5759
/// <param name="outputColumnName">Name of the column resulting from the transformation of <paramref name="inputColumnName"/>.</param>
58-
/// <param name="inputColumnName">Name of the columns to transform.</param>
60+
/// <param name="inputColumnName">Name of the column to copy the data from.</param>
5961
/// <example>
6062
/// <format type="text/markdown">
6163
/// <![CDATA[
@@ -67,9 +69,11 @@ public static ColumnCopyingEstimator CopyColumns(this TransformsCatalog catalog,
6769
=> new ColumnCopyingEstimator(CatalogUtils.GetEnvironment(catalog), outputColumnName, inputColumnName);
6870

6971
/// <summary>
70-
/// Copies the input column, name specified in the first item of the tuple,
71-
/// to another column, named as specified in the second item of the tuple.
72+
/// Creates a <see cref="ColumnCopyingEstimator"/> that copies the data from the column specified in <see cref="InputOutputColumnPair.InputColumnName" />
73+
/// to a new column: <see cref="InputOutputColumnPair.OutputColumnName" />.
7274
/// </summary>
75+
/// <remarks>This estimator can operate over several columns.
76+
/// For more information on this estimator see <see cref="ColumnCopyingEstimator"/>.</remarks>
7377
/// <param name="catalog">The transform's catalog</param>
7478
/// <param name="columns">The pairs of input and output columns.</param>
7579
/// <example>

0 commit comments

Comments
 (0)