LLM-related examples of harm

drivendataorg / deon

A command line tool to easily add an ethics checklist to your data science projects.

https://deon.drivendata.org/

MIT License

289 stars 52 forks source link

LLM-related examples of harm #168

Closed IshaShah27 closed 6 months ago

IshaShah27 commented 7 months ago

related to #167

Adds LLM-related examples
Removes extra lines with --Related academic study when the study is prominently linked in the article (to improve readability)
Moves one example (health algorithm that underpredicts need of black patients) from dataset bias to metric selection, which applies better.
Changes the link to instructions for adding an example to the relevant section in CONTRIBUTING.md (previously it went here but didn't give instructions)

Steps used to update:

Updated examples deon/assets/examples_of_ethical_issues.yml
Ran make docs to update docs/docs/examples.md
Updated contribution link in docs/md_templates/_common_body_pt-BR.tpl and docs/md_templates/_common_body.tpl
Ran make render_markdown to update contribution link in README.md and docs/docs/index.md

Questions:

Do we have a way to update deon/assets/examples_of_ethical_issues_pt-BR.yml?

codecov[bot] commented 7 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 96.80%. Comparing base (67b2964) to head (a85f210).

Additional details and impacted files

```diff @@ Coverage Diff @@ ## main #168 +/- ## ======================================= Coverage 96.80% 96.80% ======================================= Files 6 6 Lines 188 188 ======================================= Hits 182 182 Misses 6 6 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

klwetstone commented 6 months ago

@pjbull I made a few more changes to this -- want to take a quick look?

klwetstone commented 6 months ago

Is there anything else that needs to happen before I merge? Are the steps I took (in the PR description) the right ones to make sure all relevant files are updated?

pjbull commented 6 months ago

I think this is good. Pretty sure just changing the yaml is the only required thing. Generated files get overwritten when PR is merged to main: https://github.com/drivendataorg/deon/blob/main/.github/workflows/examples.yml#L20-L29

klwetstone commented 6 months ago

Ah got it excellent. Going ahead with the merge!

ejm714 commented 6 months ago

Is there anything else that needs to happen before I merge? Are the steps I took (in the PR description) the right ones to make sure all relevant files are updated?

For future reference, contributing doc is here: https://github.com/drivendataorg/deon/blob/main/CONTRIBUTING.md

klwetstone commented 6 months ago

^ Contributing doc covers adding examples and adding checklist items, but doesn't explicitly cover changing the main README so wanted to make sure