From 711fb80748140c44e0ed870e573c735307e6c3cc Mon Sep 17 00:00:00 2001 From: Nicolas Hug Date: Sun, 22 Apr 2018 18:21:45 +0200 Subject: [PATCH] Preparing 1.0.6 release --- CHANGELOG.md | 23 ++++++++++++++++++++++- README.md | 7 ++++--- setup.py | 25 +++++++++---------------- 3 files changed, 35 insertions(+), 20 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 415fa126..6cfb0e9a 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,20 +1,41 @@ Latest version, in development ============================== +Todo :) + +VERSION 1.0.6 +============= + +Date: 22/04/18 + Enhancements ------------ +* Added verbose option to algorithms using a similarity matrix or baseline + computation, to avoid unwanted printed messages. * When PredictionImpossible is raised, the prediction is now deferred to default_prediction() method, which can be overridden is child classes. This allows to not always set the default prediction to the average rating, which - can be useful for some algorithms (e.g. thos working with implicit positive + can be useful for some algorithms (e.g. those working with implicit positive feedback). * LeaveOneOut() now accepts a min_n_ratings parameter to make sure users in the trainset have at least min_n_ratings ratings. +* Dumping is now done with pickle's highest protocol which allows for larger + files. + +Bug Fixes +--------- + +* Joblib parameter `n_jobs` now defaults to 1 (no use of multiprocessing). + Should fix issues with Windows users. +* `cross_validate` now returns correct values for training measures (used to + return test measures instead). VERSION 1.0.5 ============= +Date: 09/01/18 + Enhancements ------------ diff --git a/README.md b/README.md index 8aa95fb0..e07e0aef 100644 --- a/README.md +++ b/README.md @@ -189,9 +189,10 @@ Contributors The following persons have contributed to [Surprise](http://surpriselib.com): -Олег Демиденко, Charles-Emmanuel Dias, Lukas Galke, Pierre-François Gimenez, Nicolas Hug, -Hengji Liu, Maher Malaeb, Naturale0, nju-luke, Skywhat, David Stevens, Mike Lee Williams, -Chenchen Xu. +Олег Демиденко, Charles-Emmanuel Dias, dmamylin, franckjay, Lukas Galke, +Pierre-François Gimenez, Nicolas Hug, Hengji Liu, Maher Malaeb, Manoj K, +Naturale0, nju-luke, Skywhat, David Stevens, Mike Lee Williams, Chenchen Xu, +YaoZh1918. Thanks a lot :) ! diff --git a/setup.py b/setup.py index 51f812ff..c19ff5ae 100644 --- a/setup.py +++ b/setup.py @@ -5,9 +5,6 @@ """ Release instruction: -pandoc must be install on machine so that readme (in markdown for jekyll) can -be converted to rst (for pypi). - Check that tests run correctly for 36 and 27 and doc compiles without warning (make clean first). @@ -15,17 +12,16 @@ First upload to test pypi: mktmpenv (Python version should not matter) - pip install numpy cython pypandoc twine + pip install numpy cython twine python setup.py sdist twine upload dist/blabla.tar.gz -r testpypi -Check that install works on testpypi (also check md is converted to rst), then -upload to pypi and check again. +Check that install works on testpypi, then upload to pypi and check again. to install from testpypi: pip install --index-url https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple scikit-surprise # noqa -push new release tag on github: - git tag v1.0.x +push new release tag on github (commit last changes first if needed): + git tag vX.Y.Z git push --tags Check that RTD has updated 'stable' to the new release (may take a while). @@ -56,17 +52,13 @@ else: USE_CYTHON = True -__version__ = 'latest' +__version__ = '1.0.6' here = path.abspath(path.dirname(__file__)) -# Get the long description from the README file and convert it to rst -try: - import pypandoc - long_description = pypandoc.convert(path.join(here, 'README.md'), 'rst') -except(IOError, ImportError): - with open(path.join(here, 'README.md'), encoding='utf-8') as f: - long_description = f.read() +# Get the long description from README.md +with open(path.join(here, 'README.md'), encoding='utf-8') as f: + long_description = f.read() # get the dependencies and installs with open(path.join(here, 'requirements.txt'), encoding='utf-8') as f: @@ -114,6 +106,7 @@ description=('An easy-to-use library for recommender systems.'), long_description=long_description, + long_description_content_type='text/markdown', version=__version__, url='http://surpriselib.com',