Compartir a través de

Install Microsoft R Client on Linux

  • Artículo

Important

This content is being retired and may not be updated in the future. The support for Machine Learning Server will end on July 1, 2022. For more information, see What's happening to Machine Learning Server?

Microsoft R Client is a free data science tool for high-performance analytics that you can install on popular Linux operating systems, including CentOS, Red Hat, and Ubuntu. R Client is built on top of Microsoft R Open so you can use any open-source R packages to build your analytics, and includes the R function libraries from Microsoft that execute locally on R Client or remotely on a more powerful Machine Learning Server.

R Client allows you to work with production data locally using the full set of RevoScaleR functions, with these constraints: data must fit in local memory, and processing is capped at two threads for RevoScaleR functions.

For information about the current release, see What's new in R Client.

System Requirements

Type Requirement
Operating Systems Supported versions include:
- Red Hat Enterprise Linux (RHEL) and CentOS 6.x and 7.x
- Ubuntu 14.04 and 16.04
- SUSE Linux Enterprise Server 11 (SLES11)

Must be a supported version of Linux on a 64-bit with x86-compatible architecture (variously known as AMD64, Intel64, x86-64, IA-32e, EM64T, or x64 chips). Itanium-architecture chips (also known as IA-64) are not supported. Multiple-core chips are recommended.
Available RAM 2 GB of RAM is required; 8 GB or more are recommended
Free disk space 600 MB recommended, after installation of all prerequisites
1.2 GB recommended if pre-trained models are installed
Internet access Needed to download R Client and any dependencies. If you do not have an internet connection, for the instructions for an offline installation

MRO (R) and R Client version matrix

Included and required for R Client setup is Microsoft R Open (MRO). Microsoft R Open is a built-in dependency of Microsoft R Client. In offline scenarios when no internet connection is available on the target machine, you must manually download the MRO installer of the version required by R Client. Use only the link specified in the installer or in this article. Do NOT go to MRAN and download it from there or you may inadvertently get the wrong version for your Microsoft R product.

You can use links and instructions in this article to install either 3.4.1 or 3.4.3 versions of R Client.

R version MRO version R Client version ML Server version
3.5.2 3.5.2 3.5.2 9.4
3.4.3 3.4.3 3.4.3 9.3
3.4.1 3.4.1 3.4.1 9.2.1

Setup Requirements

  • Use a package manager from this list:

    Package manager Platform
    yum RHEL, CentOS
    apt Ubuntu online
    dpkg Ubuntu offline
    zypper SUSE
    rpm RHEL, CentOS, SUSE

  • Root or super user permissions are required.

  • You must install Microsoft R Client to a local drive on your computer.

  • You may need to disable your antivirus software. If you do, please turn it back on as soon as you are finished.

Installation paths

After installation completes, software can be found at the following paths:

  • Install root: /opt/microsoft/rclient/3.5.2 (or 3.4.3, 3.4.1)
  • Microsoft R Open root: /opt/microsoft/ropen/3.5.2 (or 3.4.3, 3.4.1)
  • Executables like Revo64 are under /usr/bin

There is no support for side-by-side installations of older and newer versions.

How to install (with internet access)

This section walks you through an R Client deployment. Under these instructions, your installation includes the ability to use the RevoScaleR, MicrosoftML, and mrsdeploy (mrsdeploy is server-side; calls to mrsdeploy must also include remote compute context functions that shift execution to a remote server).

The package manager downloads packages from the packages.microsoft.com repo, determines dependencies, retrieves additional packages, sets the installation order, and installs the software. For example syntax on setting the repo, see Linux Software Repository for Microsoft Products.

Note

If the repository configuration file is not present in the /etc directory, try manual configuration for repository registration.

On Ubuntu 14.04 - 16.04

With root or sudo permissions, run the following commands:

# Install as root or sudo
sudo su

# If your system does not have the https apt transport option, add it now
apt-get install apt-transport-https

# Set the package repository location containing the R Client distribution. 
# On Ubuntu 14.04.
# wget http://packages.microsoft.com/config/ubuntu/14.04/prod/packages-microsoft-prod.deb 
# On Ubuntu 16.04.
wget http://packages.microsoft.com/config/ubuntu/16.04/packages-microsoft-prod.deb 

# Register the repo.
dpkg -i packages-microsoft-prod.deb

# Check for microsoft-prod.list configuration file to verify registration.
ls -la /etc/apt/sources.list.d/

# Update packages on your system
apt-get update

# Install the 3.5.2 packages
# Alternative for 3.4.1: apt-get install microsoft-r-client-packages-3.4.1
# Alternative for 3.4.3: apt-get install microsoft-r-client-packages-3.4.3
apt-get install microsoft-r-client-packages-3.5.2

# List the packages
ls /opt/microsoft/rclient/

Red Hat and CentOS 6/7

With root or sudo permissions, run the following commands:

# Install as root or sudo
sudo su

# Set the package repository location containing the R Client distribution. 
# On RHEL 6:
# rpm -Uvh https://packages.microsoft.com/config/rhel/6/packages-microsoft-prod.rpm
# On RHEL 7:
rpm -Uvh https://packages.microsoft.com/config/rhel/7/packages-microsoft-prod.rpm

# Check for microsoft-prod.repo configuration file to verify registration.
ls -la /etc/yum.repos.d/ 

# Update packages on your system
yum update

# Install the 3.5.2 packages
# Alternative for 3.4.1: yum install microsoft-r-client-packages-3.4.1
# Alternative for 3.4.3: yum install microsoft-r-client-packages-3.4.3
yum install microsoft-r-client-packages-3.5.2

SUSE Linux Enterprise Server 11

With root or sudo permissions, run the following commands:

# Install as root or sudo
sudo su

# Set the package repository location containing the R Client distribution. 
zypper ar -f http://packages.microsoft.com/sles/11/prod packages-microsoft-com

# Update packages on your system
zypper update

# Install the 3.5.2 packages
# Alternative for 3.4.1: zypper install microsoft-r-client-packages-3.4.1
# Alternative for 3.4.3: zypper install microsoft-r-client-packages-3.4.3
zypper install microsoft-r-client-packages-3.5.2

You can now set up your IDE and try out some sample code.


How to install offline (without internet access)

By default, installers connect to Microsoft download sites to get required and updated components. If firewall restrictions or limits on internet access prevent the installer from reaching these sites, you can download individual components on a computer that has internet access, copy the files to another computer behind the firewall, manually install prerequisites and packages, and then run setup.

If you previously installed version 3.4.1 or 3.4.3, it will be replaced with the 3.5.2 version.

Packages for all supported versions of Linux can be found at packages.microsoft.com.

Package list

The package list is the same for both 3.4.1, 3.4.3 and 3.5.2, with version numbers being the only difference. The following packages comprise a full R Client 3.5.2 installation:

 microsoft-r-client-packages-3.5.2     ** core
 microsoft-r-client-mml-3.5.2          ** microsoftml for R (optional)
 microsoft-r-client-mlm-3.5.2          ** pre-trained models (requires microsoftml)

Microsoft R Open is required for R execution:

 microsoft-r-open-foreachiterators-3.5.2
 microsoft-r-open-mkl-3.5.2
 microsoft-r-open-mro-3.5.2

Additional open-source packages must be installed if a package is required but not found on the system. This list varies for each installation. Here is one example of the additional packages that were added to a clean RHEL image during a connected (online) setup:

 cairo
 fontconfig 
 fontpackages-filesystem
 graphite2 
 harfbuzz 
 libICE  
 libSM   
 libXdamage  
 libXext  
 libXfixes  
 libXft  
 libXrender  
 libXt    
 libXxf86vm  
 libicu      
 libpng12   
 libthai
 libunwind     
 libxshmfence   
 mesa-libEGL
 mesa-libGL     
 mesa-libgbm    
 mesa-libglapi 
 pango   
 paratype-pt-sans-caption-fonts  
 pixman

Download packages

If your system provides a graphical user interface, you can click a file to download it. Otherwise, use wget. We recommend downloading all packages to a single directory so that you can install all of them in a single command. By default, wget uses the working directory, but you can specify an alternative path using the -outfile parameter.

The following example is for the first package. Each command references the version number of the platform. Remember to change the number if your version is different. For more information, see Linux Software Repository for Microsoft Products.

R Client 3.5.2 downloads

  • Download to CentOS or RHEL 6: wget https://packages.microsoft.com/rhel/6/prod/microsoft-r-client-packages-3.5.2.rpm
  • Download to CentOS or RHEL 7: wget https://packages.microsoft.com/rhel/7/prod/microsoft-r-client-packages-3.5.2.rpm
  • Download to SUSE: wget https://packages.microsoft.com/sles/11/prod/microsoft-r-client-packages-3.5.2.rpm
  • Download to Ubuntu 14.04: wget https://packages.microsoft.com/ubuntu/14.04/prod/pool/main/m/microsoft-r-client-packages-3.5.2/microsoft-r-client-packages-3.5.2.deb
  • Download to Ubuntu 16.04: wget https://packages.microsoft.com/ubuntu/16.04/prod/pool/main/m/microsoft-r-client-packages-3.5.2/microsoft-r-client-packages-3.5.2.deb

Repeat for each package.

R Client 3.4.3 downloads

  • Download to CentOS or RHEL 6: wget https://packages.microsoft.com/rhel/6/prod/microsoft-r-client-packages-3.4.3.rpm
  • Download to CentOS or RHEL 7: wget https://packages.microsoft.com/rhel/7/prod/microsoft-r-client-packages-3.4.3.rpm
  • Download to SUSE: wget https://packages.microsoft.com/sles/11/prod/microsoft-r-client-packages-3.4.3.rpm
  • Download to Ubuntu 14.04: wget https://packages.microsoft.com/ubuntu/14.04/prod/pool/main/m/microsoft-r-client-packages-3.4.3/microsoft-r-client-packages-3.4.3.deb
  • Download to Ubuntu 16.04: wget https://packages.microsoft.com/ubuntu/16.04/prod/pool/main/m/microsoft-r-client-packages-3.4.3/microsoft-r-client-packages-3.4.3.deb

Repeat for each package.

R Client 3.4.1 downloads

  • Download to CentOS or RHEL 6: wget https://packages.microsoft.com/rhel/6/prod/microsoft-r-client-packages-3.4.1.rpm
  • Download to CentOS or RHEL 7: wget https://packages.microsoft.com/rhel/7/prod/microsoft-r-client-packages-3.4.1.rpm
  • Download to SUSE: wget https://packages.microsoft.com/sles/11/prod/microsoft-r-client-packages-3.4.1.rpm
  • Download to Ubuntu 14.04: wget https://packages.microsoft.com/ubuntu/14.04/prod/pool/main/m/microsoft-r-client-packages-3.4.1/microsoft-r-client-packages-3.4.1.deb
  • Download to Ubuntu 16.04: wget https://packages.microsoft.com/ubuntu/16.04/prod/pool/main/m/microsoft-r-client-packages-3.4.1/microsoft-r-client-packages-3.4.1.deb

Repeat for each package.

Install packages

The package manager determines the installation order. Assuming all packages are in the same folder:

  • Install on CentOS or RHEL: yum install *.rpm
  • Install on Ubuntu: dpkg -i *.deb
  • Install on SUSE: zypper install *.rpm

This step completes installation.

