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/add docstrings #17

Merged
merged 31 commits into from
Aug 6, 2024
Merged

Doc/add docstrings #17

merged 31 commits into from
Aug 6, 2024

Conversation

NacerKROUDIR
Copy link
Contributor

Added docstrings to the library with a focus on clear descriptions for fairness metrics and how can they be interpreted. Also, included examples for how to use every class.

@NacerKROUDIR NacerKROUDIR added the documentation Improvements or additions to documentation label Jul 23, 2024
@NacerKROUDIR NacerKROUDIR added this to the Amazing documentation milestone Jul 23, 2024
@NacerKROUDIR NacerKROUDIR requested a review from MarcBresson July 23, 2024 13:31
@NacerKROUDIR NacerKROUDIR self-assigned this Jul 23, 2024
fair_mango/dataset/dataset.py Outdated Show resolved Hide resolved
fair_mango/dataset/dataset.py Show resolved Hide resolved
fair_mango/dataset/dataset.py Show resolved Hide resolved
fair_mango/dataset/dataset.py Show resolved Hide resolved
fair_mango/dataset/dataset.py Show resolved Hide resolved
fair_mango/metrics/base.py Outdated Show resolved Hide resolved
fair_mango/metrics/base.py Outdated Show resolved Hide resolved
fair_mango/metrics/metrics.py Outdated Show resolved Hide resolved
fair_mango/metrics/metrics.py Outdated Show resolved Hide resolved
fair_mango/metrics/base.py Show resolved Hide resolved
Copy link

@enzo-damion enzo-damion left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some typos, some minor concerns with the vocabulary used and unconsistencies regarding the numpy conventions.

Otherwise LGTM

fair_mango/dataset/dataset.py Show resolved Hide resolved
fair_mango/dataset/dataset.py Show resolved Hide resolved
fair_mango/dataset/dataset.py Outdated Show resolved Hide resolved
fair_mango/dataset/dataset.py Outdated Show resolved Hide resolved
fair_mango/dataset/dataset.py Show resolved Hide resolved
fair_mango/metrics/base.py Show resolved Hide resolved
fair_mango/metrics/base.py Outdated Show resolved Hide resolved
fair_mango/metrics/base.py Show resolved Hide resolved
fair_mango/metrics/base.py Outdated Show resolved Hide resolved
fair_mango/metrics/base.py Outdated Show resolved Hide resolved
Copy link

@enzo-damion enzo-damion left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

fair_mango/dataset/dataset.py Outdated Show resolved Hide resolved
fair_mango/dataset/dataset.py Outdated Show resolved Hide resolved
fair_mango/dataset/dataset.py Outdated Show resolved Hide resolved
fair_mango/dataset/dataset.py Outdated Show resolved Hide resolved
fair_mango/dataset/dataset.py Outdated Show resolved Hide resolved
fair_mango/metrics/metrics.py Outdated Show resolved Hide resolved
fair_mango/metrics/metrics.py Show resolved Hide resolved
fair_mango/metrics/metrics.py Show resolved Hide resolved
fair_mango/metrics/metrics.py Show resolved Hide resolved
fair_mango/metrics/metrics.py Outdated Show resolved Hide resolved
@NacerKROUDIR NacerKROUDIR linked an issue Aug 6, 2024 that may be closed by this pull request
@NacerKROUDIR NacerKROUDIR removed a link to an issue Aug 6, 2024
@NacerKROUDIR NacerKROUDIR linked an issue Aug 6, 2024 that may be closed by this pull request
@NacerKROUDIR NacerKROUDIR merged commit 6ea7a96 into dev Aug 6, 2024
@MarcBresson MarcBresson deleted the doc/add-docstrings branch August 27, 2024 16:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

Improve docstrings to reflects the API, use more complex examples
3 participants