Skip to content
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.

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

The parameter descriptions should distinguish between columns and column names. #2177

Closed
sfilipi opened this issue Jan 17, 2019 · 6 comments
Closed
Assignees
Labels
API Issues pertaining the friendly API
Milestone

Comments

@sfilipi
Copy link
Member

sfilipi commented Jan 17, 2019

As @wschin pointed out here: #2170 (comment) the parmaters, and in general our XML documentation should distinguish between columns and column names.

This issue will be considered closed when all the params of this language:

/// <param name="labelColumn">The label column.</param>
/// <param name="featureColumn">The featureColumn column.</param>
/// <param name="weights">The optional weights column.</param>

Get changed to:

/// <param name="labelColumnName">The name of the label column.</param>
/// <param name="featureColumnName">The name of the feature column.</param>
/// <param name="weightsColumnName">The name of the optional weights column.</param>
@sfilipi sfilipi added API Issues pertaining the friendly API documentation Related to documentation of ML.NET usability Smoothing user interaction or experience labels Jan 17, 2019
@glebuk
Copy link
Contributor

glebuk commented Jan 18, 2019

Should the weights be renamed to weightsColumn, or perhaps exampleWeightsColumn?

@sfilipi sfilipi added help wanted good first issue Good for newcomers nit Needs a really small fix up-for-grabs A good issue to fix if you are trying to contribute to the project labels Jan 30, 2019
@HerraHak
Copy link

HerraHak commented Feb 6, 2019

How can we contribute on this issue?

@abgoswam
Copy link
Member

abgoswam commented Feb 20, 2019

@sfilipi .

For most of the learners, the feature column name is a string

public static OlsLinearRegressionTrainer OrdinaryLeastSquares(this RegressionCatalog.RegressionTrainers catalog,
string labelColumnName = DefaultColumnNames.Label,
string featureColumnName = DefaultColumnNames.Features,
string weightColumn = null)

But for FactorizationMachine, the features column is a string[]

public static FieldAwareFactorizationMachineTrainer FieldAwareFactorizationMachine(this BinaryClassificationCatalog.BinaryClassificationTrainers catalog,
string[] featureColumns,
string labelColumn = DefaultColumnNames.Label,
string weights = null)

So would we treat FactorizationMachine as an aberration ?

@Ivanidzo4ka @glebuk

@abgoswam
Copy link
Member

Assigning to myself since this is superset of issues #2257, #2660 that i am fixing

@abgoswam abgoswam removed documentation Related to documentation of ML.NET good first issue Good for newcomers help wanted nit Needs a really small fix up-for-grabs A good issue to fix if you are trying to contribute to the project usability Smoothing user interaction or experience labels Feb 21, 2019
@shauheen shauheen added this to the 0219 milestone Feb 21, 2019
@abgoswam
Copy link
Member

Fixed by PR #2665

@wschin
Copy link
Member

wschin commented Mar 18, 2019

My feeling is that exampleWeightColumnName is a bit long, so #2873 is opened for further discussion.

@ghost ghost locked as resolved and limited conversation to collaborators Mar 25, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
API Issues pertaining the friendly API
Projects
None yet
6 participants