Skip to content

Added decimal marker option in TextLoader #5145

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mstfbl merged 11 commits into from
May 22, 2020
Merged

Added decimal marker option in TextLoader #5145

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
d375d90
Added decimal marker option in TextLoader
mstfbl May 20, 2020
544dab6
Added decimalChar to more TextLoader constructors
mstfbl May 20, 2020
a8a9b54
Removed decimalMarker from TextLoader constructors due to API breaking
mstfbl May 20, 2020
7658a70
Added unit test for ',' as a decimal marker, and added decimalMarker …
mstfbl May 20, 2020
ece5518
Added DecimalMarker in DoubleParser
mstfbl May 21, 2020
a663f21
Added decimal marker check and removed decimalMarker from CreateTextL…
mstfbl May 21, 2020
141fa7b
Added TextLoader decimalMarker unit tests, and refined logic in Doubl…
mstfbl May 22, 2020
6837f64
Merge remote-tracking branch 'upstream/master' into addCommaDecimalOp…
mstfbl May 22, 2020
142f130
Refine tests, logic, csv dataset
mstfbl May 22, 2020
247af63
nit fix
mstfbl May 22, 2020
8492472
Compressed tests using <T>
mstfbl May 22, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 21 additions & 2 deletions src/Microsoft.ML.Data/DataLoadSave/Text/TextLoader.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -474,6 +474,12 @@ public class Options
[Argument(ArgumentType.AtMostOnce, Name = nameof(Separator), Visibility = ArgumentAttribute.VisibilityType.EntryPointsOnly, HelpText = "Source column separator.", ShortName = "sep")]
public char[] Separators = new[] { Defaults.Separator };

/// <summary>
/// The character that should be used as the decimal marker.
/// </summary>
[Argument(ArgumentType.AtMostOnce, Name = "Decimal Marker", HelpText = "Character symbol used to separate the integer part from the fractional part of a number written in decimal form.", ShortName = "decimal")]
public char DecimalMarker = Defaults.DecimalMarker;
Comment thread
mstfbl marked this conversation as resolved.
Comment thread
mstfbl marked this conversation as resolved.

/// <summary>
/// Specifies the input columns that should be mapped to <see cref="IDataView"/> columns.
/// </summary>
Expand Down Expand Up @@ -535,6 +541,7 @@ internal static class Defaults
internal const bool AllowQuoting = false;
internal const bool AllowSparse = false;
internal const char Separator = '\t';
internal const char DecimalMarker = '.';
internal const bool HasHeader = false;
internal const bool TrimWhitespace = false;
internal const bool ReadMultilines = false;
Expand Down Expand Up @@ -1063,7 +1070,8 @@ private static VersionInfo GetVersionInfo()
// verWrittenCur: 0x00010009, // Introduced _flags
//verWrittenCur: 0x0001000A, // Added ForceVector in Range
//verWrittenCur: 0x0001000B, // Header now retained if used and present
verWrittenCur: 0x0001000C, // Removed Min and Contiguous from KeyType, and added ReadMultilines flag to OptionFlags
//verWrittenCur: 0x0001000C, // Removed Min and Contiguous from KeyType, and added ReadMultilines flag to OptionFlags
verWrittenCur: 0x0001000D, // Added decimal marker option to allow for ',' to be a decimal marker
Comment thread
mstfbl marked this conversation as resolved.
Outdated
verReadableCur: 0x0001000A,
verWeCanReadBack: 0x00010009,
loaderSignature: LoaderSignature,
Expand Down Expand Up @@ -1094,6 +1102,7 @@ private enum OptionFlags : uint
// Input size is zero for unknown - determined by the data (including sparse rows).
private readonly int _inputSize;
private readonly char[] _separators;
private readonly char _decimalMarker;
private readonly Bindings _bindings;

private readonly Parser _parser;
Expand Down Expand Up @@ -1210,6 +1219,9 @@ internal TextLoader(IHostEnvironment env, Options options = null, IMultiStreamSo
}
}

if (options.DecimalMarker == ',' && _separators.Contains<char>(','))
throw _host.ExceptUserArg(nameof(Options.DecimalMarker), "Decimal marker and separator cannot be the same '{0}' character.", options.DecimalMarker);
Comment thread
mstfbl marked this conversation as resolved.
Outdated
_decimalMarker = options.DecimalMarker;
Comment thread
mstfbl marked this conversation as resolved.
_bindings = new Bindings(this, cols, headerFile, dataSample);
_parser = new Parser(this);
}
Expand Down Expand Up @@ -1373,6 +1385,7 @@ private TextLoader(IHost host, ModelLoadContext ctx)
// int: inputSize: 0 for determined from data
// int: number of separators
// char[]: separators
// char: decimal marker
// bindings
int cbFloat = ctx.Reader.ReadInt32();
host.CheckDecode(cbFloat == sizeof(float));
Expand All @@ -1397,6 +1410,8 @@ private TextLoader(IHost host, ModelLoadContext ctx)
if (_separators.Contains(':'))
host.CheckDecode((_flags & OptionFlags.AllowSparse) == 0);

