Skip to content

Commit 71eb769

Browse files
author
Jim Bennett
committed
Adding more structure and initial readme
1 parent 6da0797 commit 71eb769

File tree

11 files changed

+2508
-24
lines changed

11 files changed

+2508
-24
lines changed

‎1-getting-started/README.md

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# Getting started with Generative AI
2+
3+
## Topics
4+
5+
1. [Introduction to Generative AI](./lessons/1-introduction-to-generative-ai/README.md)
6+
7+
## Credits
8+
9+
All lessons were written with ❤️ by ChatGPT.

‎1-getting-started/lessons/1-introduction-to-generative-ai/README.md

+38
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# Introduction to Generative AI
2+
3+
<!-- Sketchnote goes here -->
4+
![]()
5+
6+
## Pre-lecture quiz
7+
8+
[pre-lecture quiz]()
9+
10+
## Introduction
11+
12+
This lesson covers things:
13+
14+
*
15+
*
16+
*
17+
18+
## Thing 1
19+
20+
## Thing 2
21+
22+
## Thing 3
23+
24+
## 🚀 Challenge
25+
26+
A challenge goes here
27+
28+
## Post-lecture quiz
29+
30+
[post-lecture quiz]()
31+
32+
## Review & Self Study
33+
34+
Read up on things.
35+
36+
## Assignment
37+
38+
[An assignment](./assignment.md)

‎1-getting-started/lessons/1-introduction-to-generative-ai/assignment.md

Whitespace-only changes.

‎README.md

