Artificial Intelligence

So, how come we will use TensorFlow from R?

31 January 2024
Bourahima



Which pc language is most carefully related to TensorFlow? Whereas on the TensorFlow for R weblog, we might after all like the reply to be R, likelihood is it’s Python (although TensorFlow has official bindings for C++, Swift, Javascript, Java, and Go as nicely).

So why is it you may outline a Keras mannequin as

library(keras)
mannequin <- keras_model_sequential() %>%
  layer_dense(models = 32, activation = "relu") %>%
  layer_dense(models = 1)

(good with %>%s and all!) – then prepare and consider it, get predictions and plot them, all that with out ever leaving R?

The quick reply is, you’ve got keras, tensorflow and reticulate put in.
reticulate embeds a Python session inside the R course of. A single course of means a single tackle house: The identical objects exist, and will be operated upon, no matter whether or not they’re seen by R or by Python. On that foundation, tensorflow and keras then wrap the respective Python libraries and allow you to write R code that, in truth, appears like R.

This put up first elaborates a bit on the quick reply. We then go deeper into what occurs within the background.

One word on terminology earlier than we leap in: On the R facet, we’re making a transparent distinction between the packages keras and tensorflow. For Python we’re going to use TensorFlow and Keras interchangeably. Traditionally, these have been completely different, and TensorFlow was generally considered one doable backend to run Keras on, moreover the pioneering, now discontinued Theano, and CNTK. Standalone Keras does nonetheless exist, however latest work has been, and is being, executed in tf.keras. In fact, this makes Python Keras a subset of Python TensorFlow, however all examples on this put up will use that subset so we will use each to check with the identical factor.

So keras, tensorflow, reticulate, what are they for?

Firstly, nothing of this could be doable with out reticulate. reticulate is an R package deal designed to permit seemless interoperability between R and Python. If we completely wished, we might assemble a Keras mannequin like this:

<class 'tensorflow.python.keras.engine.sequential.Sequential'>

We might go on including layers …

m$add(tf$keras$layers$Dense(32, "relu"))
m$add(tf$keras$layers$Dense(1))
m$layers
[[1]]
<tensorflow.python.keras.layers.core.Dense>

[[2]]
<tensorflow.python.keras.layers.core.Dense>

However who would wish to? If this have been the one approach, it’d be much less cumbersome to straight write Python as an alternative. Plus, as a consumer you’d must know the entire Python-side module construction (now the place do optimizers stay, at present: tf.keras.optimizers, tf.optimizers …?), and sustain with all path and title modifications within the Python API.

That is the place keras comes into play. keras is the place the TensorFlow-specific usability, re-usability, and comfort options stay.
Performance offered by keras spans the entire vary between boilerplate-avoidance over enabling elegant, R-like idioms to offering technique of superior function utilization. For example for the primary two, take into account layer_dense which, amongst others, converts its models argument to an integer, and takes arguments in an order that permit it to be “pipe-added” to a mannequin: As a substitute of

mannequin <- keras_model_sequential()
mannequin$add(layer_dense(models = 32L))

we will simply say

mannequin <- keras_model_sequential()
mannequin %>% layer_dense(models = 32)

Whereas these are good to have, there’s extra. Superior performance in (Python) Keras largely is determined by the power to subclass objects. One instance is customized callbacks. For those who have been utilizing Python, you’d must subclass tf.keras.callbacks.Callback. From R, you may create an R6 class inheriting from KerasCallback, like so

CustomCallback <- R6::R6Class("CustomCallback",
    inherit = KerasCallback,
    public = checklist(
      on_train_begin = operate(logs) {
        # do one thing
      },
      on_train_end = operate(logs) {
        # do one thing
      }
    )
  )

It is because keras defines an precise Python class, RCallback, and maps your R6 class’ strategies to it.
One other instance is customized fashions, launched on this weblog a few 12 months in the past.
These fashions will be educated with customized coaching loops. In R, you utilize keras_model_custom to create one, for instance, like this:

m <- keras_model_custom(title = "mymodel", operate(self) {
  self$dense1 <- layer_dense(models = 32, activation = "relu")
  self$dense2 <- layer_dense(models = 10, activation = "softmax")
  
  operate(inputs, masks = NULL) {
    self$dense1(inputs) %>%
      self$dense2()
  }
})

Right here, keras will make certain an precise Python object is created which subclasses tf.keras.Mannequin and when known as, runs the above nameless operate().

In order that’s keras. What concerning the tensorflow package deal? As a consumer you solely want it when you need to do superior stuff, like configure TensorFlow machine utilization or (in TF 1.x) entry components of the Graph or the Session. Internally, it’s utilized by keras closely. Important inner performance consists of, e.g., implementations of S3 strategies, like print, [ or +, on Tensors, so you can operate on them like on R vectors.

Now that we know what each of the packages is “for”, let’s dig deeper into what makes this possible.

Show me the magic: reticulate

Instead of exposing the topic top-down, we follow a by-example approach, building up complexity as we go. We’ll have three scenarios.

First, we assume we already have a Python object (that has been constructed in whatever way) and need to convert that to R. Then, we’ll investigate how we can create a Python object, calling its constructor. Finally, we go the other way round: We ask how we can pass an R function to Python for later usage.

Scenario 1: R-to-Python conversion

Let’s assume we have created a Python object in the global namespace, like this:

So: There is a variable, called x, with value 1, living in Python world. Now how do we bring this thing into R?

We know the main entry point to conversion is py_to_r, defined as a generic in conversion.R:

py_to_r <- function(x) {
  ensure_python_initialized()
  UseMethod("py_to_r")
}

… with the default implementation calling a function named py_ref_to_r:

Rcpp : You simply write your C++ operate, and Rcpp takes care of compilation and gives the glue code essential to name this operate from R.

So py_ref_to_r actually is written in C++:

.Name(`_reticulate_py_ref_to_r`, x)
}

which lastly wraps the “actual” factor, the C++ operate py_ref_to_R we noticed above.

By way of py_ref_to_r_with_convert in #1, a one-liner that extracts an object’s “convert” function (see under)

Extending Python Information.

In official phrases, what reticulate does it embed and prolong Python.
Embed, as a result of it enables you to use Python from inside R. Prolong, as a result of to allow Python to name again into R it must wrap R capabilities in C, so Python can perceive them.

As a part of the previous, the specified Python is loaded (Py_Initialize()); as a part of the latter, two capabilities are outlined in a brand new module named rpycall, that might be loaded when Python itself is loaded.

World Interpreter Lock, this isn’t routinely the case when different implementations are used, or C is used straight. So call_python_function_on_main_thread makes positive that until we will execute on the principle thread, we wait.

That’s it for our three “spotlights on reticulate”.

Wrapup

It goes with out saying that there’s loads about reticulate we didn’t cowl on this article, comparable to reminiscence administration, initialization, or specifics of knowledge conversion. Nonetheless, we hope we have been in a position to shed a bit of sunshine on the magic concerned in calling TensorFlow from R.

R is a concise and stylish language, however to a excessive diploma its energy comes from its packages, together with those who mean you can name into, and work together with, the surface world, comparable to deep studying frameworks or distributed processing engines. On this put up, it was a particular pleasure to deal with a central constructing block that makes a lot of this doable: reticulate.

Thanks for studying!