diff --git a/README.md b/README.md index 1264a22..80d8dae 100644 --- a/README.md +++ b/README.md @@ -1,50 +1,64 @@ -# Workshop: Machine Learning for Beginners +# An Introduction to Data Science -This repository contains the code for the workshop "Machine Learning for -Beginners" as presented in various occasions at -[WHU - Otto Beisheim School of Management](https://www.whu.edu), such as the -[Campus for Supply Chain Management](https://www.campus-for-supply-chain-management-cscm.de/), -[IdeaLab](https://www.idealab.io)'s [IdeaHack](http://www.ideahack.io), or -within many [executive education](https://ee.whu.edu/) programs. +This project is an introductory workshop + in **[Data Science ](https://en.wikipedia.org/wiki/Data_science)** + in the programming language **[Python ](https://www.python.org/)**. +To learn about Python and programming in detail, + this [introductory course ](https://github.com/webartifex/intro-to-python) is recommended. -## Prerequisites +### Table of Contents -To be suitable for *total beginners*, there are *no* prerequisites. -If you are interested to learn more after this workshop, check out the -full-semester course **[Introduction to Python & Programming](https://github.com/webartifex/intro-to-python)**. +- *Chapter 0*: Python in a Nutshell +- *Chapter 1*: Python's Scientific Stack +- *Chapter 2*: A first Example: Classifying Flowers +- *Chapter 3*: [Case Study: House Prices in Ames, Iowa ](https://github.com/webartifex/ames-housing) -## Installation +### Objective -To follow this workshop on your own computer, a working installation of -**Python 3.7** or higher is required. +The **main goal** is to **show** students + how **Python** can be used to solve typical **data science** tasks. -A popular and beginner friendly way is to install the [Anaconda Distribution](https://www.anaconda.com/distribution/) -that not only ships Python but comes pre-packaged with a lot of third-party -libraries from the so-called "scientific stack". -Just go to the [download](https://www.anaconda.com/distribution/#download-section) -section and install the latest version (i.e., *2020-02* with Python 3.7 at the -time of this writing) for your operating system. -Then, among others, you will find an entry "Jupyter Notebook" in your start -menu. -Click on it and a new tab in your web browser will open where you can switch -between folders as you could in your computer's default file browser. +### Prerequisites -To download the course's materials as a ZIP file, click on the green "Clone or -download" button on the top right on this website. -Then, unpack the ZIP file into a folder of your choosing (ideally somewhere -within your personal user folder so that the files show up right away). +To be suitable for *beginners*, there are *no* formal prerequisites. +It is only expected that the student has: +- a *solid* understanding of the **English** language and +- knowledge of **basic mathematics** from high school. + + +### Getting started & Installation + +To follow this workshop, an installation of **Python 3.8** or higher is expected. + +A popular and beginner friendly way is + to install the [Anaconda Distribution](https://www.anaconda.com/products/individual) + that not only ships Python itself + but also comes pre-packaged with a lot of third-party libraries + including [Python's scientific stack](https://scipy.org/about.html). + +Detailed instructions can be found [here ](https://github.com/webartifex/intro-to-python#installation). + + +## Contributing + +Feedback **is highly encouraged** and will be incorporated. +Open an issue in the [issues tracker ](https://github.com/webartifex/intro-to-data-science/issues) + or initiate a [pull request ](https://help.github.com/en/articles/about-pull-requests) + if you are familiar with the concept. +Simple issues that *anyone* can **help fix** are, for example, + **spelling mistakes** or **broken links**. +If you feel that some topic is missing entirely, you may also mention that. +The materials here are considered a **permanent work-in-progress**. ## About the Author -Alexander Hess is a PhD student at the Chair of Logistics Management at the -[WHU - Otto Beisheim School of Management](https://www.whu.edu) where he -conducts research on urban delivery platforms and teaches an introductory -course on Python (cf., [Fall Term 2019](https://vlv.whu.edu/campus/all/event.asp?objgguid=0xE57C2715B01B441AAFD3E79AA05CACCF&from=vvz&gguid=0x6A2B0ED5B2B949E69957A2099E7DE2F1&mode=own&tguid=0x3980A9BBC3BF4A638E977F2DC163F44B&lang=en), -[Spring Term 2020](https://vlv.whu.edu/campus/all/event.asp?objgguid=0x3354F4C108FF4E959CDD692A325D9AFE&from=vvz&gguid=0x262E29795DD742CFBDE72B12B69CEFD6&mode=own&lang=en&tguid=0x2E4A7D1FF3C34AD08FF07685461781C9)). - -Connect him on [LinkedIn](https://www.linkedin.com/in/webartifex). +Alexander Hess is a PhD student + at the Chair of Logistics Management at [WHU - Otto Beisheim School of Management](https://www.whu.edu) + where he conducts research on urban delivery platforms + and teaches coding courses based on Python in the BSc and MBA programs. +Connect with him on [LinkedIn](https://www.linkedin.com/in/webartifex). diff --git a/pyproject.toml b/pyproject.toml index 756eb4a..74ac3d9 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -21,6 +21,10 @@ keywords = [ ] license = "MIT" +readme = "README.md" +homepage = "https://github.com/webartifex/intro-to-data-science" +repository = "https://github.com/webartifex/intro-to-data-science" + [tool.poetry.dependencies] python = "^3.8" diff --git a/static/link/README.md b/static/link/README.md new file mode 100644 index 0000000..f5c9136 --- /dev/null +++ b/static/link/README.md @@ -0,0 +1,2 @@ +This folder contains small images +that are used to enhance the links in the notebooks and markdown files. diff --git a/static/link/to_gh.png b/static/link/to_gh.png new file mode 100644 index 0000000..01f1a8a Binary files /dev/null and b/static/link/to_gh.png differ diff --git a/static/link/to_py.png b/static/link/to_py.png new file mode 100644 index 0000000..53c6045 Binary files /dev/null and b/static/link/to_py.png differ diff --git a/static/link/to_wiki.png b/static/link/to_wiki.png new file mode 100644 index 0000000..39ccb8c Binary files /dev/null and b/static/link/to_wiki.png differ