Skip to content

Commit 61ab00e

Browse files
najeeb-kazminajeeb-kazmi
authored
Rename CreateTextReader to CreateTextLoader (#2125)
* Rename CreateTextReader to CreateTextLoader * Updating doc strings
1 parent cabf55b commit 61ab00e

File tree

21 files changed

+37
-37
lines changed

21 files changed

+37
-37
lines changed

‎docs/samples/Microsoft.ML.Samples/Dynamic/Calibrator.cs

+1-1
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ public static void Calibration()
2828
var mlContext = new MLContext();
2929

3030
// Create a text loader.
31-
var reader = mlContext.Data.CreateTextReader(new TextLoader.Arguments()
31+
var reader = mlContext.Data.CreateTextLoader(new TextLoader.Arguments()
3232
{
3333
Separator = "tab",
3434
HasHeader = true,

‎docs/samples/Microsoft.ML.Samples/Dynamic/FeatureContributionCalculationTransform.cs

+1-1
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ public static void FeatureContributionCalculationTransform_Regression()
1818

1919
// Step 1: Read the data as an IDataView.
2020
// First, we define the reader: specify the data columns and where to find them in the text file.
21-
var reader = mlContext.Data.CreateTextReader(
21+
var reader = mlContext.Data.CreateTextLoader(
2222
columns: new[]
2323
{
2424
new TextLoader.Column("MedianHomeValue", DataKind.R4, 0),

‎docs/samples/Microsoft.ML.Samples/Dynamic/FeatureSelectionTransform.cs

+1-1
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ public static void FeatureSelectionTransform()
3030

3131
// First, we define the reader: specify the data columns and where to find them in the text file. Notice that we combine entries from
3232
// all the feature columns into entries of a vector of a single column named "Features".
33-
var reader = ml.Data.CreateTextReader(
33+
var reader = ml.Data.CreateTextLoader(
3434
columns: new[]
3535
{
3636
new TextLoader.Column("Label", DataKind.BL, 0),

‎docs/samples/Microsoft.ML.Samples/Dynamic/FieldAwareFactorizationMachine.cs

+1-1
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ public static void FFM_BinaryClassification()
2222

2323
// Step 1: Read the data as an IDataView.
2424
// First, we define the reader: specify the data columns and where to find them in the text file.
25-
var reader = mlContext.Data.CreateTextReader(
25+
var reader = mlContext.Data.CreateTextLoader(
2626
columns: new[]
2727
{
2828
new TextLoader.Column("Sentiment", DataKind.BL, 0),

‎docs/samples/Microsoft.ML.Samples/Dynamic/GeneralizedAdditiveModels.cs

+1-1
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ public static void RunExample()
1919

2020
// Step 1: Read the data as an IDataView.
2121
// First, we define the reader: specify the data columns and where to find them in the text file.
22-
var reader = mlContext.Data.CreateTextReader(
22+
var reader = mlContext.Data.CreateTextLoader(
2323
columns: new[]
2424
{
2525
new TextLoader.Column("MedianHomeValue", DataKind.R4, 0),

‎docs/samples/Microsoft.ML.Samples/Dynamic/PermutationFeatureImportance/PFIHelper.cs

+1-1
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ public static IDataView GetHousingRegressionIDataView(MLContext mlContext, out s
1919
// First, we define the reader: specify the data columns and where to find them in the text file.
2020
// The data file is composed of rows of data, with each row having 11 numerical columns
2121
// separated by whitespace.
22-
var reader = mlContext.Data.CreateTextReader(
22+
var reader = mlContext.Data.CreateTextLoader(
2323
columns: new[]
2424
{
2525
// Read the first column (indexed by 0) in the data file as an R4 (float)

‎docs/samples/Microsoft.ML.Samples/Dynamic/SDCA.cs

+1-1
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ public static void SDCA_BinaryClassification()
2424

2525
// Step 1: Read the data as an IDataView.
2626
// First, we define the reader: specify the data columns and where to find them in the text file.
27-
var reader = mlContext.Data.CreateTextReader(
27+
var reader = mlContext.Data.CreateTextLoader(
2828
columns: new[]
2929
{
3030
new TextLoader.Column("Sentiment", DataKind.BL, 0),

‎src/Microsoft.ML.Data/DataLoadSave/Text/TextLoaderSaverCatalog.cs

+9-9
Original file line numberDiff line numberDiff line change
@@ -11,33 +11,33 @@ namespace Microsoft.ML
1111
public static class TextLoaderSaverCatalog
1212
{
1313
/// <summary>
14-
/// Create a text reader <see cref="TextLoader"/>.
14+
/// Create a text loader <see cref="TextLoader"/>.
1515
/// </summary>
1616
/// <param name="catalog">The <see cref="DataOperations"/> catalog.</param>
17-
/// <param name="columns">The columns of the schema.</param>
17+
/// <param name="columns">Array of columns <see cref="TextLoader.Column"/> defining the schema.</param>
1818
/// <param name="hasHeader">Whether the file has a header.</param>
1919
/// <param name="separatorChar">The character used as separator between data points in a row. By default the tab character is used as separator.</param>
20-
/// <param name="dataSample">The optional location of a data sample.</param>
21-
public static TextLoader CreateTextReader(this DataOperations catalog,
20+
/// <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>
21+
public static TextLoader CreateTextLoader(this DataOperations catalog,
2222
TextLoader.Column[] columns,
2323
bool hasHeader = TextLoader.DefaultArguments.HasHeader,
2424
char separatorChar = TextLoader.DefaultArguments.Separator,
2525
IMultiStreamSource dataSample = null)
2626
=> new TextLoader(CatalogUtils.GetEnvironment(catalog), columns, hasHeader, separatorChar, dataSample);
2727

2828
/// <summary>
29-
/// Create a text reader <see cref="TextLoader"/>.
29+
/// Create a text loader <see cref="TextLoader"/>.
3030
/// </summary>
3131
/// <param name="catalog">The <see cref="DataOperations"/> catalog.</param>
3232
/// <param name="args">Defines the settings of the load operation.</param>
33-
/// <param name="dataSample">Allows to expose items that can be used for reading.</param>
34-
public static TextLoader CreateTextReader(this DataOperations catalog,
33+
/// <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>
34+
public static TextLoader CreateTextLoader(this DataOperations catalog,
3535
TextLoader.Arguments args,
3636
IMultiStreamSource dataSample = null)
3737
=> new TextLoader(CatalogUtils.GetEnvironment(catalog), args, dataSample);
3838

3939
/// <summary>
40-
/// Create a text reader <see cref="TextLoader"/> by inferencing the dataset schema from a data model type.
40+
/// Create a text loader <see cref="TextLoader"/> by inferencing the dataset schema from a data model type.
4141
/// </summary>
4242
/// <param name="catalog">The <see cref="DataOperations"/> catalog.</param>
4343
/// <param name="hasHeader">Does the file contains header?</param>
@@ -51,7 +51,7 @@ public static TextLoader CreateTextReader(this DataOperations catalog,
5151
/// if one of the row contains "5 2:6 4:3" that's mean there are 5 columns all zero
5252
/// except for 3rd and 5th columns which have values 6 and 3</param>
5353
/// <param name="trimWhitespace">Remove trailing whitespace from lines</param>
54-
public static TextLoader CreateTextReader<TInput>(this DataOperations catalog,
54+
public static TextLoader CreateTextLoader<TInput>(this DataOperations catalog,
5555
bool hasHeader = TextLoader.DefaultArguments.HasHeader,
5656
char separatorChar = TextLoader.DefaultArguments.Separator,
5757
bool allowQuotedStrings = TextLoader.DefaultArguments.AllowQuoting,

‎test/Microsoft.ML.Benchmarks/RffTransform.cs

+1-1
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ public void SetupTrainingSpeedTests()
3030
public void CV_Multiclass_Digits_RffTransform_OVAAveragedPerceptron()
3131
{
3232
var mlContext = new MLContext();
33-
var reader = mlContext.Data.CreateTextReader(new TextLoader.Arguments
33+
var reader = mlContext.Data.CreateTextLoader(new TextLoader.Arguments
3434
{
3535
Column = new[]
3636
{

‎test/Microsoft.ML.Predictor.Tests/TestIniModels.cs

+2-2
Original file line numberDiff line numberDiff line change
@@ -521,7 +521,7 @@ public TestIniModels(ITestOutputHelper output) : base(output)
521521
public void TestGamRegressionIni()
522522
{
523523
var mlContext = new MLContext(seed: 0);
524-
var idv = mlContext.Data.CreateTextReader(
524+
var idv = mlContext.Data.CreateTextLoader(
525525
new TextLoader.Arguments()
526526
{
527527
HasHeader = false,
@@ -560,7 +560,7 @@ public void TestGamRegressionIni()
560560
public void TestGamBinaryClassificationIni()
561561
{
562562
var mlContext = new MLContext(seed: 0);
563-
var idv = mlContext.Data.CreateTextReader(
563+
var idv = mlContext.Data.CreateTextLoader(
564564
new TextLoader.Arguments()
565565
{
566566
HasHeader = false,

‎test/Microsoft.ML.Tests/Scenarios/Api/CookbookSamples/CookbookSamplesDynamicApi.cs

+2-2
Original file line numberDiff line numberDiff line change
@@ -249,7 +249,7 @@ private void TextFeaturizationOn(string dataPath)
249249
var mlContext = new MLContext();
250250

251251
// Define the reader: specify the data columns and where to find them in the text file.
252-
var reader = mlContext.Data.CreateTextReader(new[]
252+
var reader = mlContext.Data.CreateTextLoader(new[]
253253
{
254254
new TextLoader.Column("IsToxic", DataKind.BL, 0),
255255
new TextLoader.Column("Message", DataKind.TX, 1),
@@ -316,7 +316,7 @@ private void CategoricalFeaturizationOn(params string[] dataPath)
316316
var mlContext = new MLContext();
317317

318318
// Define the reader: specify the data columns and where to find them in the text file.
319-
var reader = mlContext.Data.CreateTextReader(new[]
319+
var reader = mlContext.Data.CreateTextLoader(new[]
320320
{
321321
new TextLoader.Column("Label", DataKind.BL, 0),
322322
// We will load all the categorical features into one vector column of size 8.

‎test/Microsoft.ML.Tests/Scenarios/Api/Estimators/Evaluation.cs

+1-1
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ public void Evaluation()
2222
var ml = new MLContext(seed: 1, conc: 1);
2323

2424
// Pipeline.
25-
var pipeline = ml.Data.CreateTextReader(TestDatasets.Sentiment.GetLoaderColumns(), hasHeader: true)
25+
var pipeline = ml.Data.CreateTextLoader(TestDatasets.Sentiment.GetLoaderColumns(), hasHeader: true)
2626
.Append(ml.Transforms.Text.FeaturizeText("SentimentText", "Features"))
2727
.Append(ml.BinaryClassification.Trainers.StochasticDualCoordinateAscent("Label", "Features", advancedSettings: s => s.NumThreads = 1));
2828

‎test/Microsoft.ML.Tests/Scenarios/Api/Estimators/Extensibility.cs

+1-1
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ void Extensibility()
2626
var dataPath = GetDataPath(TestDatasets.irisData.trainFilename);
2727

2828
var ml = new MLContext();
29-
var data = ml.Data.CreateTextReader(TestDatasets.irisData.GetLoaderColumns(), separatorChar: ',')
29+
var data = ml.Data.CreateTextLoader(TestDatasets.irisData.GetLoaderColumns(), separatorChar: ',')
3030
.Read(dataPath);
3131

3232
Action<IrisData, IrisData> action = (i, j) =>

‎test/Microsoft.ML.Tests/Scenarios/Api/Estimators/FileBasedSavingOfData.cs

+1-1
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ void FileBasedSavingOfData()
2525

2626
var ml = new MLContext(seed: 1, conc: 1);
2727
var src = new MultiFileSource(GetDataPath(TestDatasets.Sentiment.trainFilename));
28-
var trainData = ml.Data.CreateTextReader(TestDatasets.Sentiment.GetLoaderColumns(), hasHeader: true)
28+
var trainData = ml.Data.CreateTextLoader(TestDatasets.Sentiment.GetLoaderColumns(), hasHeader: true)
2929
.Append(ml.Transforms.Text.FeaturizeText("SentimentText", "Features"))
3030
.Fit(src).Read(src);
3131

‎test/Microsoft.ML.Tests/Scenarios/Api/Estimators/Visibility.cs

+1-1
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ public partial class ApiScenariosTests
2323
void Visibility()
2424
{
2525
var ml = new MLContext(seed: 1, conc: 1);
26-
var pipeline = ml.Data.CreateTextReader(TestDatasets.Sentiment.GetLoaderColumns(), hasHeader: true)
26+
var pipeline = ml.Data.CreateTextLoader(TestDatasets.Sentiment.GetLoaderColumns(), hasHeader: true)
2727
.Append(ml.Transforms.Text.FeaturizeText("SentimentText", "Features", s => s.OutputTokens = true));
2828

2929
var src = new MultiFileSource(GetDataPath(TestDatasets.Sentiment.trainFilename));

‎test/Microsoft.ML.Tests/Scenarios/IrisPlantClassificationTests.cs

+1-1
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ public void TrainAndPredictIrisModelTest()
1717
{
1818
var mlContext = new MLContext(seed: 1, conc: 1);
1919

20-
var reader = mlContext.Data.CreateTextReader(columns: new[]
20+
var reader = mlContext.Data.CreateTextLoader(columns: new[]
2121
{
2222
new TextLoader.Column("Label", DataKind.R4, 0),
2323
new TextLoader.Column("SepalLength", DataKind.R4, 1),

‎test/Microsoft.ML.Tests/Scenarios/IrisPlantClassificationWithStringLabelTests.cs

+1-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ public void TrainAndPredictIrisModelWithStringLabelTest()
1414
{
1515
var mlContext = new MLContext(seed: 1, conc: 1);
1616

17-
var reader = mlContext.Data.CreateTextReader(columns: new[]
17+
var reader = mlContext.Data.CreateTextLoader(columns: new[]
1818
{
1919
new TextLoader.Column("SepalLength", DataKind.R4, 0),
2020
new TextLoader.Column("SepalWidth", DataKind.R4, 1),

‎test/Microsoft.ML.Tests/ScenariosWithDirectInstantiation/IrisPlantClassificationTests.cs

+1-1
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ public void TrainAndPredictIrisModelUsingDirectInstantiationTest()
1515
{
1616
var mlContext = new MLContext(seed: 1, conc: 1);
1717

18-
var reader = mlContext.Data.CreateTextReader(columns: new[]
18+
var reader = mlContext.Data.CreateTextLoader(columns: new[]
1919
{
2020
new TextLoader.Column("Label", DataKind.R4, 0),
2121
new TextLoader.Column("SepalLength", DataKind.R4, 1),

‎test/Microsoft.ML.Tests/ScenariosWithDirectInstantiation/TensorflowTests.cs

+4-4
Original file line numberDiff line numberDiff line change
@@ -373,7 +373,7 @@ public void TensorFlowInputsOutputsSchemaTest()
373373
public void TensorFlowTransformMNISTConvTest()
374374
{
375375
var mlContext = new MLContext(seed: 1, conc: 1);
376-
var reader = mlContext.Data.CreateTextReader(
376+
var reader = mlContext.Data.CreateTextLoader(
377377
columns: new[]
378378
{
379379
new TextLoader.Column("Label", DataKind.U4 , new [] { new TextLoader.Range(0) }, new KeyRange(0, 9)),
@@ -416,7 +416,7 @@ public void TensorFlowTransformMNISTLRTrainingTest()
416416
try
417417
{
418418
var mlContext = new MLContext(seed: 1, conc: 1);
419-
var reader = mlContext.Data.CreateTextReader(columns: new[]
419+
var reader = mlContext.Data.CreateTextLoader(columns: new[]
420420
{
421421
new TextLoader.Column("Label", DataKind.I8, 0),
422422
new TextLoader.Column("Placeholder", DataKind.R4, new []{ new TextLoader.Range(1, 784) })
@@ -506,7 +506,7 @@ private void ExecuteTFTransformMNISTConvTrainingTest(bool shuffle, int? shuffleS
506506
{
507507
var mlContext = new MLContext(seed: 1, conc: 1);
508508

509-
var reader = mlContext.Data.CreateTextReader(new[]
509+
var reader = mlContext.Data.CreateTextLoader(new[]
510510
{
511511
new TextLoader.Column("Label", DataKind.U4, new []{ new TextLoader.Range(0) }, new KeyRange(0, 9)),
512512
new TextLoader.Column("TfLabel", DataKind.I8, 0),
@@ -595,7 +595,7 @@ public void TensorFlowTransformMNISTConvSavedModelTest()
595595
// of predicted label of a single in-memory example.
596596

597597
var mlContext = new MLContext(seed: 1, conc: 1);
598-
var reader = mlContext.Data.CreateTextReader(columns: new[]
598+
var reader = mlContext.Data.CreateTextLoader(columns: new[]
599599
{
600600
new TextLoader.Column("Label", DataKind.U4 , new [] { new TextLoader.Range(0) }, new KeyRange(0, 9)),
601601
new TextLoader.Column("Placeholder", DataKind.R4, new []{ new TextLoader.Range(1, 784) })

‎test/Microsoft.ML.Tests/TextLoaderTests.cs

+3-3
Original file line numberDiff line numberDiff line change
@@ -720,7 +720,7 @@ public void LoaderColumnsFromIrisData()
720720
var irisFirstRowValues = irisFirstRow.Values.GetEnumerator();
721721

722722
// Simple load
723-
var dataIris = mlContext.Data.CreateTextReader<Iris>(separatorChar: ',').Read(dataPath);
723+
var dataIris = mlContext.Data.CreateTextLoader<Iris>(separatorChar: ',').Read(dataPath);
724724
var previewIris = dataIris.Preview(1);
725725

726726
Assert.Equal(5, previewIris.ColumnView.Length);
@@ -736,7 +736,7 @@ public void LoaderColumnsFromIrisData()
736736
Assert.Equal("Iris-setosa", previewIris.RowView[0].Values[index].Value.ToString());
737737

738738
// Load with start and end indexes
739-
var dataIrisStartEnd = mlContext.Data.CreateTextReader<IrisStartEnd>(separatorChar: ',').Read(dataPath);
739+
var dataIrisStartEnd = mlContext.Data.CreateTextLoader<IrisStartEnd>(separatorChar: ',').Read(dataPath);
740740
var previewIrisStartEnd = dataIrisStartEnd.Preview(1);
741741

742742
Assert.Equal(2, previewIrisStartEnd.ColumnView.Length);
@@ -753,7 +753,7 @@ public void LoaderColumnsFromIrisData()
753753
}
754754

755755
// load setting the distinct columns. Loading column 0 and 2
756-
var dataIrisColumnIndices = mlContext.Data.CreateTextReader<IrisColumnIndices>(separatorChar: ',').Read(dataPath);
756+
var dataIrisColumnIndices = mlContext.Data.CreateTextLoader<IrisColumnIndices>(separatorChar: ',').Read(dataPath);
757757
var previewIrisColumnIndices = dataIrisColumnIndices.Preview(1);
758758

759759
Assert.Equal(2, previewIrisColumnIndices.ColumnView.Length);

‎test/Microsoft.ML.Tests/Transformers/CustomMappingTests.cs

+2-2
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ public void TestCustomTransformer()
5151
{
5252
string dataPath = GetDataPath("adult.tiny.with-schema.txt");
5353
var source = new MultiFileSource(dataPath);
54-
var loader = ML.Data.CreateTextReader(new[] {
54+
var loader = ML.Data.CreateTextLoader(new[] {
5555
new TextLoader.Column("Float1", DataKind.R4, 9),
5656
new TextLoader.Column("Float4", DataKind.R4, new[]{new TextLoader.Range(9), new TextLoader.Range(10), new TextLoader.Range(11), new TextLoader.Range(12) })
5757
}, hasHeader: true);
@@ -90,7 +90,7 @@ public void TestSchemaPropagation()
9090
{
9191
string dataPath = GetDataPath("adult.test");
9292
var source = new MultiFileSource(dataPath);
93-
var loader = ML.Data.CreateTextReader(new[] {
93+
var loader = ML.Data.CreateTextLoader(new[] {
9494
new TextLoader.Column("Float1", DataKind.R4, 0),
9595
new TextLoader.Column("Float4", DataKind.R4, new[]{new TextLoader.Range(0), new TextLoader.Range(2), new TextLoader.Range(4), new TextLoader.Range(10) }),
9696
new TextLoader.Column("Text1", DataKind.Text, 0)

0 commit comments

Comments
 (0)