add more docs to matrix filter aka heatmap in error analysis

[imatiach-msft]

Description

Add more docs to matrix filter aka heatmap in error analysis. It looks like now all methods in erroranalysis package, both public and private, have docstrings.

Checklist

• I have added screenshots above for all UI changes.
• I have added e2e tests for all UI changes.
• Documentation was updated if it was needed.

[github-actions]

https://responsibleai.blob.core.windows.net/pullrequest/microsoft/responsible-ai-toolbox/ilmat/fix-matrix-docs/dashboard/index.html

[codecov-commenter]

Codecov Report

Merging #1489 (cc5f4aa) into main (addf2a0) will not change coverage.
The diff coverage is 80.00%.

@@           Coverage Diff           @@
##             main    #1489   +/-   ##
=======================================
  Coverage   87.56%   87.56%           
=======================================
  Files         108      108           
  Lines        5081     5081           
=======================================
  Hits         4449     4449           
  Misses        632      632           

Flag	Coverage Δ
unittests	87.56% <80.00%> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files	Coverage Δ
erroranalysis/erroranalysis/_internal/metrics.py	86.20% <ø> (ø)
...is/erroranalysis/_internal/surrogate_error_tree.py	85.80% <ø> (ø)
...ranalysis/erroranalysis/analyzer/error_analyzer.py	92.89% <ø> (ø)
...tabalanceanalysis/distribution_balance_measures.py	100.00% <ø> (ø)
...ranalysis/erroranalysis/_internal/matrix_filter.py	95.85% <80.00%> (ø)

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update addf2a0...cc5f4aa. Read the comment docs.

[github-actions]

https://responsibleai.blob.core.windows.net/pullrequest/microsoft/responsible-ai-toolbox/ilmat/fix-matrix-docs/dashboard/index.html

[romanlutz]

Is there a way to enforce that it stays this way, i.e., failing the linter or something like that if a new method is added without docstring?

[imatiach-msft]

@romanlutz yes, when you run sphinx you can make it fail on missing docs. I'm not sure about using a linter for docs though.

[imatiach-msft]

I think if you set warnings as errors in sphinx it will fail on missing method docs:
https://stackoverflow.com/questions/61414199/see-all-warnings-as-errors-when-building-sphinx-docs-on-readthedocs-org

[romanlutz]

I got quite nitpicky here, so apologies for that, but feel free to ignore as you see fit.

[imatiach-msft]

I do see that we have installed:
flake8-docstrings==1.5.0
https://github.com/microsoft/responsible-ai-toolbox/blob/main/requirements-linting.txt#L8
but it doesn't fail on missing docstrings

[github-actions]

https://responsibleai.blob.core.windows.net/pullrequest/microsoft/responsible-ai-toolbox/ilmat/fix-matrix-docs/dashboard/index.html

[github-actions]

https://responsibleai.blob.core.windows.net/pullrequest/microsoft/responsible-ai-toolbox/ilmat/fix-matrix-docs/dashboard/index.html