Skip to content

Commit 48ad776

Browse files
committed
add more detail and structure + links
1 parent 9239868 commit 48ad776

File tree

1 file changed

+32
-9
lines changed

1 file changed

+32
-9
lines changed

README.md

Lines changed: 32 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,39 @@
1-
# python-examples-ml
2-
Python machine learning examples used for teaching
1+
# Python Machine Learning OpenCV Teaching Examples
32

4-
OpenCV Python machine leanring examples used for teaching within the Computer Science programme at Durham University (UK) by Toby Breckon.
3+
OpenCV Python machine learning examples used for teaching within the undergraduate Computer Science programme
4+
at [Durham University](http://www.durham.ac.uk) (UK) by [Prof. Toby Breckon](http://community.dur.ac.uk/toby.breckon/).
55

6-
All tested with OpenCV 3.1 and Python 3.x.
6+
All tested with [OpenCV](http://www.opencv.org) 3.x and Python 3.x.
77

8-
Demo source code is provided "as is" to aid your learning and understanding of topics on the course.
8+
---
99

10-
Most run with a webcam connected or from a command line supplied video file of a format OpenCV supports on your system (otherwise edit the script to provide your own image source).
10+
### Background:
1111

12-
N.B. you may need to change the line near the top that specifies the camera device to use on some examples below - change "0" if you have one webcam, I have it set to "1" to skip my built-in laptop webcam and use the connected USB camera.
12+
Directly adapted from the older [C++](https://github.com/tobybreckon/cpp-examples-ml) OpenCV machine learning teaching examples _(that for a long time, the in absence of other fully worked examples for the OpenCV machine learning components became the defacto reference for the use of these OpenCV routines)_
1313

14-
If you find any bugs report them to me - [email protected]
14+
All dataset examples are taken and reproduced from the [UCI Machine Learning Repository](http://archive.ics.uci.edu/ml/).
1515

16-
"may the source be with you" - anon.
16+
A related set of [Python Image Processing OpenCV Teaching Examples](https://github.com/tobybreckon/python-examples-ip.git) are also available covering basic image processing operations and similarly a set of [Python Computer Vision OpenCV Teaching Examples](https://github.com/tobybreckon/python-examples-cv.git)
17+
18+
---
19+
20+
### How to download and run:
21+
22+
Download each file as needed or to download the entire repository and run each try:
23+
24+
```
25+
git clone https://github.com/tobybreckon/python-examples-ml.git
26+
cd python-examples-ml
27+
cd <sub directory of one of the examples>
28+
python3 ./<insert file name of one of the examples>.py
29+
```
30+
31+
-- which _should_ then produce an output of the results on the dataset inside that example directory.
32+
33+
Demo source code is provided _"as is"_ to aid learning and understanding of topics on the course and beyond.
34+
35+
---
36+
37+
If you find any bugs raise an issue (or much better still submit a git pull request with a fix) - [email protected]
38+
39+
_"may the source be with you"_ - anon.

0 commit comments

Comments
 (0)