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

DOC update reductions user guide #1263

Open
hildeweerts opened this issue Jul 24, 2023 · 10 comments
Open

DOC update reductions user guide #1263

hildeweerts opened this issue Jul 24, 2023 · 10 comments
Labels
documentation easy Relatively simple issues, harder than "good first issue" help wanted

Comments

@hildeweerts
Copy link
Contributor

hildeweerts commented Jul 24, 2023

There is some useful information in the credit loan decisions example notebook that should be integrated in the reductions user guide.

it would be really useful to have the information from the Credit loan decisions example notebook in the ExponentiatedGradient user guide entry.

Originally posted by @CarlaFernandez in #1196 (comment)

@hildeweerts hildeweerts added help wanted documentation easy Relatively simple issues, harder than "good first issue" labels Jul 24, 2023
@ciaokitty
Copy link

If this issue is still open may I work on it?

@romanlutz
Copy link
Member

@sanvi0sh do you know what to do for this one? I'm afraid it's not super well-defined and leaves a lot of room for interpretation. There are other issues that don't have that problem in case you're open to others.

You can certainly read the notebook and send a brief list of things that should go into the user guide, so that one of @fairlearn/fairlearn-maintainers can confirm or chime in.

@ciaokitty
Copy link

ciaokitty commented Aug 11, 2023

i was hoping one of the maintainers would explain me further on what to do once i was assigned the issue but thanks for letting me know. i'll give the user guide and comment here about the changes that seem apt to me.

@romanlutz
Copy link
Member

@sanvi0sh that is not at all an unreasonable assumption. Other issues with "help wanted" are usually more clearly scoped. Feel free to look at them if you don't want to look i to a more open-ended one like this.

@hildeweerts
Copy link
Contributor Author

hi @ciaokitty! Are you still interested in working on this? If you are, let us know if you have any questions! If not, that is of course not a problem either, but then we know the issue is still open for somebody else to pick up.

@Hrittik20
Copy link
Contributor

Hello @hildeweerts and @romanlutz! Since I don't see any updates on this issue, can I work on it?

@romanlutz
Copy link
Member

Sure, but I still suggest reading through the notebook first and suggesting additions to the user guide before actually creating a PR. Otherwise you may end up doing work and then get told that it requires a lot of changes.

Other issues are better scoped, so this requires some of that work upfront. Of course, you may also start with another issue marked with "help wanted" if you prefer. This is not a straightforward one.

@Hrittik20
Copy link
Contributor

Okay, but I have already tried doing it. So can you take a look at it once and let me know what you think?
Capture

@romanlutz
Copy link
Member

We should get @MiroDudik's take on this since he's one of the authors of the paper.

@MiroDudik
Copy link
Member

@Hrittik20 -- this is a good start. If you're still interested, please start a PR. The main additional content to add is the part about actually exploring the performance-fairness trade-off by examining the inner models returned by this function. Happy to help guide you further.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation easy Relatively simple issues, harder than "good first issue" help wanted
Projects
None yet
Development

No branches or pull requests

5 participants