Skip to content

Commit

Permalink
add more lessons and first attempt at step 10
Browse files Browse the repository at this point in the history
  • Loading branch information
annapmeyer committed Dec 6, 2023
1 parent 73ac5aa commit 40b2811
Show file tree
Hide file tree
Showing 8 changed files with 80 additions and 3 deletions.
4 changes: 4 additions & 0 deletions config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,10 @@ contact: '[email protected]'
episodes:
- introduction.md
- problem-definition.md
- scientific-validity.md
- fairness.md
- explainability.md
- releasing-a-model.md

# Information for Learners
learners:
Expand Down
17 changes: 17 additions & 0 deletions episodes/explainability.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
title: "Explainability"
teaching: 0
exercises: 0
---

:::::::::::::::::::::::::::::::::::::: questions

- TODO

::::::::::::::::::::::::::::::::::::::::::::::::

::::::::::::::::::::::::::::::::::::: objectives

- TODO

::::::::::::::::::::::::::::::::::::::::::::::::
19 changes: 19 additions & 0 deletions episodes/fairness.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
---
title: "Fairness"
teaching: 0
exercises: 0
---

:::::::::::::::::::::::::::::::::::::: questions

- TODO

::::::::::::::::::::::::::::::::::::::::::::::::

::::::::::::::::::::::::::::::::::::: objectives

- Participants will be able to define and differntiate between various notions of fairness in the context of machine learning.
- Participants will be able to define (and implement?) two different ways of modifying the machine learning modeling process to improve the fairness of a model.
- Participants will understand the limitations of fairness as a metric for machine learning models.

::::::::::::::::::::::::::::::::::::::::::::::::
2 changes: 1 addition & 1 deletion episodes/introduction.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Using Markdown"
title: "Introduction"
teaching: 10
exercises: 2
---
Expand Down
2 changes: 1 addition & 1 deletion episodes/problem-definition.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Problem definition"
title: "Preparing to train a model"
teaching: 0
exercises: 0
---
Expand Down
17 changes: 17 additions & 0 deletions episodes/releasing-a-model.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
title: "Releasing a model"
teaching: 0
exercises: 0
---

:::::::::::::::::::::::::::::::::::::: questions

- TODO

::::::::::::::::::::::::::::::::::::::::::::::::

::::::::::::::::::::::::::::::::::::: objectives

- TODO

::::::::::::::::::::::::::::::::::::::::::::::::
17 changes: 17 additions & 0 deletions episodes/scientific-validity.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
title: "Scientific Validity in the Modeling Process"
teaching: 0
exercises: 0
---

:::::::::::::::::::::::::::::::::::::: questions

- TODO

::::::::::::::::::::::::::::::::::::::::::::::::

::::::::::::::::::::::::::::::::::::: objectives

- TODO

::::::::::::::::::::::::::::::::::::::::::::::::
5 changes: 4 additions & 1 deletion index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,14 @@ site: sandpaper::sandpaper_site

This lesson aims to teach responsible machine learning practices with a focus on fairness, explainability, and reproducibility.

Prerequisites
:::::::::: prereq
- Participants should have experience using Python.
- Participants should have a basic understanding of machine learning (e.g., familiar with the concepts like train/test split and cross-validation) and should have trained at least one model in the past.
- Participants should care about the interpretability, reproducibility, and/or fairness of the models they build.
- Participants should have domain knowledge of the field they work in and want to build models for.
::::::::::::::::



[workbench]: https://carpentries.github.io/sandpaper-docs

0 comments on commit 40b2811

Please sign in to comment.