Skip to content
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

[docs] Add Data Balance README #1567

Merged
merged 8 commits into from
Jul 28, 2022
Merged

[docs] Add Data Balance README #1567

merged 8 commits into from
Jul 28, 2022

Conversation

ms-kashyap
Copy link
Collaborator

Description

Changes made:

The data balance README will serve as the main source of information from the dashboard. For example, the "Learn more" link from each set of measures will link to this README:
MicrosoftTeams-image (3)

In the future, we can move this information to the responsibleai website.

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.

@codecov-commenter
Copy link

codecov-commenter commented Jul 19, 2022

Codecov Report

Merging #1567 (af75f53) into main (f016daa) will increase coverage by 3.65%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##             main    #1567      +/-   ##
==========================================
+ Coverage   85.30%   88.95%   +3.65%     
==========================================
  Files          57      109      +52     
  Lines        2905     5379    +2474     
==========================================
+ Hits         2478     4785    +2307     
- Misses        427      594     +167     
Flag Coverage Δ
unittests 88.95% <ø> (+3.65%) ⬆️

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

Impacted Files Coverage Δ
...ibleai/_tools/causal/dashboard_schemas/__init__.py 100.00% <0.00%> (ø)
...nsibleai/responsibleai/_managers/causal_manager.py 100.00% <0.00%> (ø)
responsibleai/responsibleai/__init__.py 100.00% <0.00%> (ø)
...ibleai/responsibleai/managers/explainer_manager.py 89.55% <0.00%> (ø)
responsibleai/responsibleai/_tools/__init__.py 100.00% <0.00%> (ø)
responsibleai/responsibleai/_interfaces.py 100.00% <0.00%> (ø)
...ai/databalanceanalysis/feature_balance_measures.py 100.00% <0.00%> (ø)
responsibleai/responsibleai/_config/base_config.py 92.30% <0.00%> (ø)
.../databalanceanalysis/aggregate_balance_measures.py 92.85% <0.00%> (ø)
responsibleai/responsibleai/__version__.py 100.00% <0.00%> (ø)
... and 42 more

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 f016daa...af75f53. Read the comment docs.

@imatiach-msft
Copy link
Contributor

@ms-kashyap FYI it looks like this is failing the linter, make sure to run

yarn lintfix

to automatically fix the issues found by the linter.

1 similar comment
@imatiach-msft imatiach-msft merged commit c424c6d into main Jul 28, 2022
@imatiach-msft imatiach-msft deleted the ms-kashyap/docs branch July 28, 2022 14:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants