Merge pull request #1456 from microsoft/staging

Staging to main: prepare for release

NEWS.md

@@ -1,5 +1,15 @@
 # What's New
 
+## Update June 21, 2021
+
+We have a new release [Recommenders 0.6.0](https://github.com/microsoft/recommenders/releases/tag/0.6.0)!
+
+Recommenders is now on PyPI and can be installed using pip! In addition there are lots of bug fixes and utilities improvements.
+
+Here you can find the PyPi page: https://pypi.org/project/ms-recommenders/
+
+Here you can find the package documentation: https://microsoft-recommenders.readthedocs.io/en/latest/
+
 ## Update June 1, 2021
 
 We have surpassed 10k stars!

README.md

@@ -2,15 +2,15 @@
 
 [![Documentation Status](https://readthedocs.org/projects/microsoft-recommenders/badge/?version=latest)](https://microsoft-recommenders.readthedocs.io/en/latest/?badge=latest)
 
-## What's New (June 1, 2021)
+## What's New (June 21, 2021)
 
-We have surpassed 10k stars!
+We have a new release [Recommenders 0.6.0](https://github.com/microsoft/recommenders/releases/tag/0.6.0)!
 
-Microsoft Recommenders repository has reached 10k stars and has become the most starred open-source recommender system project on GitHub.
+Recommenders is now on PyPI and can be installed using pip! In addition there are lots of bug fixes and utilities improvements.
 
-Many thanks and congratulations to all the contributors to this repository! More advanced algorithms and best practices are yet to come!
+Here you can find the PyPi page: https://pypi.org/project/ms-recommenders/
 
-See past announcements in [NEWS.md](NEWS.md).
+Here you can find the package documentation: https://microsoft-recommenders.readthedocs.io/en/latest/
 
 ## Introduction
 
@@ -34,7 +34,7 @@ The installation of the recommenders package has been tested with Python version
 
 To set up on your local machine:
 
-To install core utilities, CPU-based algorithms, and dependencies
+To install core utilities, CPU-based algorithms, and dependencies:
 
 1. Ensure software required for compilation is installed. On Linux this can be supported by adding build-essential dependencies:
 ```bash
@@ -144,7 +144,7 @@ These tests are the nightly builds, which compute the smoke and integration test
 
 ### DSVM Build Status
 
-The following tests run on a Windows and Linux DSVM daily. These machines run 24/7.
+The following tests run on a Linux DSVM daily. These machines run 24/7.
 
 | Build Type | Branch | Status | | Branch | Status |
 | --- | --- | --- | --- | --- | --- |

SETUP.md

@@ -351,4 +351,4 @@ First make sure that the tag that you want to add, e.g. `0.6.0`, is added in [re
 generates a wheel and a tar.gz which are uploaded to a [GitHub draft release](https://github.com/microsoft/recommenders/releases).
 1. Fill up the draft release with all the recent changes in the code.
 1. Download the wheel and tar.gz locally, these files shouldn't have any bug, since they passed all the tests.
-1. Publish the wheel and tar.gz to pypi: `twine upload ms-recommenders*`
+1. Publish the wheel and tar.gz to pypi: `twine upload ms_recommenders*`

setup.py

@@ -21,7 +21,7 @@
 if HASH is not None:
  version += ".post" + str(int(time.time()))
 
-name = environ.get("LIBRARY_NAME", "ms-recommenders")
+name = environ.get("LIBRARY_NAME", "ms_recommenders")
 
 install_requires = [
  "numpy>=1.14",

tests/ci/azure_pipeline_test/dsvm_notebook_linux_cpu.yml

@@ -1,15 +1,53 @@
 # Copyright (c) Microsoft Corporation. All rights reserved.
 # Licensed under the MIT License.
 
-# Pull request against these branches will trigger this build
+# Pull request against these branches will trigger this build, excluding some files
 pr:
-- main
-- staging
+ branches:
+ include:
+ - main
+ - staging
+ paths:
+ exclude:
+ - contrib/*
+ - scenarios/*
+ - tools/*
+ - README.md
+ - AUTHORS.md
+ - CODE_OF_CONDUCT.md
+ - CONTRIBUTING.md
+ - GLOSSARY.md
+ - NEWS.md
+ - SECURITY.md
+ - SETUP.md
+ - .gitignore
+ - examples/README.md
+ - reco_utils/README.md
+ - tests/README.md
 
-# Any commit to this branch will trigger the build.
+# Any commit to this branch will trigger the build, excluding some files
 trigger:
-- staging
-- main
+ branches:
+ include:
+ - main
+ - staging
+ paths:
+ exclude:
+ - contrib/*
+ - scenarios/*
+ - tools/*
+ - README.md
+ - AUTHORS.md
+ - CODE_OF_CONDUCT.md
+ - CONTRIBUTING.md
+ - GLOSSARY.md
+ - NEWS.md
+ - SECURITY.md
+ - SETUP.md
+ - .gitignore
+ - examples/README.md
+ - reco_utils/README.md
+ - tests/README.md
 
 variables:
 - group: LinuxAgentPool

tests/ci/azure_pipeline_test/dsvm_notebook_linux_gpu.yml

@@ -1,15 +1,53 @@
 # Copyright (c) Microsoft Corporation. All rights reserved.
 # Licensed under the MIT License.
 
-# Pull request against these branches will trigger this build
+# Pull request against these branches will trigger this build, excluding some files
 pr:
-- main
-- staging
+ branches:
+ include:
+ - main
+ - staging
+ paths:
+ exclude:
+ - contrib/*
+ - scenarios/*
+ - tools/*
+ - README.md
+ - AUTHORS.md
+ - CODE_OF_CONDUCT.md
+ - CONTRIBUTING.md
+ - GLOSSARY.md
+ - NEWS.md
+ - SECURITY.md
+ - SETUP.md
+ - .gitignore
+ - examples/README.md
+ - reco_utils/README.md
+ - tests/README.md
 
-# Any commit to this branch will trigger the build.
+# Any commit to this branch will trigger the build, excluding some files
 trigger:
-- staging
-- main
+ branches:
+ include:
+ - main
+ - staging
+ paths:
+ exclude:
+ - contrib/*
+ - scenarios/*
+ - tools/*
+ - README.md
+ - AUTHORS.md
+ - CODE_OF_CONDUCT.md
+ - CONTRIBUTING.md
+ - GLOSSARY.md
+ - NEWS.md
+ - SECURITY.md
+ - SETUP.md
+ - .gitignore
+ - examples/README.md
+ - reco_utils/README.md
+ - tests/README.md
 
 variables:
 - group: LinuxAgentPool

tests/ci/azure_pipeline_test/dsvm_notebook_linux_pyspark.yml

@@ -1,15 +1,53 @@
 # Copyright (c) Microsoft Corporation. All rights reserved.
 # Licensed under the MIT License.
 
-# Pull request against these branches will trigger this build
+# Pull request against these branches will trigger this build, excluding some files
 pr:
-- main
-- staging
+ branches:
+ include:
+ - main
+ - staging
+ paths:
+ exclude:
+ - contrib/*
+ - scenarios/*
+ - tools/*
+ - README.md
+ - AUTHORS.md
+ - CODE_OF_CONDUCT.md
+ - CONTRIBUTING.md
+ - GLOSSARY.md
+ - NEWS.md
+ - SECURITY.md
+ - SETUP.md
+ - .gitignore
+ - examples/README.md
+ - reco_utils/README.md
+ - tests/README.md
 
-# Any commit to this branch will trigger the build.
+# Any commit to this branch will trigger the build, excluding some files
 trigger:
-- staging
-- main
+ branches:
+ include:
+ - main
+ - staging
+ paths:
+ exclude:
+ - contrib/*
+ - scenarios/*
+ - tools/*
+ - README.md
+ - AUTHORS.md
+ - CODE_OF_CONDUCT.md
+ - CONTRIBUTING.md
+ - GLOSSARY.md
+ - NEWS.md
+ - SECURITY.md
+ - SETUP.md
+ - .gitignore
+ - examples/README.md
+ - reco_utils/README.md
+ - tests/README.md
 
 variables:
 - group: LinuxAgentPool

tests/ci/azure_pipeline_test/dsvm_unit_linux_cpu.yml

@@ -1,15 +1,53 @@
 # Copyright (c) Microsoft Corporation. All rights reserved.
 # Licensed under the MIT License.
 
-# Pull request against these branches will trigger this build
+# Pull request against these branches will trigger this build, excluding some files
 pr:
-- main
-- staging
+ branches:
+ include:
+ - main
+ - staging
+ paths:
+ exclude:
+ - contrib/*
+ - scenarios/*
+ - tools/*
+ - README.md
+ - AUTHORS.md
+ - CODE_OF_CONDUCT.md
+ - CONTRIBUTING.md
+ - GLOSSARY.md
+ - NEWS.md
+ - SECURITY.md
+ - SETUP.md
+ - .gitignore
+ - examples/README.md
+ - reco_utils/README.md
+ - tests/README.md
 
-# Any commit to this branch will trigger the build.
+# Any commit to this branch will trigger the build, excluding some files
 trigger:
-- staging
-- main
+ branches:
+ include:
+ - main
+ - staging
+ paths:
+ exclude:
+ - contrib/*
+ - scenarios/*
+ - tools/*
+ - README.md
+ - AUTHORS.md
+ - CODE_OF_CONDUCT.md
+ - CONTRIBUTING.md
+ - GLOSSARY.md
+ - NEWS.md
+ - SECURITY.md
+ - SETUP.md
+ - .gitignore
+ - examples/README.md
+ - reco_utils/README.md
+ - tests/README.md
 
 variables:
 - group: LinuxAgentPool

tests/ci/azure_pipeline_test/dsvm_unit_linux_gpu.yml

@@ -1,15 +1,53 @@
 # Copyright (c) Microsoft Corporation. All rights reserved.
 # Licensed under the MIT License.
 
-# Pull request against these branches will trigger this build
+# Pull request against these branches will trigger this build, excluding some files
 pr:
-- main
-- staging
+ branches:
+ include:
+ - main
+ - staging
+ paths:
+ exclude:
+ - contrib/*
+ - scenarios/*
+ - tools/*
+ - README.md
+ - AUTHORS.md
+ - CODE_OF_CONDUCT.md
+ - CONTRIBUTING.md
+ - GLOSSARY.md
+ - NEWS.md
+ - SECURITY.md
+ - SETUP.md
+ - .gitignore
+ - examples/README.md
+ - reco_utils/README.md
+ - tests/README.md
 
-# Any commit to this branch will trigger the build.
+# Any commit to this branch will trigger the build, excluding some files
 trigger:
-- staging
-- main
+ branches:
+ include:
+ - main
+ - staging
+ paths:
+ exclude:
+ - contrib/*
+ - scenarios/*
+ - tools/*
+ - README.md
+ - AUTHORS.md
+ - CODE_OF_CONDUCT.md
+ - CONTRIBUTING.md
+ - GLOSSARY.md
+ - NEWS.md
+ - SECURITY.md
+ - SETUP.md
+ - .gitignore
+ - examples/README.md
+ - reco_utils/README.md
+ - tests/README.md
 
 variables:
 - group: LinuxAgentPool