Feature/methods docs improvement #162
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
fracarfer5
commented
Jul 15, 2024
fracarfer5
commented
- adding a template for class docstring sphinx rendering
- removing methods and attributes from classes
- cleaning docstrings and methods
…o feature/methods-docs-improvement
crismunoz
added a commit
that referenced
this pull request
Jul 26, 2024
* v1-draft * update docs folder (#118) * new Holistic AI struct (#116) * many things * merge struct and docs * fix: plot docs and cookbook for plots (#120) * Docstrings bias metrics (#122) * docs: formatting docstrings to numpy-like docs format * chore: updating pyproject to ignore mitigation folder * refactor: updating code with recommended ruff practices * fix: updating pyproject for ruff support * chore: updating pyprojectt * chore: updating pyproject * docs: updating docstrings for commons in bias mitigation methods (#123) * docs: updating docstrings for commons in bias mitigation methods * docs: updating docstrings for preprocessing bias mitigation methods * update: inprocessing mitigation docstrings (#124) * Holisticai v1 core (#125) * many things * merge struct and docs * update dataset and mitigation * update unused docs * update dataet map function (#127) * update dataet map function * filter * ok * fix: headers * Recsys tests (#128) * feat: adding seed to allow reproducibility to synthetic generation ranking * feat: adding recsys dataset and tolerance threshold parameter in check results function * tests: adding tests for recsys mitigators for in-, pre-, and post-processing methods * refactor: refactoring recsys tutorials with new dataset function * refactor: refactoring recsys measuring bias tutorial with new dataset and updated paths * tests: bias mitigation for clustering and clustering tutorials (#129) Co-authored-by: crismunoz <cristian.munoz@holisticai.com> * refactor: updating tutorials with new dataset and updating paths (#132) * reafactory: clean files (#133) * reafactory: clean files * fix: ruff * update ruff * docs: classification and multiclassification tutorials (#134) * fix: dataset and test (#135) * fix: dataset and test * fix: format * chore: fix name * chore: add cache dir * chore: create cache dir * chore: upate python viersion * update with new versions numpy * Update workflow * chore: udpate types * chore: update dependencies and remove invalid dependencies * chore: update test * chore: update changes * chore: remove import * adding logo hai * chore: updat tutorials * change bias <-> mitigation, metrics * chore: fix dependencies * chore update docs * fix: build documentation * chore: fix docs * chore: readthedocs * chore: fix readthedoscs * update tutorials * fix: treat empty oop_metrics * chore: update numpy version * chore: add holisticai.bias.plots * chore: avoid crash old codes * chore: update plots old dependencies * docs: update dataset documentation * docs: video documentation aligned * feat: adding xai metrics and plots * refactor: refactoring fairea codes and tutorial (#137) * refactor: refactoring fairea codes and tutorial * chore: adding axis labels * Feature/update format (#138) * chore: update format * chore: update format * tests: update test * docs: update documentation * fix: random_State * fix: format * chore: update bias mitigation tests * chore: update deterministic model in test * chore: update tests * Feature/regression tutorials refactor (#139) * refactor: refactoring tutorials for bias mitigation in regression tasks * Feature/update format (#138) (#140) * chore: update format * chore: update format * tests: update test * docs: update documentation * fix: random_State * fix: format * chore: update bias mitigation tests * chore: update deterministic model in test * chore: update tests * refactor: changing tutorial location and adding interactive section selection * refactor: refactoring tutorials for regression to demos * chore: removing old files * docs: updating paths for documentation * chore: updating tutorial links * chore updating lists format --------- Co-authored-by: cristian.munoz <cristian.munoz@holisticai.com> * Feature/recsys tutorial refactor (#141) * refactor: refactoring recsys tutorials with new formats * refactor: refactoring recsys tutorials * docs: updating codes for tutorials in documentation * chore: updating tutorial links * chore: updating lists and formats * fix: classification and clustering tutorials (#144) * fix: classification and clustering tutorials * fix: examples and correlation matrix plot * docs: bias metrics guide (#145) * update explainability (#146) * update explainability * fix : format * test: remove test * feature: update explainability tutorials and docs (#149) * feature: update explainability tutorials and docs * fix: ruft lint fixed * chore: update documentation (#150) * chore: update documentation * chore:fmt * lint (#152) * docs: update documentation requirements * doc: update readthedocs * chore: update many topics (#158) * chore: update many topics * chore: fmt * chore: update documentation (#159) * fix: spread divergence with jensen shannon (#155) * fix: spread divergence with jensen shannon * fix: ruft lint * fix: ruft lint * fix: ruft lint --------- Co-authored-by: Cristian Muñoz <cristian.munoz@holisticai.com> * fix: tutorial mlflow (#156) * chore: acelerate mitigators using jax and pandas (#161) * chore: acelerate mitigators using jax and pandas * chore: hatch fmt * chore: update dependences * chore: update library dependencies * docs: explainability and bias description (#160) * Feature/documentation xai metrics (#164) * docs: adding xai metrics documentation * chore: hatch fmt * docs: fix images folder static (#165) * chore: update security and exaplainability (#168) * chore: update security and exaplainability * test: fix atol * Feature/methods docs improvement (#162) * feat: adding template for class docstrings rendering * docs: updating docstrings for bias mitigation methods * fix: renaming method * fix: disabling ruff for privated method * fix: updating variable name * fix: updating variable name * fix: making sensgroups variable public in reweighing * fix: making sensgroups variable public in reweighing * docs: fixing lint * docs: updating methods and references from docstrings * docs: improve docstring and remove old dependenceis (#169) * docs: improve docstring and remove old dependenceis * chore: hatch format * docs: adding descriptions for inprocessing methods (#151) * docs: adding descriptions for inprocessing methods * docs: updating method descriptions, adding index and reformatting sectinos * docs: adding learning task note for all methods * docs: adding documentation for adversarial debiasing and debiasing learning methods --------- Co-authored-by: Cristian Muñoz <cristian.munoz@holisticai.com> * Feature/rst security (#170) * docs: improve docstring and remove old dependenceis * chore: hatch format * chore: update security info * docs: update foldername * chore: fix-format (#171) * chore: partial dependence formatting (#172) * chore: partial dependence formatting * chore: fmt * chore: fix plots generation docs (#173) * chore: update install intruction (#174) --------- Co-authored-by: Kleyton da Costa <44351707+Kleyt0n@users.noreply.github.com> Co-authored-by: Franklin <44931423+fracarfer5@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.