Add release notes (#57)

doc/conf.py

@@ -23,9 +23,9 @@
 author = 'Michael D. Ekstrand'
 
 # The short X.Y version
-version = '0.3'
+version = '0.5'
 # The full version, including alpha/beta/rc tags
-release = '0.3.0'
+release = '0.5.0'
 
 
 # -- General configuration ---------------------------------------------------
@@ -39,6 +39,7 @@
 # ones.
 extensions = [
     'nbsphinx',
+    'recommonmark',
     'sphinx.ext.napoleon',
     'sphinx.ext.autodoc',
     'sphinx.ext.intersphinx',

doc/index.rst

@@ -48,6 +48,7 @@ Resources
    evaluation/index
    algorithms
    util
+   releases
 
 
 Indices and tables

doc/releases.md

@@ -0,0 +1,26 @@
+# Release Notes
+
+## 0.5.0 (in progress)
+
+LensKit 0.5.0 modifies the algorithm APIs to follow the SciKit design patterns instead of
+our previous custom patterns.  Highlights of this change:
+
+- Algorithms are trained in-place — we no longer have distinct model objects.
+- Model data is stored as attributes on the algorithm object that end in `_`.
+- Instead of writing `model = algo.train_model(ratings)`, call `algo.fit(ratings)`.
+
+We also have some new capabilities:
+
+- Ben Frederickson's Implicit library
+
+## 0.3.0
+
+A number of improvements, including replacing Cython/OpenMP with Numba and adding ALS.
+
+## 0.2.0
+
+A lot of fixes to get ready for RecSys.
+
+## 0.1.0
+
+Hello, world!

setup.py

@@ -39,7 +39,8 @@
         'docs': [
             'sphinx >= 1.8',
             'sphinx_rtd_theme',
-            'nbsphinx'
+            'nbsphinx',
+            'recommonmark'
         ],
         'hpf': [
             'hpfrec'