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

Documentation doesn't list charts #608

Closed
koaning opened this issue Oct 23, 2020 · 2 comments · Fixed by #766 or #770
Closed

Documentation doesn't list charts #608

koaning opened this issue Oct 23, 2020 · 2 comments · Fixed by #766 or #770
Assignees

Comments

@koaning
Copy link
Contributor

koaning commented Oct 23, 2020

When I go to the a getting started page I usually expect to see a full guide on how to use a library. Part of that is there, but ... there's no charts. In order to get the charts I need to run everything locally. This is a bummer of an experience, especially if you never worked with ipython widgets before.

Wouldn't it be a lot more beginner-friendly just to show simple matplotlib charts in the docs?

@romanlutz
Copy link
Member

Yes! This is related to https://github.com/fairlearn/fairlearn-proposals/blob/master/ui/migration.md . In short:

  • The existing FairlearnDashboard will be migrated out of Fairlearn shortly (after the v0.5.0 release which will happen as soon as the metrics API is finalized) for reasons outlined in that link.
  • At that point we'll complete Plots: Add plot_disparities_in_performance and plot_disparities_in_metric #561 and update the documentation including the getting started page to show these plots instead. As you pointed out it's much better to have the plots actually render without having to download it first.

I'm hoping we can expand on these charts as well, since they provide very minimal functionality at this point. It's a good start, though!

I think this issue is a good way to "track" the effort to update the docs after the FairlearnDashboard is removed, so I'd propose to leave it open. I'll assign it to myself since I promised to take care of the removal and docs update, but I'm very much looking for feedback on the resulting docs. I'll make sure to tag you on the PR(s).

Does this make sense @koaning ? Please keep the feedback & suggestions coming :-)

@romanlutz
Copy link
Member

#770 and #766 are related to this. #770 is already completed and #766 will be shortly, at which point we can release v0.7.0 as the first version without dashboard.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment