Skip to content

Commit cc0956b

Browse files
author
Rogan Carr
committed
work in progress
1 parent 3eccc93 commit cc0956b

File tree

1 file changed

+18
-2
lines changed

1 file changed

+18
-2
lines changed

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

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ public static ColumnCopyingEstimator CopyColumns(this TransformsCatalog catalog,
5353
/// <example>
5454
/// <format type="text/markdown">
5555
/// <![CDATA[
56-
/// [!code-csharp[Concat](~/../docs/samples/docs/samples/Microsoft.ML.Samples/Dynamic/Transforms/ConcatTransform.cs)]
56+
/// [!code-csharp[Concat](~/../docs/samples/docs/samples/Microsoft.ML.Samples/Dynamic/Transforms/Concatenate.cs)]
5757
/// ]]>
5858
/// </format>
5959
/// </example>
@@ -70,11 +70,27 @@ public static ColumnSelectingEstimator DropColumns(this TransformsCatalog catalo
7070
=> ColumnSelectingEstimator.DropColumns(CatalogUtils.GetEnvironment(catalog), columnsToDrop);
7171

7272
/// <summary>
73-
/// ColumnSelectingEstimator is used to select a list of columns that user wants to drop from a given input.
73+
/// ColumnSelectingEstimator is used to select a list of columns that user wants to keep from a given input.
7474
/// </summary>
75+
/// <remarks>
76+
/// <format type="text/markdown">
77+
/// <see cref="SelectColumns"/> operates on the schema of an input IDataView,
78+
/// either dropping unselected columns from the schema or keeping them but hiding them from the user. Keeping columns hidden
79+
/// is recommended when it is necessary to understand how the inputs of a pipeline map to outputs of the pipeline. This feature
80+
/// is used, for example, in saving models so that the model can be easily debugged at a later time. For more information,
81+
/// please refer to [IDataView Design Principles](~/../docs/samples/docs/code/IDataViewDesignPrinciples.md).
82+
/// </format>
83+
/// </remarks>
7584
/// <param name="catalog">The transform's catalog.</param>
7685
/// <param name="keepColumns">The array of column names to keep.</param>
7786
/// <param name="keepHidden">If true will keep hidden columns and false will remove hidden columns.</param>
87+
/// <example>
88+
/// <format type="text/markdown">
89+
/// <![CDATA[
90+
/// [!code-csharp[Concat](~/../docs/samples/docs/samples/Microsoft.ML.Samples/Dynamic/Transforms/SelectColumns.cs)]
91+
/// ]]>
92+
/// </format>
93+
/// </example>
7894
public static ColumnSelectingEstimator SelectColumns(this TransformsCatalog catalog,
7995
string[] keepColumns,
8096
bool keepHidden = ColumnSelectingTransformer.Defaults.KeepHidden)

0 commit comments

Comments
 (0)