Skip to content

Document default values of TrainerOptions #6450

Open

Description

@sfiruch

Is your feature request related to a problem? Please describe.
Looking up the default value of LightGbmMulticlassTrainer.Options.NumberOfIterations just took me way too long. The default values should be stated in the documentation.

Describe the solution you'd like
The documentation should mention the default values.

Describe alternatives you've considered
Create an application, instantiate the object there and print out the values.

Additional context
I reported this before in #4311. There, instead of updating the documentation, I was provided the answer. That's nice, but not scalable, and wasn't my suggestion. To be clear: I suggest you include all default values in the documentation.

Activity

  1. ghost added
    untriagedNew issue has not been triaged
    on Nov 12, 2022
  2. added this to the ML.NET 3.0 milestone on Nov 28, 2022
  3. ghost removed
    untriagedNew issue has not been triaged
    on Nov 28, 2022
  4. michaelgsharp commented on Nov 28, 2022

    @michaelgsharp
    Contributor

    You are correct. Thanks for pointing this out we will get that added in!

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

    area-TrainersMachine learning trainers and training APIsdocumentationRelated to documentation of ML.NETenhancementNew feature or requestyellowmaintenance only

    Type

    No type

    Projects

    No projects

      Milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions