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

LLM-related examples of harm #168

Merged
merged 12 commits into from
Apr 12, 2024
Merged

LLM-related examples of harm #168

merged 12 commits into from
Apr 12, 2024

Conversation

IshaShah27
Copy link
Contributor

@IshaShah27 IshaShah27 commented Mar 13, 2024

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?

@IshaShah27 IshaShah27 changed the title LLM-related harms LLM-related examples of harm Mar 13, 2024
Copy link

codecov bot commented Mar 13, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

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

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #168   +/-   ##
=======================================
  Coverage   96.80%   96.80%           
=======================================
  Files           6        6           
  Lines         188      188           
=======================================
  Hits          182      182           
  Misses          6        6           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Member

@pjbull pjbull left a comment

Choose a reason for hiding this comment

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

Small wording tweak for clarity, but looks good to me!

deon/assets/examples_of_ethical_issues.yml Outdated Show resolved Hide resolved
@klwetstone
Copy link
Contributor

klwetstone commented Apr 12, 2024

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

Copy link
Member

@pjbull pjbull left a comment

Choose a reason for hiding this comment

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

These look good to me!

@klwetstone
Copy link
Contributor

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
Copy link
Member

pjbull commented Apr 12, 2024

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
Copy link
Contributor

Ah got it excellent. Going ahead with the merge!

@klwetstone klwetstone merged commit 5a1883e into main Apr 12, 2024
20 checks passed
@klwetstone klwetstone deleted the is-llm-examples branch April 12, 2024 20:22
@ejm714
Copy link
Contributor

ejm714 commented Apr 12, 2024

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
Copy link
Contributor

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants