Skip to content

The Metrics documentation does not help #3671

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

Closed
PeterPann23 opened this issue May 7, 2019 · 1 comment
Closed

The Metrics documentation does not help #3671

PeterPann23 opened this issue May 7, 2019 · 1 comment
Labels
documentation Related to documentation of ML.NET

Comments

@PeterPann23
Copy link

[Enter feedback here]
Hi,

I feel that this level of documentation doesn't really help those that are reading it. It's okay that you provide the formulas of how you calculate the properties however 95% of those that would open help to read about it it will likely be more confused than helped. One should document/ explain what a property means in relation to the accuracy of the model tested.

LogLossReduction has one sentence that is confusing but helps

For example, if the RIG equals 20, it can be interpreted as "the probability of a correct prediction is 20% better than random guessing.

So when executing the samples, I take the Iris clustering sample, it returns LogLossReduction of 0.9967811419606234, you and I know that this is 99.67% and not 0.99% however RIG equals 20 is ambiguous and could be reworded as.

For example, if the LogLossReduction equals 0.20, it can be interpreted as "the probability of a correct prediction is 20% better than random guessing.

Also, testing the metrics of N rows will not pass a "confidence" that a "flip of a coin" prediction is accurate, simply stating that a % of data must be used also doesn't help as 20% of 10 rows is not representative.

Ideally one would also mention how the number can be influenced so that the users can understand how to improve the models accuracy, perhaps have links to Feature Importance.

Ideally those that give the framework a spin should be able to understand the results generated model as well as how to improve it.


Document Details

Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.

@justinormont
Copy link
Contributor

I did a pass of wordsmithing on the docs site -- https://docs.microsoft.com/en-us/dotnet/machine-learning/resources/metrics

Specific changes here: dotnet/docs#12220

@PeterPann23: As always, feel free to add a PR with the changes you'd like to see. The documentation on metrics could use your help.

@ghost ghost locked as resolved and limited conversation to collaborators Mar 21, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
documentation Related to documentation of ML.NET
Projects
None yet
Development

No branches or pull requests

2 participants