Adding more structure and initial readme

1-getting-started/README.md

@@ -0,0 +1,9 @@
+# Getting started with Generative AI
+
+## Topics
+
+1. [Introduction to Generative AI](./lessons/1-introduction-to-generative-ai/README.md)
+
+## Credits
+
+All lessons were written with ❤️ by ChatGPT.

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

@@ -0,0 +1,38 @@
+# Introduction to Generative AI
+
+<!-- Sketchnote goes here -->
+![]()
+
+## Pre-lecture quiz
+
+[pre-lecture quiz]()
+
+## Introduction
+
+This lesson covers things:
+
+* 
+* 
+* 
+
+## Thing 1
+
+## Thing 2
+
+## Thing 3
+
+## 🚀 Challenge
+
+A challenge goes here
+
+## Post-lecture quiz
+
+[post-lecture quiz]()
+
+## Review & Self Study
+
+Read up on things.
+
+## Assignment
+
+[An assignment](./assignment.md)

README.md

@@ -1,33 +1,97 @@
-# Project
+[![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)
+[![GitHub contributors](https://img.shields.io/github/contributors/microsoft/Generative-AI-For-Beginners.svg)](https://GitHub.com/microsoft/Generative-AI-For-Beginners/graphs/contributors/)
+[![GitHub issues](https://img.shields.io/github/issues/microsoft/Generative-AI-For-Beginners.svg)](https://GitHub.com/microsoft/Generative-AI-For-Beginners/issues/)
+[![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/)
+[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com)
 
-> This repo has been populated by an initial template to help get you started. Please
-> make sure to update the content to build a great experience for community-building.
+[![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/)
+[![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/)
+[![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/)
 
-As the maintainer of this project, please make a few updates:
+# Generative AI for Beginners - A curriculum
 
-- Improving this README.MD file to provide a great experience
-- Updating SUPPORT.MD with content about this project's support experience
-- Understanding the security reporting process in SECURITY.MD
-- Remove this section from the README
+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'.
 
-## Contributing
+> **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).
 
-This project welcomes contributions and suggestions.  Most contributions require you to agree to a
-Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us
-the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.
+> **[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.
 
-When you submit a pull request, a CLA bot will automatically determine whether you need to provide
-a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions
-provided by the bot. You will only need to do this once across all repos using our CLA.
+## Pedagogy
 
-This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
-For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or
-contact [[email protected]](mailto:[email protected]) with any additional questions or comments.
+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.
 
-## Trademarks
+By ensuring that the content aligns with projects, the process is made more engaging for students and retention of concepts will be augmented.
 
-This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft 
-trademarks or logos is subject to and must follow 
-[Microsoft's Trademark & Brand Guidelines](https://www.microsoft.com/en-us/legal/intellectualproperty/trademarks/usage/general).
-Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship.
-Any use of third-party trademarks or logos are subject to those third-party's policies.
+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.
+
+## Each lesson includes:
+
+- sketchnote
+- optional supplemental video
+- pre-lesson warmup quiz
+- written lesson
+- for project-based lessons, step-by-step guides on how to build the project
+- knowledge checks
+- a challenge
+- supplemental reading
+- assignment
+- post-lesson quiz
+
+> **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.
+
+## Lessons
+
+|       |              Project Name              |                       Concepts Taught                       | Learning Objectives                                                                                                                                                 |                                                        Linked Lesson                                                         |
+| :---: | :------------------------------------: | :---------------------------------------------------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :--------------------------------------------------------------------------------------------------------------------------: |
+| 01 | [Getting started](./1-getting-started/README.md) | | | [Introduction to Generative AI](./1-getting-started/lessons/1-introduction-to-generative-ai/README.md)                      |
+| 02 | | | | |
+| 03 | | | | |
+| 04 | | | | |
+| 05 | | | | |
+| 06 | | | | |
+| 07 | | | | |
+| 08 | | | | |
+| 09 | | | | |
+| 10 | | | | |
+| 11 | | | | |
+| 12 | | | | |
+| 13 | | | | |
+| 14 | | | | |
+| 15 | | | | |
+| 16 | | | | |
+| 17 | | | | |
+| 18 | | | | |
+| 19 | | | | |
+| 20 | | | | |
+| 21 | | | | |
+| 22 | | | | |
+| 23 | | | | |
+| 24 | | | | |
+
+## Offline access
+
+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`.
+
+### PDF
+
+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:
+
+```sh
+npm i
+npm run convert
+```
+
+## Help Wanted!
+
+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.
+
+## Other Curricula
+
+Our team produces other curricula! Check out:
+
+- [Web Dev for Beginners](https://aka.ms/webdev-beginners)
+- [IoT for Beginners](https://aka.ms/iot-beginners)
+- [ML for Beginners](https://aka.ms/ml-beginners)
+- [Data Science for Beginners](https://aka.ms/datascience-beginners)
+- [AI for Beginners](https://aka.ms/ai-beginners)
+- [XR Development for Beginners](https://github.com/microsoft/xr-development-for-beginners)

TRANSLATIONS.md

@@ -0,0 +1,34 @@
+# Contribute by translating lessons
+
+We welcome translations for the lessons in this curriculum!
+## Guidelines
+
+There are folders in each lesson folder and lesson introduction folder which contain the translated markdown files.
+
+> Note, please do not translate any code in the code sample files; the only things to translate are README, assignments, and the quizzes. Thanks!
+
+Translated files should follow this naming convention:
+
+**README._[language]_.md**
+
+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).
+
+**assignment._[language]_.md**
+
+Similar to Readme's, please translate the assignments as well.
+
+> 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.
+
+**Quizzes**
+
+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!**
+
+2. Add your language code to the dropdown in the quiz-app's App.vue file.
+
+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.
+
+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
+
+**THANK YOU**
+
+We truly appreciate your efforts!

docs/_sidebar.md

@@ -0,0 +1,43 @@
+- Introduction
+  - [Introduction to Machine Learning](../1-Introduction/1-intro-to-ML/README.md)
+  - [History of Machine Learning](../1-Introduction/2-history-of-ML/README.md)
+  - [ML and Fairness](../1-Introduction/3-fairness/README.md)
+  - [Techniques of ML](../1-Introduction/4-techniques-of-ML/README.md)
+
+- Regression
+  - [Tools of the Trade](../2-Regression/1-Tools/README.md)
+  - [Data](../2-Regression/2-Data/README.md)
+  - [Linear Regression](../2-Regression/3-Linear/README.md)
+  - [Logistic Regression](../2-Regression/4-Logistic/README.md)
+
+- Build a Web App
+  - [Web App](../3-Web-App/1-Web-App/README.md)
+
+- Classification
+  - [Intro to Classification](../4-Classification/1-Introduction/README.md)
+  - [Classifiers 1](../4-Classification/2-Classifiers-1/README.md)
+  - [Classifiers 2](../4-Classification/3-Classifiers-2/README.md)
+  - [Applied ML](../4-Classification/4-Applied/README.md)
+
+- Clustering
+  - [Visualize your Data](../5-Clustering/1-Visualize/README.md)
+  - [K-Means](../5-Clustering/2-K-Means/README.md)
+
+- NLP
+  - [Introduction to NLP](../6-NLP/1-Introduction-to-NLP/README.md)
+  - [NLP Tasks](../6-NLP/2-Tasks/README.md)
+  - [Translation and Sentiment](../6-NLP/3-Translation-Sentiment/README.md)
+  - [Hotel Reviews 1](../6-NLP/4-Hotel-Reviews-1/README.md)
+  - [Hotel Reviews 2](../6-NLP/5-Hotel-Reviews-2/README.md)
+
+- Time Series Forecasting
+  - [Introduction to Time Series Forecasting](../7-TimeSeries/1-Introduction/README.md)
+  - [ARIMA](../7-TimeSeries/2-ARIMA/README.md)
+  - [SVR](../7-TimeSeries/3-SVR/README.md)
+
+- Reinforcement Learning
+  - [Q-Learning](../8-Reinforcement/1-QLearning/README.md)
+  - [Gym](../8-Reinforcement/2-Gym/README.md)
+
+- Real World ML
+  - [Applications](../9-Real-World/1-Applications/README.md)

docsifytopdf.js

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

index.html

@@ -0,0 +1,28 @@
+<!DOCTYPE html>
+<html lang="en">
+
+<head>
+  <meta charset="UTF-8">
+  <title>Machine Learning for Beginners</title>
+  <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
+  <meta name="description" content="Description">
+  <meta name="viewport"
+    content="width=device-width, user-scalable=no, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0">
+  <link rel="icon" type="image/png" href="images/favicon.png">
+  <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/docsify-themeable@0/dist/css/theme-simple.css">
+</head>
+
+<body>
+  <div id="app"></div>
+  <script>
+    window.$docsify = {
+      name: 'Generative AI Learning for Beginners',
+      repo: 'https://github.com/Microsoft/generative-ai-for-beginners',
+      relativePath: true,
+      auto2top: true,
+    }
+  </script>
+  <script src="//cdn.jsdelivr.net/npm/docsify/lib/docsify.min.js"></script>
+</body>
+
+</html>