Skip to content

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

Closed
@sfilipi

Description

@sfilipi

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>

Activity

added
APIIssues pertaining the friendly API
documentationRelated to documentation of ML.NET
usabilitySmoothing user interaction or experience
on Jan 17, 2019
glebuk

glebuk commented on Jan 18, 2019

@glebuk
Contributor

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

added
nitNeeds a really small fix
up-for-grabsA good issue to fix if you are trying to contribute to the project
on Jan 30, 2019
HerraHak

HerraHak commented on Feb 6, 2019

@HerraHak

How can we contribute on this issue?

abgoswam

abgoswam commented on Feb 20, 2019

@abgoswam
Member

@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

self-assigned this
on Feb 21, 2019
abgoswam

abgoswam commented on Feb 21, 2019

@abgoswam
Member

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

removed
documentationRelated to documentation of ML.NET
nitNeeds a really small fix
up-for-grabsA good issue to fix if you are trying to contribute to the project
usabilitySmoothing user interaction or experience
on Feb 21, 2019
added this to the 0219 milestone on Feb 21, 2019
abgoswam

abgoswam commented on Feb 25, 2019

@abgoswam
Member

Fixed by PR #2665

wschin

wschin commented on Mar 18, 2019

@wschin
Member

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

ghost locked as resolved and limited conversation to collaborators on Mar 25, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

APIIssues pertaining the friendly API

Type

No type

Projects

No projects

Relationships

None yet

    Participants

    @shauheen@wschin@abgoswam@sfilipi@glebuk

    Issue actions

      The parameter descriptions should distinguish between columns and column names. · Issue #2177 · dotnet/machinelearning