From 3f04958673dc596597a5eaa3627c0590ead86986 Mon Sep 17 00:00:00 2001 From: Mo Chen Date: Sun, 12 Mar 2017 00:45:40 +0800 Subject: [PATCH 1/2] Update README.md --- README.md | 15 +++++++++------ 1 file changed, 9 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index a8c7b35..a272327 100644 --- a/README.md +++ b/README.md @@ -9,12 +9,11 @@ Description ------- The design goal of the code are as follows: -1. Clean: Code is very succinct. There are little nasty guarding code that distracts readers' attention. As a result, the core of the algorithms can be easily spot. -2. Efficient: Many tricks for making Matlab scripts efficient were applied (eg. vectorization and matrix factorization). Many functions are even comparable with C implementation. Usually, functions in this package are orders faster than Matlab builtin functions which provide the same functionality (eg. kmeans). If anyone found any Matlab implementation that is faster than mine, I am happy to further optimize. +1. Succinct: Code is extremely terse. Minimizing the number of line of code is one of the primal target. As a result, the core of the algorithms can be easily spot. +2. Efficient: Many tricks for making Matlab scripts fast were applied (eg. vectorization and matrix factorization). Many functions are even comparable with C implementation. Usually, functions in this package are orders faster than Matlab builtin functions which provide the same functionality (eg. kmeans). If anyone found any Matlab implementation that is faster than mine, I am happy to further optimize. 3. Robust: Many numerical stability techniques are applied, such as probability computation in log scale to avoid numerical underflow and overflow, square root form update of symmetric matrix, etc. -4. Easy to learn: The code is heavily commented. Reference formulas in PRML book are indicated for corresponding code lines. -5. Practical: The package is designed not only to be easily read, but also to be easily used to facilitate ML research. Many functions in this package are already widely used (see [Matlab file exchange](http://www.mathworks.com/matlabcentral/fileexchange/?term=authorid%3A49739)). - +4. Easy to learn: The code is heavily commented. Reference formulas in PRML book are indicated for corresponding code lines. Symbols are in sync with the book. +5. Practical: The package is designed not only to be easily read, but also to be easily used to facilitate ML research. Many functions in this package are already widely used (see [Matlab file exchange](http://www.mathworks.com/matlabcentral/fileexchange/?term=authorid%3A49739)). Installation ------- @@ -22,7 +21,11 @@ Installation 2. Run Matlab and navigate to package location as working directory, then run the init.m script. -3. Run some demos in the demo directory. Enjoy! +3. Run some demos in the your_location/demo directory. Enjoy! + +FeedBack +------- +If you found any bugs or have any suggestion, please do fire issues. I am graceful for any feedback and do my best to improve this package. License ------- From 444f001c9fea6307513b22974dd3e9b7c0944104 Mon Sep 17 00:00:00 2001 From: Mo Chen Date: Sun, 12 Mar 2017 00:50:57 +0800 Subject: [PATCH 2/2] Update README.md --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index a272327..5f53e50 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ Introduction This package is a Matlab implementation of the algorithms described in the classical machine learning textbook: Pattern Recognition and Machine Learning by C. Bishop ([PRML](http://research.microsoft.com/en-us/um/people/cmbishop/prml/)). -Note: this package requires Matlab R2016b or later, since it utilizes a new syntax of Matlab. +Note: this package requires Matlab R2016b or later, since it utilizes a new syntax of Matlab called [Implicit expansion](https://cn.mathworks.com/help/matlab/release-notes.html?rntext=implicit+expansion&startrelease=R2016b&endrelease=R2016b&groupby=release&sortby=descending) (a.k.a. broadcasting in Python). Description ------- @@ -25,7 +25,7 @@ Installation FeedBack ------- -If you found any bugs or have any suggestion, please do fire issues. I am graceful for any feedback and do my best to improve this package. +If you found any bug or have any suggestion, please do fire issues. I am graceful for any feedback and will do my best to improve this package. License -------