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

improve readme by only leaving high-level overview and move more sections to the website with more details #520

Merged

Conversation

imatiach-msft
Copy link
Collaborator

@imatiach-msft imatiach-msft commented May 6, 2022

Improve the documentation and readme website by reducing the size of the readme (and just having a general overview) and moving the sections to the website:

1.) Using interpret-community to create an explainer
2.) Local and global importance values - information about them and the APIs to compute them
3.) Raw and Engineered explanations
4.) The visualization dashboard in responsible-ai-toolbox

Note: I temporarily moved the 'latest' build in readthedocs to this branch so it would be easier to review the correctness of the changes.

@codecov-commenter
Copy link

codecov-commenter commented May 6, 2022

Codecov Report

Merging #520 (d082b4f) into master (8e58580) will increase coverage by 0.04%.
The diff coverage is 100.00%.

@@            Coverage Diff             @@
##           master     #520      +/-   ##
==========================================
+ Coverage   86.66%   86.70%   +0.04%     
==========================================
  Files          62       62              
  Lines        4049     4063      +14     
==========================================
+ Hits         3509     3523      +14     
  Misses        540      540              
Flag Coverage Δ
unittests 86.70% <100.00%> (+0.04%) ⬆️

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

Impacted Files Coverage Δ
...hon/interpret_community/explanation/explanation.py 85.69% <100.00%> (+0.27%) ⬆️
python/interpret_community/lime/lime_explainer.py 95.80% <100.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 051f4ff...d082b4f. Read the comment docs.

@imatiach-msft imatiach-msft force-pushed the ilmat/update-docs-pt2 branch 6 times, most recently from 5519745 to 1bfcccc Compare May 6, 2022 22:46
@imatiach-msft imatiach-msft merged commit 6487b98 into interpretml:master May 10, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

3 participants