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 the documentation website for interpret-community and update the main readme #518

Merged

Conversation

imatiach-msft
Copy link
Collaborator

Improve the documentation website for interpret-community repository and update the main readme on github.
Specifically:

  • Move more specific installation instructions to the website, simplify instructions in readme. Update the instructions for pytorch. Fix the grouping which is currently wrong.
  • Move section about API docs up, and change it to documentation section
  • Move example notebooks links from readme to documentation website. Add more links to new notebooks (which we somehow missed adding when they were committed).
  • Add some missing sections to API docs
  • Add supported models and explainers page to documentation website
  • Update index page to include more links to the new repositories and websites
  • Add overview page with detailed installation instructions to website
  • Fix broken k-means function documentation which was throwing error in sphinx build

@imatiach-msft imatiach-msft force-pushed the ilmat/docs-website-update branch from 3c84ae5 to 79a59f8 Compare April 14, 2022 18:34
@imatiach-msft imatiach-msft merged commit 8e58580 into interpretml:master Apr 16, 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.

2 participants