1 Overview of Oracle Machine Learning for R Installation

This chapter introduces the OML4R installation process. This chapter contains the following topics:

1.1 Oracle Machine Learning for R Architecture for Oracle Database

OML4R has a client/server architecture based on Oracle Database and Oracle Client.

R engines run on the server computer and on each client computer. OML4R supports three key capabilities:

  • R Transparency

    OML4R packages on the client support R transparency, which enables Oracle tables to appear "transparently" as native R objects. OML4R packages provide transparent access to Oracle Database tables and views, enabling users to invoke standard R functions, which are translated into SQL transparently to the user for in-database execution.

  • Predictive Analytics and Machine Learning

    OML4R supports a wide range of parallel and distributed algorithms supporting predictive analytics and machine learning. This enables both scalability and improved performance, while leveraging a convenient R interface to in-database and database server-side algorithms.

  • Embedded R Execution

    OML4R packages, libraries, and R and SQL APIs on the server support the execution of user-defined R functions within SQL queries and PL/SQL statements. Embedded R execution spawns R engines that can run in parallel, for data-parallel and task-parallel execution. With embedded R execution, you can execute user-defined R functions, possibly leveraging third-party packages. With facilities like the DBMS_SCHEDULER database package, you can schedule the execution of user-defined R functions for lights-out processing.

Figure 1-1 Client/Server Architecture of OML4R



1.2 Client and Server Components of Oracle Machine Learning for R for On-Premises Database

Lists the client and server components of OML4R for On-Premises database.

  • OML4R Client Components:

    • Oracle Database Client

    • OML4R packages and supporting packages

  • OML4R Server Components:

    • Oracle Database with schema objects and shared libraries for supporting OML4R clients

    • OML4R packages and supporting packages

1.3 Oracle Machine Learning for R Installation Steps

These steps and this roadmap illustrate a typical OML4R installation.

For Oracle Database 19c or later, use the rqcfg.sql script to install OML4R Server, as described in Install Oracle Machine Learning for R Server for Oracle Database 19c or later.

Note:

If you intend to use both client and server components of OML4R on the computer that is hosting Oracle Database, then you do not need to perform a separate client installation. A local installation of Oracle Database Client is automatically included in the installation of Oracle Database.

Illustration of the Installation Steps

Figure 1-2 OML4R Client and Server Installation Steps

This figure illustrates the OML4R client and server installation steps.

Description of Figure 1-2 follows
Description of "Figure 1-2 OML4R Client and Server Installation Steps"

OML4R Installation Roadmap

This roadmap provides the steps required to install and configure a typical OML4R environment. To install OML4R, do the following:

  1. Verify that your system meets the basic requirements

  2. Obtain the correct installation software

  3. Perform and validate the installations

Table 1-1 Tasks for Installing OML4R

Task Description Documentation

1. Review the OML4R sample installation.

Review the steps for a typical installation of OML4R on a Linux server and a Windows client.

Note: All the supported configurations are listed in Oracle Machine Learning for R System Requirements for On-Premises Database.

A Sample Installation of Oracle Machine Learning for R

2. Verify supported platforms and system requirements.

Use the Platform Requirements table and Server Support Matrix to verify your environment meets the requirements for installation.

Oracle Machine Learning for R System Requirements for On-Premises Database

3. Identify installation users for Oracle R Distribution and OML4R.

The user executing the installation and configuration on your system requires sufficient permissions and privileges.

For Oracle R Distribution, the installation user is root (Unix/Linux) or Administrator (Windows).

User Requirements for OML4R Server

4. Download the product installers.

Oracle R Distribution is available from Oracle’s public yum or the Oracle download site. Oracle Database and Oracle Machine Learning for R are available on the Oracle download site.

For Oracle Database 18c and later, the OML4R installers are shipped with Oracle Database.

Oracle Database Software Downloads

Oracle R Distribution Downloads

Oracle Machine Learning for R Downloads

5. Install and configure Oracle Database.

OML4R requires the 64-bit version of Oracle Database Enterprise Edition.

Install and Configure the Database for Oracle Machine Learning for R

6. Install and configure R.

OML4R requires an installation of R on each node of the server and on each client computer that interacts with the server. Oracle R Distribution is recommended.

The OML4R Server components must be installed on the database server.

Install R for Oracle Machine Learning for R

7. Install and configure OML4R Server.

OML4R includes several components on the server. Together these components enable an OML4R client to interact with an OML4R server.

Install Oracle Machine Learning for R Server

Install Oracle Machine Learning for R on Exadata

8. Install Open Source R packages on the OML4R server.

Embedded R execution with OML4R allows the use of CRAN or other third-party R packages in user-defined R functions executed on the Oracle Database server.

About R Package Installation for Oracle Machine Learning for R

9. Install and configure the OML4R client.