Connect and validate

  1. List installed packages:

    • On CentOS and RHEL: rpm -qa | grep microsoft
    • On Ubuntu: apt list --installed | grep microsoft
    • On SLES11: zypper se microsoft

  2. Once you have a package name, you can obtain verbose version information. For example:

    • On CentOS and RHEL: $ rpm -qi microsoft-r-client-packages-3.5.2
    • On Ubuntu: $ dpkg --status microsoft-r-client-packages-3.5.2
    • On SLES: zypper info microsoft-r-client-packages-3.5.2

    Output on Ubuntu is as follows:

     Package: microsoft-r-client-packages-3.5.2
 Status: install ok installed
 Priority: optional
 Section: devel
 Installed-Size: 195249
 Maintainer: revobuil@microsoft.com
 Architecture: amd64
 Version: 3.5.2
 Depends: microsoft-r-open-mro-3.5.2, microsoft-r-open-mkl-3.5.2, microsoft-r-open-foreachiterators-3.5.2
 Description: Microsoft R Client 3.5.2
   . . .

You can now set up your IDE and try out some sample code. Also, consider package management as described in the next section.

Set a MKL_CBWR variable

Set an MKL_CBWR environment variable to ensure consistent output from Intel Math Kernel Library (MKL) calculations.

  • Edit or create a file named .bash_profile in your user home directory, adding the line export MKL_CBWR="AUTO" to the file.

  • Execute this file by typing source .bash_profile at a bash command prompt.

Offline Package Management

Review the recommendations in Package Management for instructions on how to set up a local package repository using MRAN or miniCRAN. As we mentioned earlier, you must install the gcc-c++ and gcc-gfortran binary packages to be able to build and install packages, including miniCRAN.

How to uninstall R Client

This section walks you through a 3.5.2 uninstall. To uninstall 3.4.1 or 3.4.3, use the same commands, modifying the version.

  1. On root@, uninstall Microsoft R Open (MRO) first. This action removes any dependent packages used only by MRO, which includes packages like microsoft-mlserver-packages-r.

    • On RHEL: yum erase microsoft-r-open-mro-3.5.2
    • On Ubuntu: apt-get purge microsoft-r-open-mro-3.5.2
    • On SUSE: zypper remove microsoft-r-open-mro-3.5.2

  2. Re-list the packages from Microsoft to check for remaining files:

    • On RHEL: yum list \*microsoft\*
    • On Ubuntu: apt list --installed | grep microsoft
    • On SUSE: zypper search \*microsoft-r\*

    On Ubuntu, you might have dotnet-runtime-2.0.0. NET Core is a cross-platform, general purpose development platform maintained by Microsoft and the .NET community on GitHub. This package could be providing infrastructure to other applications on your computer. If R Client is the only Microsoft software you have, you can remove it now.

  3. After packages are uninstalled, remove remaining files. On root@, determine whether additional files still exist:

    • $ ls /opt/microsoft/rclient/3.5.2/

  4. Remove the entire directory:

    • $ rm -fr ls /opt/microsoft/rclient/3.5.2/

RM removes the folder. Parameter "f" is for force and "r" for recursive, deleting everything under microsoft/rclient. This command is destructive and irrevocable, so be sure you have the correct directory before you press Enter.

Configure RStudio for RevoScaleR

If you are using the RStudio IDE, perform the following steps to load RevoScaleR and other R Client libraries.

  1. Close RStudio if it is already open.

  2. Start a terminal session and sign on as root (sudo su).

  3. Open the Renviron file for editing:

    gedit /opt/microsoft/rclient/3.5.2/runtime/R/etc/Renviron

  4. Scroll down to R_LIBS_USER and add a new configuration setting just below it:

    R_LIBS_SITE=/opt/microsoft/rclient/3.5.2/libraries/RServer

  5. Save the file.

  6. Start RStudio. In the Console window, you should see messages indicating both the Microsoft R Open and Microsoft R Client packages are loaded.

  7. To confirm RevoScaleR is operational, run the RevoScaleR rxSummary function to return statistical summary information on the built-in Iris dataset:

    rxSummary(~., iris)

Learn More

You can learn more with these guides: