Skip to content

Commit e1b4562

Browse files
jlooperjlooper
committed
file edits for DS curriculum
1 parent 7d204e5 commit e1b4562

File tree

14 files changed

+2486
-45
lines changed

14 files changed

+2486
-45
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.md

+38
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
**Describe the bug**
11+
A clear and concise description of what the bug is.
12+
13+
**To Reproduce**
14+
Steps to reproduce the behavior:
15+
1. Go to '...'
16+
2. Click on '....'
17+
3. Scroll down to '....'
18+
4. See error
19+
20+
**Expected behavior**
21+
A clear and concise description of what you expected to happen.
22+
23+
**Screenshots**
24+
If applicable, add screenshots to help explain your problem.
25+
26+
**Desktop (please complete the following information):**
27+
- OS: [e.g. iOS]
28+
- Browser [e.g. chrome, safari]
29+
- Version [e.g. 22]
30+
31+
**Smartphone (please complete the following information):**
32+
- Device: [e.g. iPhone6]
33+
- OS: [e.g. iOS8.1]
34+
- Browser [e.g. stock browser, safari]
35+
- Version [e.g. 22]
36+
37+
**Additional context**
38+
Add any other context about the problem here.

‎.github/ISSUE_TEMPLATE/feature_request.md

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
**Is your feature request related to a problem? Please describe.**
11+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
12+
13+
**Describe the solution you'd like**
14+
A clear and concise description of what you want to happen.
15+
16+
**Describe alternatives you've considered**
17+
A clear and concise description of any alternative solutions or features you've considered.
18+
19+
**Additional context**
20+
Add any other context or screenshots about the feature request here.

‎.github/PULL_REQUEST_TEMPLATE/translation_checklist.md

+37
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
## Track translation progress by opening a draft PR using this template and checking off the translations completed
2+
3+
Each lesson includes a translation of the README.md and the Assignment.md file, if available. Only mark the lesson complete if both those files are translated per lesson, please.
4+
5+
- [ ] 1
6+
- [ ] 1-1
7+
- [ ] 1-2
8+
- [ ] 1-3
9+
- [ ] 2
10+
- [ ] 2-1
11+
- [ ] 2-2
12+
- [ ] 2-3
13+
- [ ] 2-4
14+
- [ ] 3
15+
- [ ] 3-1
16+
- [ ] 3-2
17+
- [ ] 3-3
18+
- [ ] 4
19+
- [ ] 4-1
20+
- [ ] 5
21+
- [ ] 5-1
22+
- [ ] 5-2
23+
- [ ] 5-3
24+
- [ ] 6
25+
- [ ] 6-1
26+
- [ ] 6-2
27+
- [ ] 6-3
28+
- [ ] 6-4
29+
- [ ] 6-5
30+
- [ ] 6-6
31+
- [ ] 7
32+
- [ ] 7-1
33+
- [ ] 7-2
34+
- [ ] 7-3
35+
- [ ] 7-4
36+
37+
- [ ] Quiz (add a file in the quiz-app with all localizations)

‎CONTRIBUTING.md

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# Contributing
2+
3+
This project welcomes contributions and suggestions. Most contributions require you to
4+
agree to a Contributor License Agreement (CLA) declaring that you have the right to,
5+
and actually do, grant us the rights to use your contribution. For details, visit
6+
https://cla.microsoft.com.
7+
8+
When you submit a pull request, a CLA-bot will automatically determine whether you need
9+
to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the
10+
instructions provided by the bot. You will only need to do this once across all repositories using our CLA.
11+
12+
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
13+
For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/)
14+
or contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.

‎README.md

+29-29
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,9 @@ Azure Cloud Advocates at Microsoft are pleased to offer a 12-week, 24-lesson cur
1010
1111
> **Students**, to use this curriculum on your own, fork the entire repo complete the exercises on your own, starting with a pre-lecture quiz, then reading the lecture completing the rest of the activities. Try to create the projects by comprehending the lessons rather than copying the solution code; however that code is available in the /solutions folders in each project-oriented lesson. Another idea would be to form a study group with friends go through the content together. For further study, we recommend [Microsoft Learn]() by watching the videos mentioned below.
1212
13-
[![Promo video](screenshot.png)]( "Promo video")
13+
<!--[![Promo video](screenshot.png)]( "Promo video")
1414
15-
> 🎥 Click the image above for a video about the project the folks who created it!
15+
> 🎥 Click the image above for a video about the project the folks who created it!-->
1616

1717
## Pedagogy
1818

@@ -36,36 +36,36 @@ In addition, a low-stakes quiz before a class sets the intention of the student
3636
- assignment
3737
- post-lesson quiz
3838

39-
> **A note about quizzes**: All quizzes are contained [in this app](), for 48 total quizzes of three questions each. They are linked from within the lessons but the quiz app can be run locally; follow the instruction in the `quiz-app` folder. They are gradually being localized.
39+
> **A note about quizzes**: All quizzes are contained [in this app](https://red-water-0103e7a0f.azurestaticapps.net/), for 48 total quizzes of three questions each. They are linked from within the lessons but the quiz app can be run locally; follow the instruction in the `quiz-app` folder. They are gradually being localized.
4040
4141
## Lessons
4242

43-
| | Project Name | Concepts Taught | Learning Objectives | Linked Lesson | Author |
44-
| :---: | :------------------------------------------------------: | :--------------------------------------------------------------------: | ----------------------------------------------------------------------------------------------------------------------------------- | :----------------------------------------------------------------------------------------------------------------------------: | :---------------------: |
45-
| 01 | Defining Data Science | TBD | | | |
46-
| 02 | Data Science Ethics | TBD | | | |
47-
| 03 | Defining Data | TBD | | | |
48-
| 04 | Introduction to Statistics Probability | TBD | | | |
49-
| 05 | Working with Data | Spreadsheets | | | |
50-
| 06 | Working with Data | Relational Databases | | | |
51-
| 07 | Working with Data | NoSQL | | | |
52-
| 08 | Working with Data | Python Data | | | |
53-
| 09 | Working with Data | Cleaning Transformations | | | |
54-
| 10 | Visualizing Data | Quantities | | | |
55-
| 11 | Visualizing Data | Distributions | | | |
56-
| 12 | Visualizing Data | Proportions | | | |
57-
| 13 | Visualizing Data | Relationships | | | |
58-
| 14 | Visualizing Data | Making meaningful visualizations | | | |
59-
| 15 | The Data Science Lifecycle | Capturing | | | |
60-
| 16 | The Data Science Lifecycle | Processing | | | |
61-
| 17 | The Data Science Lifecycle | Analyzing | | | |
62-
| 18 | The Data Science Lifecycle | Communication | | | |
63-
| 19 | The Data Science Lifecycle | Maintaining | | | |
64-
| 20 | Data Science in the Cloud | TBD | | | |
65-
| 21 | Data Science in the Cloud | TBD | | | |
66-
| 22 | Data Science in the Cloud | TBD | | | |
67-
| 23 | Data Science in the Wild | TBD | | | |
68-
| 24 | Data Science in the Wild | TBD | | | |
43+
| | Project Name | Concepts Taught | Learning Objectives | Linked Lesson | Author |
44+
| :---: | :-------------------------------------: | :------------------------------: | ------------------- | :-----------: | :----: |
45+
| 01 | Defining Data Science | TBD | | | |
46+
| 02 | Data Science Ethics | TBD | | | |
47+
| 03 | Defining Data | TBD | | | |
48+
| 04 | Introduction to Statistics Probability | TBD | | | |
49+
| 05 | Working with Data | Spreadsheets | | | |
50+
| 06 | Working with Data | Relational Databases | | | |
51+
| 07 | Working with Data | NoSQL | | | |
52+
| 08 | Working with Data | Python Data | | | |
53+
| 09 | Working with Data | Cleaning Transformations | | | |
54+
| 10 | Visualizing Data | Quantities | | | |
55+
| 11 | Visualizing Data | Distributions | | | |
56+
| 12 | Visualizing Data | Proportions | | | |
57+
| 13 | Visualizing Data | Relationships | | | |
58+
| 14 | Visualizing Data | Making meaningful visualizations | | | |
59+
| 15 | The Data Science Lifecycle | Capturing | | | |
60+
| 16 | The Data Science Lifecycle | Processing | | | |
61+
| 17 | The Data Science Lifecycle | Analyzing | | | |
62+
| 18 | The Data Science Lifecycle | Communication | | | |
63+
| 19 | The Data Science Lifecycle | Maintaining | | | |
64+
| 20 | Data Science in the Cloud | TBD | | | |
65+
| 21 | Data Science in the Cloud | TBD | | | |
66+
| 22 | Data Science in the Cloud | TBD | | | |
67+
| 23 | Data Science in the Wild | TBD | | | |
68+
| 24 | Data Science in the Wild | TBD | | | |
6969

7070
## Offline access
7171

‎SUPPORT.md

+2-15
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,12 @@
1-
# TODO: The maintainer of this repo has not yet edited this file
2-
3-
**REPO OWNER**: Do you want Customer Service & Support (CSS) support for this product/project?
4-
5-
- **No CSS support:** Fill out this template with information about how to file issues and get help.
6-
- **Yes CSS support:** Fill out an intake form at [aka.ms/spot](https://aka.ms/spot). CSS will work with/help you to determine next steps. More details also available at [aka.ms/onboardsupport](https://aka.ms/onboardsupport).
7-
- **Not sure?** Fill out a SPOT intake as though the answer were "Yes". CSS will help you decide.
8-
9-
*Then remove this first heading from this SUPPORT.MD file before publishing your repo.*
10-
111
# Support
12-
132
## How to file issues and get help
143

154
This project uses GitHub Issues to track bugs and feature requests. Please search the existing
165
issues before filing new issues to avoid duplicates. For new issues, file your bug or
176
feature request as a new Issue.
187

19-
For help and questions about using this project, please **REPO MAINTAINER: INSERT INSTRUCTIONS HERE
20-
FOR HOW TO ENGAGE REPO OWNERS OR COMMUNITY FOR HELP. COULD BE A STACK OVERFLOW TAG OR OTHER
21-
CHANNEL. WHERE WILL YOU HELP PEOPLE?**.
8+
For help and questions about using this project, file an issue.
229

2310
## Microsoft Support Policy
2411

25-
Support for this **PROJECT or PRODUCT** is limited to the resources listed above.
12+
Support for this repository is limited to the resources listed above.

‎docs/_sidebar.md

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
- Introduction TBD
2+
- [Introduction to Machine Learning](../1-Introduction/1-intro-to-ML/README.md)
3+
- [History of Machine Learning](../1-Introduction/2-history-of-ML/README.md)
4+
- [ML and Fairness](../1-Introduction/3-fairness/README.md)
5+
- [Techniques of ML](../1-Introduction/4-techniques-of-ML/README.md)
6+

‎docsifytopdf.js

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
module.exports = {
2+
contents: ['docs/_sidebar.md'], // array of "table of contents" files path
3+
pathToPublic: 'pdf/readme.pdf', // path where pdf will stored
4+
pdfOptions: {
5+
margin: { top: '100px', bottom: '100px' }
6+
}, // reference: https://github.com/GoogleChrome/puppeteer/blob/master/docs/api.md#pagepdfoptions
7+
removeTemp: true, // remove generated .md and .html or not
8+
emulateMedia: 'print', // mediaType, emulating by puppeteer for rendering pdf, 'print' by default (reference: https://github.com/GoogleChrome/puppeteer/blob/master/docs/api.md#pageemulatemediamediatype)
9+
};

‎for-teachers.md

+23
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
## For Educators
2+
3+
Would you like to use this curriculum in your classroom? Please feel free!
4+
5+
In fact, you can use it within GitHub itself by using GitHub Classroom.
6+
7+
To do that, fork this repo. You are going to need to create a repo for each lesson, so you're going to need to extract each folder into a separate repo. That way, [GitHub Classroom](https://classroom.github.com/classrooms) can pick up each lesson separately.
8+
9+
These [full instructions](https://github.blog/2020-03-18-set-up-your-digital-classroom-with-github-classroom/) will give you an idea how to set up your classroom.
10+
11+
## Using the repo as is
12+
13+
If you would like to use this repo as it currently stands, without using GitHub Classroom, that can be done as well. You would need to communicate with your students which lesson to work through together.
14+
15+
In an online format (Zoom, Teams, or other) you might form breakout rooms for the quizzes, and mentor students to help them get ready to learn. Then invite students to for the quizzes and submit their answers as 'issues' at a certain time. You might do the same with assignments, if you want students to work collaboratively out in the open.
16+
17+
If you prefer a more private format, ask your students to fork the curriculum, lesson by lesson, to their own GitHub repos as private repos, and give you access. Then they can complete quizzes and assignments privately and submit them to you via issues on your classroom repo.
18+
19+
There are many ways to make this work in an online classroom format. Please let us know what works best for you!
20+
21+
## Please give us your thoughts!
22+
23+
We want to make this curriculum work for you and your students. Please give us feedback in the discussion boards!

0 commit comments

Comments
 (0)