_decimalMarker = ctx.Reader.ReadChar();
host.CheckDecode(_decimalMarker == '.' || _decimalMarker == ',');
_bindings = new Bindings(ctx, this);
_parser = new Parser(this);
}
Expand Down Expand Up @@ -1437,6 +1452,7 @@ void ICanSaveModel.Save(ModelSaveContext ctx)
// int: inputSize: 0 for determined from data
// int: number of separators
// char[]: separators
// char: decimal marker
// bindings
ctx.Writer.Write(sizeof(float));
ctx.Writer.Write(_maxRows);
Expand All @@ -1445,6 +1461,7 @@ void ICanSaveModel.Save(ModelSaveContext ctx)
_host.Assert(0 <= _inputSize && _inputSize < SrcLim);
ctx.Writer.Write(_inputSize);
ctx.Writer.WriteCharArray(_separators);
ctx.Writer.Write(_decimalMarker);

_bindings.Save(ctx);
}
Expand Down Expand Up @@ -1473,12 +1490,14 @@ internal static TextLoader CreateTextLoader<TInput>(IHostEnvironment host,
bool allowQuoting = Defaults.AllowQuoting,
bool supportSparse = Defaults.AllowSparse,
bool trimWhitespace = Defaults.TrimWhitespace,
IMultiStreamSource dataSample = null)
IMultiStreamSource dataSample = null,
char decimalMarker = Defaults.DecimalMarker)
{
Comment thread
mstfbl marked this conversation as resolved.
Options options = new Options
{
HasHeader = hasHeader,
Separators = new[] { separator },
DecimalMarker = decimalMarker,
AllowQuoting = allowQuoting,
AllowSparse = supportSparse,
TrimWhitespace = trimWhitespace
Expand Down
12 changes: 12 additions & 0 deletions test/BaselineOutput/Common/EntryPoints/core_manifest.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -369,6 +369,18 @@
"\t"
]
},
{
"Name": "Decimal Marker",
"Type": "Char",
"Desc": "Character symbol used to separate the integer part from the fractional part of a number written in decimal form.",
"Aliases": [
"decimal"
],
"Required": false,
"SortOrder": 150.0,
"IsNullable": false,
"Default": "."
},
{
"Name": "TrimWhitespace",
"Type": "Bool",
Expand Down
151 changes: 151 additions & 0 deletions test/data/iris_decimal_marker_as_comma.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,151 @@
#Label Sepal length Sepal width Petal length Petal width
0 5,1 3,5 1,4 0,2
0 4,9 3,0 1,4 0,2
Comment thread
mstfbl marked this conversation as resolved.
0 4,7 3,2 1,3 0,2
0 4,6 3,1 1,5 0,2
0 5,0 3,6 1,4 0,2
0 5,4 3,9 1,7 0,4
0 4,6 3,4 1,4 0,3
0 5,0 3,4 1,5 0,2
0 4,4 2,9 1,4 0,2
0 4,9 3,1 1,5 0,1
0 5,4 3,7 1,5 0,2
0 4,8 3,4 1,6 0,2
0 4,8 3,0 1,4 0,1
0 4,3 3,0 1,1 0,1
0 5,8 4,0 1,2 0,2
0 5,7 4,4 1,5 0,4
0 5,4 3,9 1,3 0,4
0 5,1 3,5 1,4 0,3
0 5,7 3,8 1,7 0,3
0 5,1 3,8 1,5 0,3
0 5,4 3,4 1,7 0,2
0 5,1 3,7 1,5 0,4
0 4,6 3,6 1,0 0,2
0 5,1 3,3 1,7 0,5
0 4,8 3,4 1,9 0,2
0 5,0 3,0 1,6 0,2
0 5,0 3,4 1,6 0,4
0 5,2 3,5 1,5 0,2
0 5,2 3,4 1,4 0,2
0 4,7 3,2 1,6 0,2
0 4,8 3,1 1,6 0,2
0 5,4 3,4 1,5 0,4
0 5,2 4,1 1,5 0,1
0 5,5 4,2 1,4 0,2
0 4,9 3,1 1,5 0,1
0 5,0 3,2 1,2 0,2
0 5,5 3,5 1,3 0,2
0 4,9 3,1 1,5 0,1
0 4,4 3,0 1,3 0,2
0 5,1 3,4 1,5 0,2
0 5,0 3,5 1,3 0,3
0 4,5 2,3 1,3 0,3
0 4,4 3,2 1,3 0,2
0 5,0 3,5 1,6 0,6
0 5,1 3,8 1,9 0,4
0 4,8 3,0 1,4 0,3
0 5,1 3,8 1,6 0,2
0 4,6 3,2 1,4 0,2
0 5,3 3,7 1,5 0,2
0 5,0 3,3 1,4 0,2
1 7,0 3,2 4,7 1,4
1 6,4 3,2 4,5 1,5
1 6,9 3,1 4,9 1,5
1 5,5 2,3 4,0 1,3
1 6,5 2,8 4,6 1,5
1 5,7 2,8 4,5 1,3
1 6,3 3,3 4,7 1,6
1 4,9 2,4 3,3 1,0
1 6,6 2,9 4,6 1,3
1 5,2 2,7 3,9 1,4
1 5,0 2,0 3,5 1,0
1 5,9 3,0 4,2 1,5
1 6,0 2,2 4,0 1,0
1 6,1 2,9 4,7 1,4
1 5,6 2,9 3,6 1,3
1 6,7 3,1 4,4 1,4
1 5,6 3,0 4,5 1,5
1 5,8 2,7 4,1 1,0
1 6,2 2,2 4,5 1,5
1 5,6 2,5 3,9 1,1
1 5,9 3,2 4,8 1,8
1 6,1 2,8 4,0 1,3
1 6,3 2,5 4,9 1,5
1 6,1 2,8 4,7 1,2
1 6,4 2,9 4,3 1,3
1 6,6 3,0 4,4 1,4
1 6,8 2,8 4,8 1,4
1 6,7 3,0 5,0 1,7
1 6,0 2,9 4,5 1,5
1 5,7 2,6 3,5 1,0
1 5,5 2,4 3,8 1,1
1 5,5 2,4 3,7 1,0
1 5,8 2,7 3,9 1,2
1 6,0 2,7 5,1 1,6
1 5,4 3,0 4,5 1,5
1 6,0 3,4 4,5 1,6
1 6,7 3,1 4,7 1,5
1 6,3 2,3 4,4 1,3
1 5,6 3,0 4,1 1,3
1 5,5 2,5 4,0 1,3
1 5,5 2,6 4,4 1,2
1 6,1 3,0 4,6 1,4
1 5,8 2,6 4,0 1,2
1 5,0 2,3 3,3 1,0
1 5,6 2,7 4,2 1,3
1 5,7 3,0 4,2 1,2
1 5,7 2,9 4,2 1,3
1 6,2 2,9 4,3 1,3
1 5,1 2,5 3,0 1,1
1 5,7 2,8 4,1 1,3
2 6,3 3,3 6,0 2,5
2 5,8 2,7 5,1 1,9
2 7,1 3,0 5,9 2,1
2 6,3 2,9 5,6 1,8
2 6,5 3,0 5,8 2,2
2 7,6 3,0 6,6 2,1
2 4,9 2,5 4,5 1,7
2 7,3 2,9 6,3 1,8
2 6,7 2,5 5,8 1,8
2 7,2 3,6 6,1 2,5
2 6,5 3,2 5,1 2,0
2 6,4 2,7 5,3 1,9
2 6,8 3,0 5,5 2,1
2 5,7 2,5 5,0 2,0
2 5,8 2,8 5,1 2,4
2 6,4 3,2 5,3 2,3
2 6,5 3,0 5,5 1,8
2 7,7 3,8 6,7 2,2
2 7,7 2,6 6,9 2,3
2 6,0 2,2 5,0 1,5
2 6,9 3,2 5,7 2,3
2 5,6 2,8 4,9 2,0
2 7,7 2,8 6,7 2,0
2 6,3 2,7 4,9 1,8
2 6,7 3,3 5,7 2,1
2 7,2 3,2 6,0 1,8
2 6,2 2,8 4,8 1,8
2 6,1 3,0 4,9 1,8
2 6,4 2,8 5,6 2,1
2 7,2 3,0 5,8 1,6
2 7,4 2,8 6,1 1,9
2 7,9 3,8 6,4 2,0
2 6,4 2,8 5,6 2,2
2 6,3 2,8 5,1 1,5
2 6,1 2,6 5,6 1,4
2 7,7 3,0 6,1 2,3
2 6,3 3,4 5,6 2,4
2 6,4 3,1 5,5 1,8
2 6,0 3,0 4,8 1,8
2 6,9 3,1 5,4 2,1
2 6,7 3,1 5,6 2,4
2 6,9 3,1 5,1 2,3
2 5,8 2,7 5,1 1,9
2 6,8 3,2 5,9 2,3
2 6,7 3,3 5,7 2,5
2 6,7 3,0 5,2 2,3
2 6,3 2,5 5,0 1,9
2 6,5 3,0 5,2 2,0
2 6,2 3,4 5,4 2,3
2 5,9 3,0 5,1 1,8
Comment thread
mstfbl marked this conversation as resolved.