@@ -53,7 +53,7 @@ public static ColumnCopyingEstimator CopyColumns(this TransformsCatalog catalog,
53
53
/// <example>
54
54
/// <format type="text/markdown">
55
55
/// <]
56
+ /// [!code-csharp[Concat](~/../docs/samples/docs/samples/Microsoft.ML.Samples/Dynamic/Transforms/Concatenate .cs)]
57
57
/// ]]>
58
58
/// </format>
59
59
/// </example>
@@ -70,11 +70,27 @@ public static ColumnSelectingEstimator DropColumns(this TransformsCatalog catalo
70
70
=> ColumnSelectingEstimator . DropColumns ( CatalogUtils . GetEnvironment ( catalog ) , columnsToDrop ) ;
71
71
72
72
/// <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.
74
74
/// </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>
75
84
/// <param name="catalog">The transform's catalog.</param>
76
85
/// <param name="keepColumns">The array of column names to keep.</param>
77
86
/// <param name="keepHidden">If true will keep hidden columns and false will remove hidden columns.</param>
87
+ /// <example>
88
+ /// <format type="text/markdown">
89
+ /// <]
91
+ /// ]]>
92
+ /// </format>
93
+ /// </example>
78
94
public static ColumnSelectingEstimator SelectColumns ( this TransformsCatalog catalog ,
79
95
string [ ] keepColumns ,
80
96
bool keepHidden = ColumnSelectingTransformer . Defaults . KeepHidden )
0 commit comments