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

Create first set of materials for Kedro Academy course on code quality #13

Closed
stichbury opened this issue Jan 9, 2023 · 1 comment
Closed
Assignees
Labels
education: kedro-academy Kedro academy tasks

Comments

@stichbury
Copy link
Contributor

Introduction

We've agreed on the following sections as a MVP for a course about levelling up data science code quality to that demanded by more traditional software engineering (which I'll abbreviate as SWE for DS):

  • Introduction: Why are you even learning SWE for DS?

Then, to teach within Notebooks

  • Python functions/Functional (pure) programming
  • Configuration
  • Virtual environments and managing dependencies
  • VSCode

Then, to teach within VSCode

  • CLIs
  • Semantic folders/project template
  • Git, Github and collaborative version control (pull from clean code workshop)

Requirements

Apart from the introduction, each of these seven sections will have a common structure

  • Each section should take less than 45 minutes to deliver and be introduced with a standard page (What you will learn, Why it matters, How to test your knowledge: exercise & quiz)
  • Each section should be split into a series of short "chapters" that take 7-10 minutes each so they can be chunked within a Udemy/Coursera course or we can create checkpoints to add onto a YouTube video.
  • Each section should have a set of slides and a script, so it can be delivered in person or converted into a video. There should be an accompanying example exercise on a GitHub repo and a quiz.

The goal is to deliver the first draft of materials in January 2023 to trial with a select audience and refine. We'd then create more of the course and look at the options to record as video.

One of the big open issues right now is how to enable the user to follow along with a REPL (to avoid setup issues) and there are various options in play: Educative, Gitpod, REPLIt, GitHub Codespaces, Rhyme (virtual machine)

@stichbury stichbury self-assigned this Jan 9, 2023
@stichbury
Copy link
Contributor Author

stichbury commented Jan 9, 2023

Other decisions:

How to create slides so they are as open as possible.

Wouldn't it be nice if we didn't have to write the slides on powerpoint in Box. I'm thinking that maybe the Marp app https://marp.app/ would be a good way to craft the text and then export the slides, and we could use the kedro-training repo. The downside to this is that we have third party content we'd like to re-use but if we do, we need to be careful about whether we have the licence to do so. We also need to be mindful that we'll have to design the slides from scratch.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
education: kedro-academy Kedro academy tasks
Projects
Status: Shipped 🚀
Development

No branches or pull requests

1 participant