If a physical client is configured, then you must install the following OML4R components separately on each client computer:

  • R

  • Oracle Instant Client

  • OML4R Client packages

  • OML4R Client Supporting packages

If you wish to run the OML4R client through a web browser, then install RStudio Server on the database server (Linux only).

Install Oracle Machine Learning for R Client

Installing RStudio

10. Install Open Source R packages on the OML4R client.

R packages installed on the OML4R server must also be installed on the OML4R client.

R Package Installation Basics

11. Verify the OML4R Installation.

Test the OML4R installation by connecting to the OML4R client to the server and executing some OML4R functions.

Verify the OML4R Server Installation

1.4 Oracle Machine Learning for R System Requirements for On-Premises Database

OML4R runs on 64-bit platforms only.

Both client and server components are supported on each of the platforms described in this topic.

Table 1-2 Oracle R Distribution Platform Requirements

Operating System Hardware Platform Description

Linux x86-64

Intel and AMD

  • 64-bit Oracle Linux Releases 6, 7, and 8

  • 64-bit Red Hat Enterprise Linux Releases 7

Table 1-3 Oracle Machine Learning for R Platform Requirements

Operating System Hardware Platform Description

Linux x86-64

Intel and AMD

  • 64-bit Oracle Linux Releases 6 and 7

  • 64-bit Red Hat Enterprise Linux Release 7

Oracle Linux may be running on Oracle Exadata Database Machine.

Oracle Solaris on x86-64 (64-Bit)

Oracle Solaris on SPARC-64 (64-Bit)

Intel and SPARC

  • 64-bit Oracle Solaris 10 update 11 through Oracle Solaris 11 for both SPARC and x86-64 (Intel) platforms

  • Oracle SPARC SuperCluster

  • Oracle Solaris Studio (formerly Sun Studio) 12u3 or later

Oracle Solaris may be running on Oracle Exadata Database Machine.

IBM AIX on POWER Systems (64-Bit)

IBM

64-bit IBM AIX 5.3 to 7.2

Microsoft Windows x64 (64-Bit)

Intel

64-bit Microsoft Windows Professional

The following table shows the supported configurations of OML4R Server components. Oracle recommends that you use Oracle R Distribution, Oracle's free distribution of R, with OML4R. You should install Oracle R Distribution before installing OML4R.

Table 1-4 Oracle Machine Learning for R Configuration Requirements and Server Support Matrix

OML4R Version Open Source R or Oracle R Distribution Oracle Database Release
1.5.1 3.6.1 12.2.0.1, 18c, 19c, 21c
1.5.1 3.3.0 11.2.0.4, 12.1.0.1, 12.1.0.2, 12.2.0.1
1.5 3.2.0 11.2.0.4, 12.1.0.1, 12.1.0.2
1.4.1 3.0.1, 3.1.1 11.2.0.3, 11.2.0.4, 12.1.0.1, 12.1.0.2
1.4 2.15.2, 2.15.3, 3.0.1 11.2.0.3, 11.2.0.4, 12.1.0.1
1.3.1 2.15.1, 2.15.2, 2.15.3 11.2.0.3, 11.2.0.4, 12.1.0.1
1.3 2.15.1 11.2.0.3, 11.2.0.4, 12.1.0.1
1.2 2.15.1 11.2.0.3, 11.2.0.4, 12.1.0.1
1.1 2.13.2 11.2.0.3, 11.2.0.4, 12.1.0.1
1.0 2.13.2 11.2.0.3, 11.2.0.4, 12.1.0.1

Note:

The version of R must be the same on the server and on each client computer. Also, the version of OML4R must be the same on the server and on each client computer.

Note:

Each version of Oracle R Distribution (ORD) is compatible with the OML4R binary built under that specific R version. For example, ORD 4.0.5 has an 1.5.1 binary built under R-4.0.5 and is not compatible with theOML4R 1.5.1 binaries built under R-3.6.1 or R-3.3.0.

Note:

Starting with Oracle Database 18c, to install OML4R you must use the installation scripts that come with the database. See Install Oracle Machine Learning for R Server for Oracle Database 19c or later.

Note:

In Oracle Database Release 12.1.0.2, for some embedded R operations to be successful, Oracle R Enterprise releases 1.4.1 and later require the database patch -- 20173897 WRONG RESULT OF GROUP BY FROM A TABLE RETURNED BY EXTPROC (Patch).

Verifying 64-Bit Architecture on Microsoft Windows

OML4R only runs on 64-bit operating systems. You can determine if your Windows system is 64-bit by following these steps

  • On Windows 10:
    • Hold down the Windows key and press I.
    • In the Settings window, under Device specifications, find System type. This entry shows whether the system is 64 bit.
  • On other versions of Windows, refer to the Windows documentation to find out how to display the bit version for your operating system.