From 68da4c9cbe90260894d730b886451cee1b3a0f42 Mon Sep 17 00:00:00 2001 From: Simon Zhao <43029286+simonzhaoms@users.noreply.github.com> Date: Fri, 31 Dec 2021 16:01:18 +0800 Subject: [PATCH 1/4] Format getting started section --- README.md | 78 ++++++++++++++++++++++++++++++------------------------- 1 file changed, 43 insertions(+), 35 deletions(-) diff --git a/README.md b/README.md index e5d3389dac..7aadd3b2ac 100644 --- a/README.md +++ b/README.md @@ -40,41 +40,49 @@ and currently does not support version 3.8 and above. It is recommended to insta To set up on your local machine: -To install core utilities, CPU-based algorithms, and dependencies: - -1. Ensure software required for compilation and Python libraries is installed. On Linux this can be supported by adding: -```bash -sudo apt-get install -y build-essential libpython -``` -where `` should be `3.6` or `3.7` as appropriate. - -On Windows you will need [Microsoft C++ Build Tools](https://visualstudio.microsoft.com/visual-cpp-build-tools/). - -2. Create a conda or virtual environment. See the [setup guide](SETUP.md) for more details. - -3. Within the created environment, install the package from [PyPI](https://pypi.org): - -```bash -pip install --upgrade pip -pip install --upgrade setuptools -pip install recommenders[examples] -``` - -4. Register your (conda or virtual) environment with Jupyter: - -```bash -python -m ipykernel install --user --name my_environment_name --display-name "Python (reco)" -``` - -5. Start the Jupyter notebook server - -```bash -jupyter notebook -``` - -6. Run the [SAR Python CPU MovieLens](examples/00_quick_start/sar_movielens.ipynb) notebook under the `00_quick_start` folder. Make sure to change the kernel to "Python (reco)". - -For additional options to install the package (support for GPU, Spark etc.) see [this guide](recommenders/README.md). +* To install core utilities, CPU-based algorithms, and dependencies: + + 1. Ensure software required for compilation and Python libraries + is installed. On Linux this can be supported by adding: + + ```bash + sudo apt-get install -y build-essential libpython + ``` + + where `` should be `3.6` or `3.7` as appropriate. + + On Windows you will need [Microsoft C++ Build Tools](https://visualstudio.microsoft.com/visual-cpp-build-tools/). + + 2. Create a conda or virtual environment. See the + [setup guide](SETUP.md) for more details. + + 3. Within the created environment, install the package from + [PyPI](https://pypi.org): + + ```bash + pip install --upgrade pip + pip install --upgrade setuptools + pip install recommenders[examples] + ``` + + 4. Register your (conda or virtual) environment with Jupyter: + + ```bash + python -m ipykernel install --user --name my_environment_name --display-name "Python (reco)" + ``` + + 5. Start the Jupyter notebook server + + ```bash + jupyter notebook + ``` + + 6. Run the [SAR Python CPU MovieLens](examples/00_quick_start/sar_movielens.ipynb) + notebook under the `00_quick_start` folder. Make sure to change + the kernel to "Python (reco)". + +* For additional options to install the package (support for GPU, + Spark etc.) see [this guide](recommenders/README.md). **NOTE** - The [Alternating Least Squares (ALS)](examples/00_quick_start/als_movielens.ipynb) notebooks require a PySpark environment to run. Please follow the steps in the [setup guide](SETUP.md#dependencies-setup) to run these notebooks in a PySpark environment. For the deep learning algorithms, it is recommended to use a GPU machine and to follow the steps in the [setup guide](SETUP.md#dependencies-setup) to set up Nvidia libraries. From cb20d222249f28a8eaba31889b28d08a862c1b17 Mon Sep 17 00:00:00 2001 From: Simon Zhao <43029286+simonzhaoms@users.noreply.github.com> Date: Fri, 31 Dec 2021 16:04:01 +0800 Subject: [PATCH 2/4] Update --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 7aadd3b2ac..b6713cd86d 100644 --- a/README.md +++ b/README.md @@ -43,7 +43,7 @@ To set up on your local machine: * To install core utilities, CPU-based algorithms, and dependencies: 1. Ensure software required for compilation and Python libraries - is installed. On Linux this can be supported by adding: + is installed. On Linux this can be supported by adding: ```bash sudo apt-get install -y build-essential libpython @@ -78,8 +78,8 @@ To set up on your local machine: ``` 6. Run the [SAR Python CPU MovieLens](examples/00_quick_start/sar_movielens.ipynb) - notebook under the `00_quick_start` folder. Make sure to change - the kernel to "Python (reco)". + notebook under the `00_quick_start` folder. Make sure to + change the kernel to "Python (reco)". * For additional options to install the package (support for GPU, Spark etc.) see [this guide](recommenders/README.md). From d0b257ce4be376fbea3f8f372446596b0de74337 Mon Sep 17 00:00:00 2001 From: Simon Zhao <43029286+simonzhaoms@users.noreply.github.com> Date: Fri, 31 Dec 2021 16:30:23 +0800 Subject: [PATCH 3/4] Remove trailing whitespaces --- README.md | 36 +++++++++++++++++++----------------- 1 file changed, 19 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index b6713cd86d..59f0c483fb 100644 --- a/README.md +++ b/README.md @@ -43,40 +43,42 @@ To set up on your local machine: * To install core utilities, CPU-based algorithms, and dependencies: 1. Ensure software required for compilation and Python libraries - is installed. On Linux this can be supported by adding: - - ```bash - sudo apt-get install -y build-essential libpython - ``` - - where `` should be `3.6` or `3.7` as appropriate. - - On Windows you will need [Microsoft C++ Build Tools](https://visualstudio.microsoft.com/visual-cpp-build-tools/). - + is installed. + + * On Linux this can be supported by adding: + + ```bash + sudo apt-get install -y build-essential libpython + ``` + + where `` should be `3.6` or `3.7` as appropriate. + + * On Windows you will need [Microsoft C++ Build Tools](https://visualstudio.microsoft.com/visual-cpp-build-tools/). + 2. Create a conda or virtual environment. See the [setup guide](SETUP.md) for more details. - + 3. Within the created environment, install the package from [PyPI](https://pypi.org): - + ```bash pip install --upgrade pip pip install --upgrade setuptools pip install recommenders[examples] ``` - + 4. Register your (conda or virtual) environment with Jupyter: - + ```bash python -m ipykernel install --user --name my_environment_name --display-name "Python (reco)" ``` - + 5. Start the Jupyter notebook server - + ```bash jupyter notebook ``` - + 6. Run the [SAR Python CPU MovieLens](examples/00_quick_start/sar_movielens.ipynb) notebook under the `00_quick_start` folder. Make sure to change the kernel to "Python (reco)". From dac495aa12b3e86602560a7da7ef7c40773812f3 Mon Sep 17 00:00:00 2001 From: Simon Zhao <43029286+simonzhaoms@users.noreply.github.com> Date: Fri, 31 Dec 2021 16:32:04 +0800 Subject: [PATCH 4/4] Change * to + --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 59f0c483fb..ccc36d1d35 100644 --- a/README.md +++ b/README.md @@ -45,7 +45,7 @@ To set up on your local machine: 1. Ensure software required for compilation and Python libraries is installed. - * On Linux this can be supported by adding: + + On Linux this can be supported by adding: ```bash sudo apt-get install -y build-essential libpython @@ -53,7 +53,7 @@ To set up on your local machine: where `` should be `3.6` or `3.7` as appropriate. - * On Windows you will need [Microsoft C++ Build Tools](https://visualstudio.microsoft.com/visual-cpp-build-tools/). + + On Windows you will need [Microsoft C++ Build Tools](https://visualstudio.microsoft.com/visual-cpp-build-tools/). 2. Create a conda or virtual environment. See the [setup guide](SETUP.md) for more details.