Reorganize the repository

- make it more generic (not cscm in the names)
- update the readme and license files
- use latest releases in pyproject.toml and requirements.txt
This commit is contained in:
Alexander Hess 2019-12-05 11:47:18 +01:00
commit 1566258b25
6 changed files with 185 additions and 124 deletions

View file

@ -1,34 +1,50 @@
# Introduction to Machine Learning with Python
# Workshop: Machine Learning for Beginners
## General Notes
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 contains a Jupyter notebook introducing some very basic concepts
of machine learning and the popular Iris classification case study.
First, some simple linear algebra ideas are shown via examples with the numpy
library. Then a so-called K-nearest-neighbor algorithm is trained to classify
flower from the Iris dataset.
## Prerequisites
This intro is aimed at total beginners to programming and machine learning.
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)**.
It was used within a 90 minute workshop at the
[WHU Campus for Supply Chain Management](http://campus-for-scm.de), which
targets students of business administration and young management professionals.
## Installation
This project uses popular Python libraries that can be installed via the
pipenv command line tool. To do so, run `pipenv install` or
`pipenv install --ignore-pipfile` (to use the exact environment as of the time
of this writing). For a tutorial on pipenv, go to the official
[documentation](https://pipenv.readthedocs.io/en/latest/).
To follow this workshop on your own computer, a working installation of
**Python 3.6** or higher is required.
After installation, start Jupyter via the command `jupyter notebook` and wait
for a new tab to be opened in your default web browser. Then, open the notebook
called [intro_to_machine_learning.ipynb](intro_to_machine_learning.ipynb).
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., *2019-10* with Python 3.7 at the
time of this writing) for your operating system.
## Read-only Version
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.
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).
## 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).
For those interested in just reading the example codes without installing
anything, just open this [notebook](intro_to_machine_learning.ipynb) and view
the Jupyter notebook in your browser.