Skip to content

Improve clarity of Reference Documentation for METRICS #3407

Closed
@CESARDELATORRE

Description

@CESARDELATORRE

I'm finding that most metrics have very little explanation in the reference.
Other times, it just tells what's the formula for that metric.

For example:

https://docs.microsoft.com/en-us/dotnet/api/microsoft.ml.data.regressionmetrics.rootmeansquarederror?view=ml-dotnet

https://docs.microsoft.com/en-us/dotnet/api/microsoft.ml.data.multiclassclassificationmetrics.logloss?view=ml-dotnet

image

From a developer point of view, what we need to explain is:

  • Very short summary of what is that metric (not a formula. The formular is nice to have but not the fundamental thing to understand the metric)
  • What to look for with that metric: "The closer to 1.00 the better?", viceversa?, basically, when the model is better or worse when looking at that metric.

Other samples where there's very little explanation about the metric:

https://docs.microsoft.com/en-us/dotnet/api/microsoft.ml.data.multiclassclassificationmetrics.microaccuracy?view=ml-dotnet

https://docs.microsoft.com/en-us/dotnet/api/microsoft.ml.data.regressionmetrics.rsquared?view=ml-dotnet
image

https://docs.microsoft.com/en-us/dotnet/api/microsoft.ml.data.regressionmetrics.meanabsoluteerror?view=ml-dotnet

Metadata

Metadata

Assignees

No one assigned

    Labels

    P3Doc bugs, questions, minor issues, etc.documentationRelated to documentation of ML.NET

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions