Skip to content

Commit ccd369d

Browse files
CESARDELATORREDmitry-A
authored andcommitted
CLI argument descriptions updated (dotnet#224)
* CLI argument descriptions updated * No version in .csproj
1 parent c006df6 commit ccd369d

File tree

1 file changed

+12
-12
lines changed

1 file changed

+12
-12
lines changed

src/mlnet/Commands/CommandDefinitions.cs

+12-12
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ internal static class CommandDefinitions
1717
{
1818
internal static System.CommandLine.Command New(ICommandHandler handler)
1919
{
20-
var newCommand = new System.CommandLine.Command("new", "ML.NET CLI tool for code generation", handler: handler)
20+
var newCommand = new System.CommandLine.Command("new", "Create a new .NET project using ML.NET to train and run a model", handler: handler)
2121
{
2222
Dataset(),
2323
ValidationDataset(),
@@ -56,47 +56,47 @@ internal static System.CommandLine.Command New(ICommandHandler handler)
5656
return newCommand;
5757

5858
Option Dataset() =>
59-
new Option("--dataset", "Dataset file path.",
59+
new Option("--dataset", "File path to either a single dataset or a training dataset for train/test split approaches.",
6060
new Argument<FileInfo>().ExistingOnly());
6161

6262
Option ValidationDataset() =>
63-
new Option("--validation-dataset", "Validation dataset file path. Used for model exploration.",
63+
new Option("--validation-dataset", "File path for the validation dataset in train/validation/test split approaches.",
6464
new Argument<FileInfo>(defaultValue: default(FileInfo)).ExistingOnly());
6565

6666
Option TestDataset() =>
67-
new Option("--test-dataset", "Test dataset file path.",
67+
new Option("--test-dataset", "File path for the test dataset in train/test approaches.",
6868
new Argument<FileInfo>(defaultValue: default(FileInfo)).ExistingOnly());
6969

7070
Option MlTask() =>
71-
new Option("--ml-task", "Type of ML task.",
71+
new Option("--ml-task", "Type of ML task to perform. Current supported tasks: regression and binary-classification",
7272
new Argument<string>().FromAmong(GetMlTaskSuggestions()));
7373

7474
Option LabelName() =>
75-
new Option("--label-column-name", "Name of the label column.",
75+
new Option("--label-column-name", "Name of the label (target) column to predict.",
7676
new Argument<string>());
7777

7878
Option LabelColumnIndex() =>
79-
new Option("--label-column-index", "Index of the label column.",
79+
new Option("--label-column-index", "Index of the label (target) column to predict.",
8080
new Argument<uint>());
8181

8282
Option MaxExplorationTime() =>
83-
new Option("--max-exploration-time", "Timeout in seconds for exploring models.",
83+
new Option("--max-exploration-time", "Maximum time in seconds for exploring models with best configuration.",
8484
new Argument<uint>(defaultValue: 10));
8585

8686
Option Verbosity() =>
87-
new Option(new List<string>() { "--verbosity" }, "Verbosity of the output to be shown by the tool.",
87+
new Option(new List<string>() { "--verbosity" }, "Output verbosity choices: q[uiet], m[inimal] (by default) and diag[nostic]",
8888
new Argument<string>(defaultValue: "m").FromAmong(GetVerbositySuggestions()));
8989

9090
Option Name() =>
91-
new Option(new List<string>() { "--name" }, "Name of the output files(project).",
91+
new Option(new List<string>() { "--name" }, "Name for the output project or solution to create. ",
9292
new Argument<string>(defaultValue: "Sample"));
9393

9494
Option OutputPath() =>
95-
new Option(new List<string>() { "--output-path" }, "Output folder path.",
95+
new Option(new List<string>() { "--output-path" }, "Location folder to place the generated output. The default is the current directory.",
9696
new Argument<DirectoryInfo>(defaultValue: new DirectoryInfo(".")));
9797

9898
Option HasHeader() =>
99-
new Option(new List<string>() { "--has-header" }, "Specifies if the dataset has header or not.",
99+
new Option(new List<string>() { "--has-header" }, "Specify true/false depending if the dataset file(s) have a header row.",
100100
new Argument<bool>(defaultValue: true));
101101

102102
}

0 commit comments

Comments
 (0)