first commit, set up config

README.md

@@ -1,17 +1,9 @@
-# The Carpentries Workbench Template Markdown Lesson
+# Fair and Explainable Machine Learning
 
-This lesson is a template lesson that uses [The Carpentries Workbench][workbench].
+This lesson plan aims to introduce machine learning practitioners about responsible machine learning, with a focus on fairness, explanability, and reproducibilities concerns. This lesson is developed through [The Carpentries Workbench][workbench] framework and is designed to be taught as a Carpentries workshop. 
 
-## Create a new repository from this template
 
-To use this template to start a new lesson repository, 
-make sure you're logged into Github.   
-Visit https://github.com/carpentries/workbench-template-md/generate
-and follow the instructions.
-Checking the 'Include all branches' option will save some time waiting for the first website build
-when your new repository is initialised.
-
-If you have any questions, contact [@zkamvar](https://github.com/zkamvar)
+The remainder of the README below is general guidelines for creating a Carpentries lesson plan and will be updated as this lesson plan is completed.
 
 ## Configure a new lesson
 

config.yaml

@@ -14,10 +14,10 @@ carpentry: 'incubator'
 title: 'Lesson Title' # FIXME
 
 # Date the lesson was created (YYYY-MM-DD, this is empty by default)
-created: ~ # FIXME
+created: 2023-12-05
 
 # Comma-separated list of keywords for the lesson
-keywords: 'software, data, lesson, The Carpentries' # FIXME
+keywords: 'fairness, explainability, fair machine learning, interpretable machine learning, xai, lesson, The Carpentries'
 
 # Life cycle stage of the lesson
 # possible values: pre-alpha, alpha, beta, stable
@@ -27,13 +27,13 @@ life_cycle: 'pre-alpha' # FIXME
 license: 'CC-BY 4.0'
 
 # Link to the source repository for this lesson
-source: 'https://github.com/carpentries/workbench-template-md' # FIXME
+source: 'https://github.com/annapmeyer/fair-explainable-ml'
 
 # Default branch of your lesson
 branch: 'main'
 
 # Who to contact if there are any issues
-contact: '[email protected]' # FIXME
+contact: '[email protected]' 
 
 # Navigation ------------------------------------------------
 #
@@ -43,9 +43,9 @@ contact: '[email protected]' # FIXME
 #
 # Example -------------
 #
-# episodes:
-# - introduction.md
-# - first-steps.md
+episodes:
+- introduction.md
+- problem-definition.md
 #
 # learners:
 # - setup.md

episodes/problem-definition.md

@@ -0,0 +1,17 @@
+---
+title: "Problem definition"
+teaching: 0
+exercises: 0
+---
+
+:::::::::::::::::::::::::::::::::::::: questions 
+
+- TODO
+
+::::::::::::::::::::::::::::::::::::::::::::::::
+
+::::::::::::::::::::::::::::::::::::: objectives
+
+- TODO
+
+::::::::::::::::::::::::::::::::::::::::::::::::