+88-24
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,97 @@
1-
# Project
1+
[![GitHub license](https://img.shields.io/github/license/microsoft/Generative-AI-For-Beginners.svg)](https://github.com/microsoft/Generative-AI-For-Beginners/blob/master/LICENSE)
2+
[![GitHub contributors](https://img.shields.io/github/contributors/microsoft/Generative-AI-For-Beginners.svg)](https://github.com/microsoft/Generative-AI-For-Beginners/graphs/contributors/)
3+
[![GitHub issues](https://img.shields.io/github/issues/microsoft/Generative-AI-For-Beginners.svg)](https://github.com/microsoft/Generative-AI-For-Beginners/issues/)
4+
[![GitHub pull-requests](https://img.shields.io/github/issues-pr/microsoft/Generative-AI-For-Beginners.svg)](https://github.com/microsoft/Generative-AI-For-Beginners/pulls/)
5+
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com)
26

3-
> This repo has been populated by an initial template to help get you started. Please
4-
> make sure to update the content to build a great experience for community-building.
7+
[![GitHub watchers](https://img.shields.io/github/watchers/microsoft/Generative-AI-For-Beginners.svg?style=social&label=Watch)](https://github.com/microsoft/Generative-AI-For-Beginners/watchers/)
8+
[![GitHub forks](https://img.shields.io/github/forks/microsoft/Generative-AI-For-Beginners.svg?style=social&label=Fork)](https://github.com/microsoft/Generative-AI-For-Beginners/network/)
9+
[![GitHub stars](https://img.shields.io/github/stars/microsoft/Generative-AI-For-Beginners.svg?style=social&label=Star)](https://github.com/microsoft/Generative-AI-For-Beginners/stargazers/)
510

6-
As the maintainer of this project, please make a few updates:
11+
# Generative AI for Beginners - A curriculum
712

8-
- Improving this README.MD file to provide a great experience
9-
- Updating SUPPORT.MD with content about this project's support experience
10-
- Understanding the security reporting process in SECURITY.MD
11-
- Remove this section from the README
13+
Azure Cloud Advocates at Microsoft are pleased to offer a 12-week, 24-lesson curriculum all about Generative AI basics. Each lesson includes pre- and post-lesson quizzes, written instructions to complete the lesson, a solution, an assignment and more. Our project-based pedagogy allows you to learn while building, a proven way for new skills to 'stick'.
1214

13-
## Contributing
15+
> **Teachers**, we have [included some suggestions](for-teachers.md) on how to use this curriculum. If you would like to create your own lessons, we have also included a [lesson template](lesson-template/README.md).
1416
15-
This project welcomes contributions and suggestions. Most contributions require you to agree to a
16-
Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us
17-
the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.
17+
> **[Students](https://learn.microsoft.com/training/student-hub/?WT.mc_id=academic-99474-cxa)**, to use this curriculum on your own, fork the entire repo and complete the exercises on your own, starting with a pre-lecture quiz, then reading the lecture and 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 and go through the content together.
1818
19-
When you submit a pull request, a CLA bot will automatically determine whether you need to provide
20-
a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions
21-
provided by the bot. You will only need to do this once across all repos using our CLA.
19+
## Pedagogy
2220

23-
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
24-
For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or
25-
contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.
21+
We have chosen two pedagogical tenets while building this curriculum: ensuring that it is project-based and that it includes frequent quizzes. By the end of this series, students will have built a number of real-world projects that leverage generative AI.
2622

27-
## Trademarks
23+
By ensuring that the content aligns with projects, the process is made more engaging for students and retention of concepts will be augmented.
2824

29-
This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft
30-
trademarks or logos is subject to and must follow
31-
[Microsoft's Trademark & Brand Guidelines](https://www.microsoft.com/en-us/legal/intellectualproperty/trademarks/usage/general).
32-
Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship.
33-
Any use of third-party trademarks or logos are subject to those third-party's policies.
25+
In addition, a low-stakes quiz before a class sets the intention of the student towards learning a topic, while a second quiz after class ensures further retention. This curriculum was designed to be flexible and fun and can be taken in whole or in part. The projects start small and become increasingly complex by the end of the 12 week cycle.
26+
27+
## Each lesson includes:
28+
29+
- sketchnote
30+
- optional supplemental video
31+
- pre-lesson warmup quiz
32+
- written lesson
33+
- for project-based lessons, step-by-step guides on how to build the project
34+
- knowledge checks
35+
- a challenge
36+
- supplemental reading
37+
- assignment
38+
- post-lesson quiz
39+
40+
> **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.
41+
42+
## Lessons
43+
44+
| | Project Name | Concepts Taught | Learning Objectives | Linked Lesson |
45+
| :---: | :------------------------------------: | :---------------------------------------------------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :--------------------------------------------------------------------------------------------------------------------------: |
46+
| 01 | [Getting started](./1-getting-started/README.md) | | | [Introduction to Generative AI](./1-getting-started/lessons/1-introduction-to-generative-ai/README.md) |
47+
| 02 | | | | |
48+
| 03 | | | | |
49+
| 04 | | | | |
50+
| 05 | | | | |
51+
| 06 | | | | |
52+
| 07 | | | | |
53+
| 08 | | | | |
54+
| 09 | | | | |
55+
| 10 | | | | |
56+
| 11 | | | | |
57+
| 12 | | | | |
58+
| 13 | | | | |
59+
| 14 | | | | |
60+
| 15 | | | | |
61+
| 16 | | | | |
62+
| 17 | | | | |
63+
| 18 | | | | |
64+
| 19 | | | | |
65+
| 20 | | | | |
66+
| 21 | | | | |
67+
| 22 | | | | |
68+
| 23 | | | | |
69+
| 24 | | | | |
70+
71+
## Offline access
72+
73+
You can run this documentation offline by using [Docsify](https://docsify.js.org/#/). Fork this repo, [install Docsify](https://docsify.js.org/#/quickstart) on your local machine, and then in the root folder of this repo, type `docsify serve`. The website will be served on port 3000 on your localhost: `localhost:3000`.
74+
75+
### PDF
76+
77+
You can generate a PDF of this content for offline access if needed. To do this, make sure you have [npm installed](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm) and run the following commands in the root folder of this repo:
78+
79+
```sh
80+
npm i
81+
npm run convert
82+
```
83+
84+
## Help Wanted!
85+
86+
Would you like to contribute a translation? Please read our [translation guidelines](TRANSLATIONS.md) and add input [to one of the translations issues](https://github.com/microsoft/generative-ai-for-beginners/issues?q=is%3Aissue+is%3Aopen+label%3Atranslation). If you want to translate into a new language, please raise a new issue for tracking.
87+
88+
## Other Curricula
89+
90+
Our team produces other curricula! Check out:
91+
92+
- [Web Dev for Beginners](https://aka.ms/webdev-beginners)
93+
- [IoT for Beginners](https://aka.ms/iot-beginners)
94+
- [ML for Beginners](https://aka.ms/ml-beginners)
95+
- [Data Science for Beginners](https://aka.ms/datascience-beginners)
96+
- [AI for Beginners](https://aka.ms/ai-beginners)
97+
- [XR Development for Beginners](https://github.com/microsoft/xr-development-for-beginners)

‎TRANSLATIONS.md

+34
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# Contribute by translating lessons
2+
3+
We welcome translations for the lessons in this curriculum!
4+
## Guidelines
5+
6+
There are folders in each lesson folder and lesson introduction folder which contain the translated markdown files.
7+
8+
> Note, please do not translate any code in the code sample files; the only things to translate are README, assignments, and the quizzes. Thanks!
9+
10+
Translated files should follow this naming convention:
11+
12+
**README._[language]_.md**
13+
14+
where _[language]_ is a two letter language abbreviation following the ISO 639-1 standard (e.g. `README.es.md` for Spanish and `README.nl.md` for Dutch).
15+
16+
**assignment._[language]_.md**
17+
18+
Similar to Readme's, please translate the assignments as well.
19+
20+
> Important: when translating text in this repo, please ensure that you do not use machine translation. We will verify translations via the community, so please only volunteer for translations in languages where you are proficient.
21+
22+
**Quizzes**
23+
24+
1. Add your translation to the quiz-app by adding a file here: https://github.com/microsoft/ML-For-Beginners/tree/main/quiz-app/src/assets/translations, with proper naming convention (en.json, fr.json). **Please don't localize the words 'true' or 'false' however. thanks!**
25+
26+
2. Add your language code to the dropdown in the quiz-app's App.vue file.
27+
28+
3. Edit the quiz-app's [translations index.js file](https://github.com/microsoft/ML-For-Beginners/blob/main/quiz-app/src/assets/translations/index.js) to add your language.
29+
30+
4. Finally, edit ALL the quiz links in your translated README.md files to point directly to your translated quiz: https://gray-sand-07a10f403.1.azurestaticapps.net/quiz/1 becomes https://gray-sand-07a10f403.1.azurestaticapps.net/quiz/1?loc=id
31+
32+
**THANK YOU**
33+
34+
We truly appreciate your efforts!

‎docs/_sidebar.md

+43
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
- Introduction
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+
7+
- Regression
8+
- [Tools of the Trade](../2-Regression/1-Tools/README.md)
9+
- [Data](../2-Regression/2-Data/README.md)
10+
- [Linear Regression](../2-Regression/3-Linear/README.md)
11+
- [Logistic Regression](../2-Regression/4-Logistic/README.md)
12+
13+
- Build a Web App
14+
- [Web App](../3-Web-App/1-Web-App/README.md)
15+
16+
- Classification
17+
- [Intro to Classification](../4-Classification/1-Introduction/README.md)
18+
- [Classifiers 1](../4-Classification/2-Classifiers-1/README.md)
19+
- [Classifiers 2](../4-Classification/3-Classifiers-2/README.md)
20+
- [Applied ML](../4-Classification/4-Applied/README.md)
21+
22+
- Clustering
23+
- [Visualize your Data](../5-Clustering/1-Visualize/README.md)
24+
- [K-Means](../5-Clustering/2-K-Means/README.md)
25+
26+
- NLP
27+
- [Introduction to NLP](../6-NLP/1-Introduction-to-NLP/README.md)
28+
- [NLP Tasks](../6-NLP/2-Tasks/README.md)
29+
- [Translation and Sentiment](../6-NLP/3-Translation-Sentiment/README.md)
30+
- [Hotel Reviews 1](../6-NLP/4-Hotel-Reviews-1/README.md)
31+
- [Hotel Reviews 2](../6-NLP/5-Hotel-Reviews-2/README.md)
32+
33+
- Time Series Forecasting
34+
- [Introduction to Time Series Forecasting](../7-TimeSeries/1-Introduction/README.md)
35+
- [ARIMA](../7-TimeSeries/2-ARIMA/README.md)
36+
- [SVR](../7-TimeSeries/3-SVR/README.md)
37+
38+
- Reinforcement Learning
39+
- [Q-Learning](../8-Reinforcement/1-QLearning/README.md)
40+
- [Gym](../8-Reinforcement/2-Gym/README.md)
41+
42+
- Real World ML
43+
- [Applications](../9-Real-World/1-Applications/README.md)

‎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+
};

‎img/logo.png

880 KB
Loading

‎index.html

+28
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
<!DOCTYPE html>
2+
<html lang="en">
3+
4+
<head>
5+
<meta charset="UTF-8">
6+
<title>Machine Learning for Beginners</title>
7+
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
8+
<meta name="description" content="Description">
9+
<meta name="viewport"
10+
content="width=device-width, user-scalable=no, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0">
11+
<link rel="icon" type="image/png" href="images/favicon.png">
12+
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/docsify-themeable@0/dist/css/theme-simple.css">
13+
</head>
14+
15+
<body>
16+
<div id="app"></div>
17+
<script>
18+
window.$docsify = {
19+
name: 'Generative AI Learning for Beginners',
20+
repo: 'https://github.com/Microsoft/generative-ai-for-beginners',
21+
relativePath: true,
22+
auto2top: true,
23+
}
24+
</script>
25+
<script src="//cdn.jsdelivr.net/npm/docsify/lib/docsify.min.js"></script>
26+
</body>
27+
28+
</html>

0 commit comments

Comments
 (0)