Merge pull request #44 from autumnai/develop

chore/changelog: add CHANGELOG

.clog.toml

@@ -0,0 +1,24 @@
+[clog]
+# A repository link with the trailing '.git' which will be used to generate
+# all commit and issue links
+repository = "https://github.com/autumnai/leaf"
+
+# specify the style of commit links to generate, defaults to "github" if omitted
+link-style = "github"
+
+# The preferred way to set a constant changelog. This file will be read for old changelog
+# data, then prepended to for new changelog data. It's the equivilant to setting
+# both infile and outfile to the same file.
+#
+# Do not use with outfile or infile fields!
+#
+# Defaults to stdout when omitted
+# changelog = "CHANGELOG.md"
+
+# This sets the output format. There are two options "json" or "markdown" and
+# defaults to "markdown" when omitted
+output-format = "markdown"
+
+# If you use tags, you can set the following if you wish to only pick
+# up changes since your latest tag
+from-latest-tag = true

CHANGELOG.md

@@ -0,0 +1,63 @@
+<a name="0.1.1"></a>
+## 0.1.1 (2015-11-30)
+
+
+#### Bug Fixes
+
+* **dependency:**  make collenchyma version constraint stricter ([355620ad](https://github.com/autumnai/leaf/commit/355620ad2383973267f3480715f0f160e60d9089))
+* **test:**  fix tests after adding collenchyma ([cc0d340e](https://github.com/autumnai/leaf/commit/cc0d340eb9684970ec94d547edbacaa1805fc16f))
+
+
+
+<a name="0.1.0"></a>
+## 0.1.0 (2015-11-10)
+
+
+#### Features
+
+* **backend:**  switch to collenchyma and update blob ([7556f55a](https://github.com/autumnai/leaf/commit/7556f55a0bee3b8c73017cdb2023c37831fb5a33))
+* **backpropagation:**  implemented backpropagation ([1e97f9d8](https://github.com/autumnai/leaf/commit/1e97f9d8c4ebe32f8fb521de0e1f7183ce78879e))
+* **ci:**  Added travis for CI and doc building ([324ea1b0](https://github.com/autumnai/leaf/commit/324ea1b0c92439f447f589219be303ca9e952e87))
+* **layer:**  progress on forwarding network; introducted ReadBlob and WriteBlob for Layers ([ab56a021](https://github.com/autumnai/leaf/commit/ab56a02156585747ade254ebaaa074f6c6102bc8))
+* **network:**  network forwarding and helpers ([0415f637](https://github.com/autumnai/leaf/commit/0415f637bbcff9301afa5f6bd02a4188cc4022d9))
+* **release:**  prepare for 0.0.1 ([52c5a95f](https://github.com/autumnai/leaf/commit/52c5a95f676b18298e14482648b82536bea00a18))
+* **solver:**
+  *  implement solver and sgd ([83db20d4](https://github.com/autumnai/leaf/commit/83db20d4540240aaa8c0031bd8b67ae4d6e4c264))
+  *  calculation of learning rate from config ([84a74449](https://github.com/autumnai/leaf/commit/84a74449d14fd7b8782917dbfe92099d620828ed))
+  *  started fleshing out sgd solver ([5985d581](https://github.com/autumnai/leaf/commit/5985d581743f7b0dfeb5f2675b26dadb026f118f))
+
+#### Bug Fixes
+
+* **build:**  added lib blas to travis dependency ([3fd3a285](https://github.com/autumnai/leaf/commit/3fd3a2858811a31c3c8b35a14b8faa2db74f9ea7))
+* **cargo:**  fixed homepage spelling ([c71c3196](https://github.com/autumnai/leaf/commit/c71c319639bc77a89eed7a2414b2e620d3890aa6))
+* **dependencies:**  locked dependencies more thightly as required by crates.io ([6c2a45ec](https://github.com/autumnai/leaf/commit/6c2a45ec887f9d3aaa42d0a11c13da995ebfb5ac))
+* **dim_check:**  fixed layer dimension checking based on the new interface of phloem ([f685ce7e](https://github.com/autumnai/leaf/commit/f685ce7e8da9bb1607636b07d8b8c8b64a989694))
+* **docs:**  own gh-pages token for doc upload ([0967dead](https://github.com/autumnai/leaf/commit/0967dead21818aac60204a8f79e4382448215bf7))
+* **keywords:**  remove whitespace from cargo keywords ([6b54de82](https://github.com/autumnai/leaf/commit/6b54de823282f6688347bcea4b4def674b90b1ae))
+* **phloem:**  updated shape interface change ([6169645c](https://github.com/autumnai/leaf/commit/6169645c4078b1f078cdac1969cf5915297cbcf4))
+* **typo:**  broken link in contribution guide ([71aec33b](https://github.com/autumnai/leaf/commit/71aec33b8ae9b1228f90cccb3c375f9b823f2b73))
+* **wording:**  Fixed wording of contribution guide; also some smaller typo fixes ([8bdea30a](https://github.com/autumnai/leaf/commit/8bdea30a382fda8cddd46a50784db8b97673f1bb))
+
+
+
+<a name="0.0.1"></a>
+## 0.0.1 (2015-11-02)
+
+
+#### Features
+
+* **ci:**  Added travis for CI and doc building ([324ea1b0](https://github.com/autumnai/leaf/commit/324ea1b0c92439f447f589219be303ca9e952e87))
+* **layer:**  progress on forwarding network; introducted ReadBlob and WriteBlob for Layers ([ab56a021](https://github.com/autumnai/leaf/commit/ab56a02156585747ade254ebaaa074f6c6102bc8))
+* **network:**  network forwarding and helpers ([0415f637](https://github.com/autumnai/leaf/commit/0415f637bbcff9301afa5f6bd02a4188cc4022d9))
+
+#### Bug Fixes
+
+* **build:**  added lib blas to travis dependency ([3fd3a285](https://github.com/autumnai/leaf/commit/3fd3a2858811a31c3c8b35a14b8faa2db74f9ea7))
+* **cargo:**  fixed homepage spelling ([c71c3196](https://github.com/autumnai/leaf/commit/c71c319639bc77a89eed7a2414b2e620d3890aa6))
+* **dim_check:**  fixed layer dimension checking based on the new interface of phloem ([f685ce7e](https://github.com/autumnai/leaf/commit/f685ce7e8da9bb1607636b07d8b8c8b64a989694))
+* **docs:**  own gh-pages token for doc upload ([0967dead](https://github.com/autumnai/leaf/commit/0967dead21818aac60204a8f79e4382448215bf7))
+* **phloem:**  updated shape interface change ([6169645c](https://github.com/autumnai/leaf/commit/6169645c4078b1f078cdac1969cf5915297cbcf4))
+* **wording:**  Fixed wording of contribution guide; also some smaller typo fixes ([8bdea30a](https://github.com/autumnai/leaf/commit/8bdea30a382fda8cddd46a50784db8b97673f1bb))
+
+
+

README.md

@@ -99,6 +99,20 @@ directly or engage at the [#rust-machine-learning][irc] IRC on irc.mozilla.org.
 [hobofan]: https://twitter.com/hobofan
 [irc]: https://chat.mibbit.com/?server=irc.mozilla.org&channel=%23rust-machine-learning
 
+## Changelog
+
+You can find the release history in the root file [CHANGELOG.md][changelog].
+
+A changelog is a log or record of all the changes made to a project, such as a
+website or software project, usually including such records as bug fixes, new
+features, etc. - [Wikipedia][changelog-quote]
+
+We are using [Clog][clog], the Rust tool for auto-generating CHANGELOG files.
+
+[changelog]: CHANGELOG.md
+[changelog-quote]: https://en.wikipedia.org/wiki/Changelog
+[Clog]: https://github.com/clog-tool/clog-cli
+
 ## Q&A
 
 #### _Why Rust?_