You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
/// <param name="columns">Array of columns <see cref="TextLoader.Column"/> defining the schema.</param>
23
23
/// <param name="separatorChar">The character used as separator between data points in a row. By default the tab character is used as separator.</param>
24
-
/// <param name="hasHeader">Whether the file has a header.</param>
24
+
/// <param name="hasHeader">Whether the file has a header with feature names. Note: If a TextLoader is created with hasHeader = true but without a
25
+
/// <paramref name="dataSample"/>, then vector columns made by TextLoader will not contain slot name annotations (slots being the elements of the given vector column),
26
+
/// because the output schema is made when the TextLoader is made, and not when <see cref="TextLoader.Load(IMultiStreamSource)"/> is called.
27
+
/// In addition, the case where dataSample = null and hasHeader = true indicates to the loader that when it is given a file when Load()
28
+
/// is called, it needs to skip the first line.</param>
25
29
/// <param name="dataSample">The optional location of a data sample. The sample can be used to infer column names and number of slots in each column.</param>
26
30
/// <param name="allowQuoting">Whether the file can contain columns defined by a quoted string.</param>
27
31
/// <param name="trimWhitespace">Remove trailing whitespace from lines</param>
@@ -67,7 +71,11 @@ public static TextLoader CreateTextLoader(this DataOperationsCatalog catalog,
67
71
/// names and their data types in the schema of the loaded data.</typeparam>
/// <param name="separatorChar">Column separator character. Default is '\t'</param>
70
-
/// <param name="hasHeader">Does the file contains header?</param>
74
+
/// <param name="hasHeader">Whether the file has a header with feature names. Note: If a TextLoader is created with hasHeader = true but without a
75
+
/// <paramref name="dataSample"/>, then vector columns made by TextLoader will not contain slot name annotations (slots being the elements of the given vector column),
76
+
/// because the output schema is made when the TextLoader is made, and not when <see cref="TextLoader.Load(IMultiStreamSource)"/> is called.
77
+
/// In addition, the case where dataSample = null and hasHeader = true indicates to the loader that when it is given a file when Load()
78
+
/// is called, it needs to skip the first line.</param>
71
79
/// <param name="dataSample">The optional location of a data sample. The sample can be used to infer information
72
80
/// about the columns, such as slot names.</param>
73
81
/// <param name="allowQuoting">Whether the input may include quoted values,
@@ -97,7 +105,11 @@ public static TextLoader CreateTextLoader<TInput>(this DataOperationsCatalog cat
97
105
/// <param name="path">The path to the file.</param>
98
106
/// <param name="columns">The columns of the schema.</param>
99
107
/// <param name="separatorChar">The character used as separator between data points in a row. By default the tab character is used as separator.</param>
100
-
/// <param name="hasHeader">Whether the file has a header.</param>
108
+
/// <param name="hasHeader">Whether the file has a header with feature names. Note: If a TextLoader is created with hasHeader = true but without a
109
+
/// dataSample, then vector columns made by TextLoader will not contain slot name annotations (slots being the elements of the given vector column),
110
+
/// because the output schema is made when the TextLoader is made, and not when <see cref="TextLoader.Load(IMultiStreamSource)"/> is called.
111
+
/// In addition, the case where dataSample = null and hasHeader = true indicates to the loader that when it is given a file when Load()
112
+
/// is called, it needs to skip the first line.</param>
101
113
/// <param name="allowQuoting">Whether the file can contain columns defined by a quoted string.</param>
102
114
/// <param name="trimWhitespace">Remove trailing whitespace from lines</param>
103
115
/// <param name="allowSparse">Whether the file can contain numerical vectors in sparse format.</param>
@@ -138,7 +150,11 @@ public static IDataView LoadFromTextFile(this DataOperationsCatalog catalog,
0 commit comments