Skip to content

RowGroupColumnName of ranking trainers options class defaults to null #3365

Closed
Closed
RowGroupColumnName of ranking trainers options class defaults to null#3365
Labels
bugSomething isn't working

Description

@artidoro
artidoro
opened on Apr 16, 2019

The Options class of the ranking trainers (FastTree and LightGbm) defaults to RowGroupColumnName = null.

This is:

  1. Inconsistent with the simple constructor where RowGroupColumnName defaults to GroupId
  2. Not desirable as in ranking the row group is very important for correct training

Here are the lines where the row group column name is set:

machinelearning/src/Microsoft.ML.Data/Training/TrainerInputBase.cs

Lines 106 to 110 in 738e5d5

/// <summary>
/// Column to use for example groupId.
/// </summary>
[Argument(ArgumentType.AtMostOnce, HelpText = "Column to use for example groupId", ShortName = "groupId", SortOrder = 5, Visibility = ArgumentAttribute.VisibilityType.EntryPointsOnly)]
public string RowGroupColumnName = null;

We need to update the default and align it with the simple constructor.

Activity

  1. artidoro
    added
    bugSomething isn't working
    on Apr 16, 2019
  2. codemzs
    assigned
    artidoro
    on May 22, 2019
  3. codemzs
    added
    P0
    on May 22, 2019

  4. artidoro commented on May 29, 2019

    @artidoro
    artidoro
    on May 29, 2019
    ContributorAuthor

    I am afraid that this will require a breaking API change which at this point we can't do. This would be something that we should consider changing for 2.0.

  5. artidoro
    added
    breaking
    and removed
    P0
    on May 29, 2019
  6. artidoro
    removed their assignment
    on May 29, 2019

  7. justinormont commented on May 31, 2019

    @justinormont
    justinormont
    on May 31, 2019
    Contributor

    I would expect the ranking trainer to throw if it doesn't have a RowGroupColumnName defined.

    Hence, I don't see this as a breaking change, since without it the user's pipeline (even if it runs) is broken as the result won't have utility. This questions our definition of a breaking API change.

  8. antoniovs1029
    removed
    breaking
    on Dec 19, 2019
  9. antoniovs1029
    added
    api
    P3
    on Jan 9, 2020

  10. najeeb-kazmi commented on Jan 31, 2020

    @najeeb-kazmi
    najeeb-kazmi
    on Jan 31, 2020
    Member

    Tracking in #4749.

  11. najeeb-kazmi
    closed this as completedon Jan 31, 2020
  12. ghost locked as resolved and limited conversation to collaborators on Mar 22, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugSomething isn't working

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions