Recently, I took part in the Huggingface x Google Cloud community sprint which (despite being named a ControlNet sprint) had a very broad scope: involve diffusion models, use JAX, and use TPUs provided for free by Google Cloud. A lot of cool projects came out of it in a relatively short span of time.

Our project was quite ambitious: to take my master’s dissertation work on combining step-unrolled denoising autoencoders (loosely adjacent to discrete diffusion models) with VQ-GAN, porting it all to JAX, then adding support for text-conditioned generation. With this new model, we would train a new text-to-image model from scratch, à la Dalle-mini.

Interestingly, Dalle-mini was born out of a previous Huggingface community sprint. A lot of nice projects can come out of these community initiatives!

Unconditional results from my original paper

Unconditional results from my original paper.

Unfortunately we didn’t manage to achieve our final goal, plagued by a subtle bug somewhere in the code. We never got much out of the model apart from pretty colours. I wish I could show some fun outputs, but we simply ran out of time, despite the team’s best efforts. You can find the JAX code for our project here. Despite disappointing results, I am still happy I took part as I learned a huge amount.

Really “great” samples

Really “great” samples from our community sprint model.

In preparation for the community sprint, I jumped into JAX by following an excellent tutorial series by Aleksa Gordic. Aleksa prefaces the video with the fact that he is also just learning JAX. No doubt he is even better now, but I still felt quite inspired by this attitude: sharing and teaching as you yourself learn. Hence, I decided that following the sprint I would channel this spirit and share what I know after just under two months of learning JAX. And hence, here we are.

Although it is possible to implement everything in JAX alone – including manually implementing the optimiser and model – this isn’t really an approach I enjoy. During the sprint, we made heavy use of libraries built on top of JAX such as Flax and Optax. It is definitely valuable to try doing everything yourself, but if you just want to get started it is similarly worth just leaning into higher-level frameworks, and I feel plenty of existing tutorials already cover working from scratch.

Saying that, in this specific blog I will only be covering JAX itself – leaving creating a fully-fledged training loop with higher-level libraries to later entries. I initially tried covering everything in one unit but the length got far too much to handle. Even now, covering only JAX, the post is very long. I would call it somewhere between a deep dive and an introduction to JAX. I’ve skipped over parts of the framework whilst also drilling deep into concepts I feel are important to understand.

To understand this post you should have some experience with Python and array manipulation libraries such as NumPy – machine learning experience helps but isn’t necessary. I hope it can be a good entry point into the JAX ecosystem as well as providing some unique perspectives that may be interesting to those with more experience.

If you are curious about implementing everything from scratch, I would take a look at aforementioned tutorial by Aleksa Gordic, or the official tutorials here.

Without further ado..

Basic Usage is Almost Like NumPy

JAX is a framework developed by Google and later open-sourced for high-performance machine learning research and numerical computing. Some people say the name comes from three of its core components, namely the bringing together of Just-in-time compilation, Autodiff, and XLA. The original paper on JAX says it stands for “Just After eXecution. When I share this piece of trivia, no one seems that bothered.

A big draw to JAX is that it shares a similar API to NumPy but can be executed on fast accelerators such as GPUs and TPUs whilst having accelerator agnostic code. The familiar API also helps get engineers up to speed with JAX – or at least gets them through the door. Furthermore, it has very good inbuilt support for multi-device parallelism compared to other frameworks that could be used for machine learning such as PyTorch and Tensorflow.

Although definitely intended to support machine learning research, to me it appears to have a weaker bias towards machine learning and is more readily applied to other domains. This is somewhat akin to NumPy which is a general purpose array manipulation library, being that it is general enough to do anything. However, I believe the way you should use JAX is very different to NumPy, despite initial appearances.

Specifically, if NumPy is about manipulating arrays operation by operation, JAX is about defining computational graphs of operations and inputs, and letting the compiler optimise it. In other words, defining what you want to happen and letting JAX do the heavy lifting in making it run fast. In NumPy, the burden is on the developer to optimise everything by calling into fast and heavily optimised functions and avoiding slow Python land as much as possible. This extra burden does garner a degree of flexibility over rigid JAX. In a lot of machine learning applications, though, we don’t need such flexibility.

Enough ideological rants, let’s see that friendly JAX Numpy API, beginning by initialising a few arrays.

import jax
import jax.numpy as jnp

import numpy as np

L = [0, 1, 2, 3]
x_np = np.array(L, dtype=np.int32)
x_jnp = jnp.array(L, dtype=jnp.int32)

x_np, x_jnp
===
Out: (Array([0, 1, 2, 3], dtype=int32), array([0, 1, 2, 3], dtype=int32))

Note, you may see in older tutorials the line import jax.numpy as np. This is no longer the convention and prior suggestions to do so will remain a stain on human history.

Frighteningly similar right? The jax.numpy interface closely mirrors that of numpy, which means nearly anything we could do numpy we can do in jax.numpy using similar functions.

x1 = x_jnp*2
x2 = x_jnp+1
x3 = x1 + x2

x1, x2, x3
===
Out: (Array([0, 2, 4, 6], dtype=int32),
 Array([1, 2, 3, 4], dtype=int32),
 Array([ 1,  4,  7, 10], dtype=int32))

jnp.dot(x1, x2), jnp.outer(x1, x2)
===
Out: (Array(40, dtype=int32),
 Array([[ 0,  0,  0,  0],
        [ 2,  4,  6,  8],
        [ 4,  8, 12, 16],
        [ 6, 12, 18, 24]], dtype=int32))

All of this should look familiar to you if you have used NumPy before. I won’t bore you to death by enumerating functions – that’s what documentation is for.

The first interesting difference is how JAX handles randomness. In NumPy, to generate a random array from the uniform distribution, we can simply do:

random_np = np.random.random((5,))
random_np
===
Out: array([0.58337985, 0.87832186, 0.08315021, 0.16689551, 0.50940328])

In JAX it works differently. A key concept in JAX is that functions in it are pure. This means that given the same input they will always return the same output, and do not modify any global state from within the function. Using random number generation that modifies some global psuedorandom number generator (PRNG) clearly violates both principles. Therefore, we have to handle randomness in a stateless way by manually passing around the PRNG key and splitting it to create new random seeds. This has the added benefit of making randomness in code more reproducible – ignoring accelerator-side stochasticity – as in JAX we are forced to handle fixed seeds by default. Let’s see what that looks like:

seed = 0x123456789 # some integer seed. In hexadecimal just to be ✨✨
key = jax.random.PRNGKey(seed) # create the initial key
key, subkey = jax.random.split(key) # split the key
random_jnp = jax.random.uniform(subkey, (5,)) # use `subkey` to generate, `key` can be split into more subkeys later.
random_jnp
===
Out: Array([0.2918682 , 0.90834665, 0.13555491, 0.08107758, 0.9746183 ], dtype=float32)

It is important to not reuse the same key if you want each random op to produce different outputs:

jax.random.normal(key, (2,)), jax.random.normal(key, (2,))
===
Out: (Array([-0.67039955,  0.02259737], dtype=float32),
 Array([-0.67039955,  0.02259737], dtype=float32))

You may be pleased to know that if we want to generate N random arrays, we don’t need to call jax.random.split in a loop N times. Pass the number of keys you want to the function:

key, *subkeys = jax.random.split(key, 5)
[jax.random.normal(s, (2,2)) for s in subkeys]
===
Out: [Array([[ 1.0308125 , -0.07533383],
        [-0.36027843, -1.270425  ]], dtype=float32),
 Array([[ 0.34779412, -0.11094793],
        [ 1.0509511 ,  0.52164143]], dtype=float32),
 Array([[ 1.5565109 , -0.9507161 ],
        [ 1.4706124 ,  0.25808835]], dtype=float32),
 Array([[-0.5725152 , -1.1480215 ],
        [-0.6206856 , -0.12488112]], dtype=float32)]

Another small difference is that JAX does not permit in-place operations:

x1[0] = 5
===
Out: 
TypeError                                 Traceback (most recent call last)

<ipython-input-25-e0318c4eb619> in <cell line: 1>()
----> 1 x1[0] = 5

/usr/local/lib/python3.10/dist-packages/jax/_src/numpy/array_methods.py in _unimplemented_setitem(self, i, x)
    261          "or another .at[] method: "
    262          "https://jax.readthedocs.io/en/latest/_autosummary/jax.numpy.ndarray.at.html")
--> 263   raise TypeError(msg.format(type(self)))
    264 
    265 def _operator_round(number: ArrayLike, ndigits: Optional[int] = None) -> Array:

TypeError: '<class 'jaxlib.xla_extension.ArrayImpl'>' object does not support item assignment. JAX arrays are immutable. Instead of ``x[idx] = y``, use ``x = x.at[idx].set(y)`` or another .at[] method: https://jax.readthedocs.io/en/latest/_autosummary/jax.numpy.ndarray.at.html

Like the error message says, JAX arrays are immutable, hence the same issue applies to other inplace ops like +=, *= and friends. Also like the error message says, we can use the at property on JAX arrays to perform functionally pure equivalents. This return new arrays, but setting them equal to the old variable is numerically equivalent to the true in-place version.

x1_p999 = x1.at[0].add(999)
x1, x1_p999
===
Out: (Array([0, 2, 4, 6], dtype=int32), Array([999,   2,   4,   6], dtype=int32))

Applying x1 += 5 and similar does work, but under the Python hood this is just x1 = x1 + 5 anyway. It just creates a new array and hence is still immutable.

JAX functions also only accept NumPy or JAX array inputs. This is in contrast to NumPy that will happily accept Python lists. JAX chooses to throw an error to avoid silent degradation in performance.

One final difference is that out of bounds indexing does not raise an error. This is because raising an error from code running on an accelerator is difficult and our goal with “accelerated NumPy” is to use accelerators. This is similar to how invalid floating point arithmetic results in NaN values, rather than simply erroring.

When indexing to retrieve a value out of bounds, JAX will instead just clamp the index to the bounds of the array:

x1[0], x1[-1], x1[10000]
===
Out: (Array(0, dtype=int32), Array(6, dtype=int32), Array(6, dtype=int32))

When indexing to update a value out of bounds (such as by using the .at attribute) the update is simply ignored:

x1 = x1.at[10000].set(999)
x1
===
Out: Array([0, 2, 4, 6], dtype=int32)

All somewhat interesting, but so far there isn’t a great deal of pull towards JAX over NumPy. It gets more concerning when we start timing the functions:

x1_np, x2_np = np.asarray(x1), np.asarray(x2)
%timeit x1_np @ x2_np
%timeit (x1 @ x2).block_until_ready()
===
Out: 1.17 µs ± 6.3 ns per loop (mean ± std. dev. of 7 runs, 1000000 loops each)
7.27 µs ± 1.68 µs per loop (mean ± std. dev. of 7 runs, 100000 loops each)

The JAX version of the above multiplication is about 6-7 times slower, what gives?

The block_until_ready function is needed for benchmarking. Normally, JAX does not wait for the operation to complete before returning control to Python. It asynchronously dispatches to the accelerator. Hence, the time to return may be faster than the actual computation time, resulting in an inaccurate benchmark.

It goes back to the point that NumPy is intended for array manipulation in an op-by-op (or eager) fashion, whereas JAX is all about defining graphs and letting the compiler optimise it for you. By executing JAX functions eagerly like NumPy, we leave no room for optimisation and due to extra JAX overhead dispatching operations, we get a slower function. Bluntly, if you are using JAX like this, you have done something wrong.

So, how do we get JAX to go fast? By harnessing the power of XLA.

Enter jax.jit

The reason why the earlier function was so slow is that JAX is dispatching to the accelerator one operation at a time. The intended way to use JAX is to compile multiple operations – ideally nearly all operations – together using XLA. To indicate which region to compile together, we can pass the function we want to compile to the function jax.jit or use the @jax.jit decorator. The function will not be compiled immediately, but rather upon first call – hence the name “just-in-time compilation”.

During this first call, the shapes of the input arrays will be used to trace out a computational graph, stepping through the function with the Python interpreter and executing the operations one-by-one, recording in the graph what happens. This intermediate representation can be given to XLA and subsequently compiled, optimised, and cached. This cache will be retrieved if the same function is called with the same input array shapes and dtype, skipping the tracing and compilation process and calling the heavily optimised, precompiled binary blob directly.

Let’s see it in action:

def fn(W, b, x):
    return x @ W + b

key, w_key, b_key, x_key = jax.random.split(key, 4)
W = jax.random.normal(w_key, (4, 2)),
b = jax.random.uniform(b_key, (2,))
x = jax.random.normal(x_key, (4,))

print("`fn` time")
%timeit fn(W, b, x).block_until_ready()

print("`jax.jit(fn)` first call time")
jit_fn = jax.jit(fn)
%time jit_fn(W, b, x).block_until_ready()

print("`jit_fn` time")
%timeit jit_fn(W, b, x).block_until_ready()
===
Out: 
`fn` time
26.1 µs ± 1.56 µs per loop (mean ± std. dev. of 7 runs, 10000 loops each)

`jit_fn` first call (warmup) time
CPU times: user 35.8 ms, sys: 38 µs, total: 35.9 ms
Wall time: 36.3 ms

`jit_fn` time
7.62 µs ± 1.88 µs per loop (mean ± std. dev. of 7 runs, 100000 loops each)

Like expected, the first call will take much longer than the subsequent calls. It is important to exclude the first call from any benchmarking for this reason. We also see that even for this simple example the compiled version of the function executes far quicker than the original function.

We can view the traced graph as a jaxpr by calling jax.make_jaxpr on the function:

jax.make_jaxpr(fn)(params, x)
===
Out: { lambda ; a:f32[4,2] b:f32[2] c:f32[4]. let
    d:f32[2] = dot_general[dimension_numbers=(([0], [0]), ([], []))] c a
    e:f32[2] = add d b
  in (e,) }

And also the compiled version of the function, albeit hard to read:

print(jax.jit(fn).lower(params, x).compile().as_text())
===
HloModule jit_fn, entry_computation_layout={(f32[4,2]{1,0},f32[2]{0},f32[4]{0})->f32[2]{0}}, allow_spmd_sharding_propagation_to_output={true}

%fused_computation (param_0.1: f32[2], param_1.1: f32[4], param_2: f32[4,2]) -> f32[2] {
  %param_1.1 = f32[4]{0} parameter(1)
  %param_2 = f32[4,2]{1,0} parameter(2)
  %dot.0 = f32[2]{0} dot(f32[4]{0} %param_1.1, f32[4,2]{1,0} %param_2), lhs_contracting_dims={0}, rhs_contracting_dims={0}, metadata={op_name="jit(fn)/jit(main)/dot_general[dimension_numbers=(((0,), (0,)), ((), ())) precision=None preferred_element_type=None]" source_file="<ipython-input-4-04cd19da0726>" source_line=2}
  %param_0.1 = f32[2]{0} parameter(0)
  ROOT %add.0 = f32[2]{0} add(f32[2]{0} %dot.0, f32[2]{0} %param_0.1), metadata={op_name="jit(fn)/jit(main)/add" source_file="<ipython-input-4-04cd19da0726>" source_line=2}
}

ENTRY %main.6 (Arg_0.1: f32[4,2], Arg_1.2: f32[2], Arg_2.3: f32[4]) -> f32[2] {
  %Arg_1.2 = f32[2]{0} parameter(1), sharding={replicated}
  %Arg_2.3 = f32[4]{0} parameter(2), sharding={replicated}
  %Arg_0.1 = f32[4,2]{1,0} parameter(0), sharding={replicated}
  ROOT %fusion = f32[2]{0} fusion(f32[2]{0} %Arg_1.2, f32[4]{0} %Arg_2.3, f32[4,2]{1,0} %Arg_0.1), kind=kOutput, calls=%fused_computation, metadata={op_name="jit(fn)/jit(main)/add" source_file="<ipython-input-4-04cd19da0726>" source_line=2}
}

A more explicit and silly example is below:

def stupid_fn(x):
  y = jnp.copy(x)
  for _ in range(1000):
    x = x * x
  return y

print("`stupid_fn` time")
%time stupid_fn(x).block_until_ready()

print("`jit_stupid_fn` first call")
jit_stupid_fn = jax.jit(stupid_fn)
%time jit_stupid_fn(x).block_until_ready()

print("`jit_stupid_fn` time")
%timeit jit_stupid_fn(x).block_until_ready()
===
Out: 
`stupid_fn` time
CPU times: user 58.6 ms, sys: 1.06 ms, total: 59.7 ms
Wall time: 81.9 ms
`jit_stupid_fn` first call
CPU times: user 666 ms, sys: 13.9 ms, total: 680 ms
Wall time: 800 ms
`jit_stupid_fn` time
8.72 µs ± 735 ns per loop (mean ± std. dev. of 7 runs, 100000 loops each)

In the function, it copies the input x to the variable y, then multiplies the input with itself 1,000 times. Finally, it simply returns y, making the multiplications totally pointless. In the non-jit version, the program will happily and pointlessly perform the multiplications. Ignorance is bliss.

On first call to the jit function, again JAX will step through all the multiplications as it traces out the computational graph. However, the compiled version used on subsequent calls will be blazing fast, as XLA sees the multiplications are not needed to obtain the final output and optimises them out. We can actually see this by printing the jaxpr:

jax.make_jaxpr(stupid_fn)(x)
===
Out: { lambda ; a:f32[4]. let
    b:f32[4] = copy a
    c:f32[4] = mul a a
    d:f32[4] = mul c c
    e:f32[4] = mul d d
    f:f32[4] = mul e e
    ... <truncated>
    bmh:f32[4] = mul bmg bmg
    bmi:f32[4] = mul bmh bmh
    bmj:f32[4] = mul bmi bmi
    bmk:f32[4] = mul bmj bmj
    bml:f32[4] = mul bmk bmk
    bmm:f32[4] = mul bml bml
    _:f32[4] = mul bmm bmm
  in (b,) }

Which shows all 1,000 multiplications (trust me!). Compare with the compiled version:

print(jax.jit(stupid_fn).lower(x).compile().as_text())
===
Out: 
HloModule jit_stupid_fn, entry_computation_layout={(f32[4]{0})->f32[4]{0}}, allow_spmd_sharding_propagation_to_output={true}

ENTRY %main.2 (Arg_0.1: f32[4]) -> f32[4] {
  %Arg_0.1 = f32[4]{0} parameter(0), sharding={replicated}
  ROOT %copy = f32[4]{0} copy(f32[4]{0} %Arg_0.1)
}

Which contains only a single copy operation. Experiment with the above code blocks yourself by changing the number of iterations in the loop. You will find that the time to execute the original function will increase with number of iterations, along with the time to trace the graph on first call to the jit function. However, the time to execute the compiled version on subsequent calls will not increase in a meaningful way.

The above is a contrived example, but demonstrates a critical point: we can let XLA do a lot of the heavy lifting for us optimisation-wise. This is different to other frameworks that execute eagerly, where it would happily execute extremely pointless code. This isn’t a fault of the framework as eager execution has many benefits, but demonstrates the point that compiling our functions using XLA can help optimise our code in ways we didn’t know about, or could reasonably anticipate.

What exact optimisations XLA applies is a topic outside the scope of this blog. One quick example is that the earlier statement about JAX arrays not allowing in-place operations results in no potential performance loss. This is because XLA can identify cases where it can replace operations with in-place equivalents. So basically don’t sweat it if you were worried earlier about not being able to do operations in-place!

Secondly, in order to let XLA be the best it can be, jax.jit should be used in the widest possible context. For example, (again contrived) if we had only jit compiled the multiplications in stupid_fn, XLA would be unaware that the outermost loop was unnecessary and could not optimise it out – it is simply outside the region to be compiled. A concrete machine learning example would be wrapping the entire training step – forward, backwards and optimiser step – in jax.jit for maximum effect.

Most machine learning applications can be expressed in this way: one monolithic compiled function that we throw data and model parameters at. It just might take some massaging. In the original JAX paper, they say “The design of JAX is informed by the observation that ML workloads are typically dominated by PSC (pure-and-statically-composed) subroutines” which lends itself well to this compilation process. Even functions that seemingly cannot have static input shapes can be converted into a static form, for example padding sequences in language modeling tasks or rewriting our functions in clever ways.

Although eager mode execution is useful for development work, once development is done there is less benefit to eager execution over heavily optimised binary blobs, hungry for our data. However, said compilation and optimisations rely on following the rules of JAX.

JIT needs static shapes

The biggest blocker to jit compiling functions is that all arrays need to have static shapes. That is to say, given the shapes and shapes alone of the function inputs, it should be possible to determine the shape of all other variables in the traced graph at compile time.

Take for example the following function, that given an integer length returns an array filled with the value val:

def create_filled(val, length):
  return jnp.full((length,), val)

print(create_filled(1.0, 5))
print(create_filled(2, 2))

jit_create_filled = jax.jit(create_filled)
jit_create_filled(2, 5)
===
Out: [1. 1. 1. 1. 1.]
[2 2]

---------------------------------------------------------------------------

TypeError                                 Traceback (most recent call last)

<ipython-input-13-0ecd13642388> in <cell line: 8>()
      6 
      7 jit_create_filled = jax.jit(create_filled)
----> 8 jit_create_filled(2, 5)

    [... skipping hidden 12 frame]

3 frames

/usr/local/lib/python3.10/dist-packages/jax/_src/core.py in canonicalize_shape(shape, context)
   2037   except TypeError:
   2038     pass
-> 2039   raise _invalid_shape_error(shape, context)
   2040 
   2041 def canonicalize_dim(d: DimSize, context: str="") -> DimSize:

TypeError: Shapes must be 1D sequences of concrete values of integer type, got (Traced<ShapedArray(int32[], weak_type=True)>with<DynamicJAXprTrace(level=1/0)>,).
If using `jit`, try using `static_argnums` or applying `jit` to smaller subfunctions.
The error occurred while tracing the function create_filled at <ipython-input-13-0ecd13642388>:1 for jit. This concrete value was not available in Python because it depends on the value of the argument length.

In eager execution, the function returns what we expect. However, when tracing the jit version of the function an error appears. This is because when tracing, the jnp.full function will receive a tracer array which only contains information about the shape and dtype – not the value which is used to determine the shape. It is therefore impossible to trace the output array as the shape is not known at compile time.

We can resolve this by using an argument to jax.jit named static_argnums. This specifies which arguments to not trace, simply treating it as a regular Python value at compile time. In the jaxpr graph, the length argument to our Python-level function essentially becomes a constant in the graph:

jit_create_filled = jax.jit(create_filled, static_argnums=(1,))
print(jit_create_filled(2, 5))
print(jit_create_filled(1., 10))

print(jax.make_jaxpr(create_filled, static_argnums=(1,))(2, 5))
print(jax.make_jaxpr(create_filled, static_argnums=(1,))(1.6, 10))
===
Out: [2 2 2 2 2]
[1. 1. 1. 1. 1. 1. 1. 1. 1. 1.]

{ lambda ; a:i32[]. let
    b:i32[5] = broadcast_in_dim[broadcast_dimensions=() shape=(5,)] a
  in (b,) }
{ lambda ; a:f32[]. let
    b:f32[10] = broadcast_in_dim[broadcast_dimensions=() shape=(10,)] a
  in (b,) }

As the shape is a constant in the graph now, each time a different length is passed to the function it will be recompiled. Hence, this approach only really works if the number of possible values for length is very limited, otherwise we will be constantly compiling different graphs.

Make no mistake, even though the Python-level function is identical, the underlying binaries that are called for different static inputs are completely different. We’ve basically turned the caching from matching on function and input shapes, to matching on function, input shapes, and also the value of our static arguments.

A different example now: let’s define a function that takes in an input array x and boolean mask mask with the same shape as x and returns a new array with masked positions set to a large negative number.

def mask_tensor(x, mask):
  x = x.at[mask].set(-100.)
  return x

key, x_key, mask_key = jax.random.split(key, 3)
x = jax.random.normal(x_key, (4,4))
mask = jax.random.uniform(mask_key, (4,4)) < 0.5

print("calling eager function")
print(mask_tensor(x, mask))

print("calling compiled function")
jit_mask_tensor = jax.jit(mask_tensor)
jit_mask_tensor(x, mask)
===
Out: calling eager function
[[-3.8728207e-01 -1.3147168e+00 -2.2046556e+00  4.1792620e-02]
 [-1.0000000e+02 -1.0000000e+02 -8.2206033e-02 -1.0000000e+02]
 [ 2.1814612e-01  9.6735013e-01  1.3497342e+00 -1.0000000e+02]
 [-8.7061942e-01 -1.0000000e+02 -1.0000000e+02 -1.0000000e+02]]
calling compiled function

---------------------------------------------------------------------------

NonConcreteBooleanIndexError              Traceback (most recent call last)

<ipython-input-23-2daf7923c05b> in <cell line: 14>()
     12 print("calling compiled function")
     13 jit_mask_tensor = jax.jit(mask_tensor)
---> 14 jit_mask_tensor(x, mask)

    [... skipping hidden 12 frame]

5 frames

/usr/local/lib/python3.10/dist-packages/jax/_src/numpy/lax_numpy.py in _expand_bool_indices(idx, shape)
   4297       if not type(abstract_i) is ConcreteArray:
   4298         # TODO(mattjj): improve this error by tracking _why_ the indices are not concrete
-> 4299         raise errors.NonConcreteBooleanIndexError(abstract_i)
   4300       elif _ndim(i) == 0:
   4301         raise TypeError("JAX arrays do not support boolean scalar indices")

NonConcreteBooleanIndexError: Array boolean indices must be concrete; got ShapedArray(bool[4,4])

Executing the function in eager mode works as expected. However, the shape of intermediate variables cannot be known given knowledge of the input shapes alone, as it depends on the number of elements in mask that are True. Therefore, we cannot compile the function as not all shapes are static.

Additionally, we can’t use static_argnum as mask itself is not hashable and hence can’t be used to match calls to cached binaries. Furthermore, even if we could, the number of possible values of mask is too high. To handle all possibiltiies, we would need to compile 2**16 or 65,536 graphs.

Often though, we can rewrite the function to perform the same action and with known shapes at all steps:

def mask_tensor(x, mask):
  x = ~mask * x - mask*100.
  return x

print("calling eager function")
print(mask_tensor(x, mask))

print("calling compiled function")
jit_mask_tensor = jax.jit(mask_tensor)
print(jit_mask_tensor(x, mask))
===
calling eager function
[[   1.012518   -100.           -0.8887863  -100.        ]
 [-100.         -100.         -100.            1.5008001 ]
 [-100.           -0.6636745     0.57624763   -0.94975847]
 [   1.1513114  -100.            0.88873196 -100.        ]]
calling compiled function
[[   1.012518   -100.           -0.8887863  -100.        ]
 [-100.         -100.         -100.            1.5008001 ]
 [-100.           -0.6636745     0.57624763   -0.94975847]
 [   1.1513114  -100.            0.88873196 -100.        ]]

All intermediate shapes will be known at compile time. To break it down, we multiply x by zero where mask is True, and by one where it is False. We then add a new array that is zero where mask is False and -100 where mask is True. At this point we have two arrays with concrete shapes. Adding them together yields the correct result, which is similarly concrete.

Limit the number of possible input shapes

A related case that can “kinda” be jit compiled is where shapes can be determined at compile time but the shapes of the inputs change a lot. As we retrieve cached compiled functions by looking at which function was called and the shape of the inputs, this will result in a lot of compiling. This makes sense, as the graph itself is optimised for a specific static shape, but will result in silent slowdowns:

import random

def cube(x):
  return x*x*x

def random_shape_test(fn):
  length = random.randint(1, 1000)
  return fn(jnp.empty((length,)))

print("random length eager time:")
%timeit -n1000 random_shape_test(cube).block_until_ready()

jit_cube = jax.jit(cube)
jit_cube(x1)

print("fixed length compiled time:")
%timeit -n1000 jit_cube(x1).block_until_ready()

print("random length compiled time:")
%timeit -n1000 random_shape_test(jit_cube).block_until_ready()
===
Out:
random length eager time:
The slowest run took 43.13 times longer than the fastest. This could mean that an intermediate result is being cached.
6.12 ms ± 8.37 ms per loop (mean ± std. dev. of 7 runs, 1000 loops each)

fixed length compiled time:
7.31 µs ± 241 ns per loop (mean ± std. dev. of 7 runs, 1000 loops each)

random length compiled time:
The slowest run took 53.37 times longer than the fastest. This could mean that an intermediate result is being cached.
4.55 ms ± 6.11 ms per loop (mean ± std. dev. of 7 runs, 1000 loops each)

Therefore, we should try our best to limit the number of shapes that our jitted functions will take as input. Common examples include padding sequences to a single length, or setting drop_last=True on data loaders to avoid different numbers of examples in a batch.

Functional Purity and Side Effects

JAX transformations and compilation are designed to only work on pure Python functions. Roughly speaking, a functionally pure function is one where given the same inputs, it will always produce the same outputs, and does not have any observable side effects.

For example, see this example where the output of fn relies not only on x but also on shift, which we change between function calls:

shift = -1.0
x1 = jnp.array([0, 1, 2])
x2 = jnp.array([0, -1, 0])
x3 = jnp.array([0, 1, 2, 3])
def fn(x):
  return x + shift

print(fn(x1))

shift = 1.0
print(fn(x2))
print(fn(x3))

shift = -1.0
jit_fn = jax.jit(fn)

print(jit_fn(x1))

shift = 1.0
print(jit_fn(x2))

print(jit_fn(x3))
===
Out:
[-1.  0.  1.]
[1. 0. 1.]
[1. 2. 3. 4.]

[-1.  0.  1.]
[-1. -2. -1.]
[1. 2. 3. 4.]

The eager mode calls (the first three) represent our ground truth, the last three are outputs of the jit function using the same inputs and global shift value. In the jit function, the first call of a given shape (when we trace) will use the correct current global shift value. This is because tracing utilises the Python interpreter and so can see the correct global value.

If we call again and JAX finds a cached function, it won’t look at the new global shift but instead execute the compiled code directly, which has the old value baked into the graph as a constant. However, if tracing is triggered again (such as with a different input shape) the correct shift will be used.

This is what is meant by “JAX transformations and compilation are designed to only work on pure functions”. They can still be applied to the impure, but the behaviour of the function will diverge from the Python interpreter when tracing is skipped and the compiled function is used directly. Another example is about functions that use print functions:

def fn(x):
  print("called identity function")
  return x

jit_fn = jax.jit(fn)

print("called `jit_fn(0.5)`")
_ = jit_fn(0.5)
print("called `jit_fn(1.0)`")
_ = jit_fn(1.0)
print("called `jit_fn([-1, 1])`")
_ = jit_fn(jnp.array([-1, 1]))
===
Out:
called `jit_fn(0.5)`
called identity function

called `jit_fn(1.0)`

called `jit_fn([-1, 1])`
called identity function

Again, whenever tracing is triggered, the behaviour is the same as Python, but whenever the cached function is used, behaviour diverges. This is again impure as print is a side effect.

What about when the global we are using is also a JAX array?

b = jnp.array([1,2,3])

def fn(x):
  return x + b

jit_fn = jax.jit(fn)

x = jnp.array([1,2,3])
print(jit_fn(x))

b = jnp.array([0,0,0])
print(jit_fn(x))
===
[2 4 6]
[2 4 6]

Again, as the input shape of x hasn’t changed, the compiled version will be used, hence the value of b in the function won’t be updated. However, b is actually a variable in the graph, unlike our previous example modifying shift where it is a constant in the graph. JAX maintains functional purity in the compiled function by adding b as an implicit argument in the traced graph. Hence, the graph is functionally pure, however b is essentially a constant for us as we have no way of modifying this implicit argument at a Python-level without recompiling.

Generally speaking, the final compiled function is pure. However, the Python-level function we created isn’t necessarily pure. Despite this, jax.jit can still be applied but requires care. I would summarise the caveats as follows though:

  • Code that does not manipulate JAX arrays will not be traced and is only called during tracing itself (as the Python interpreter steps through the function, and evaluates the code like any other Python code). Examples of this include print statements and setting Python level variables, as well as Python-level conditionals and loops.
  • Code that does manipulate JAX arrays but the JAX array is not an argument to the Python function (perhaps it is global, relative to the function) we are jit compiling will be traced, but those variables in the graph will take whatever value they had at compile-time and become implicit arguments to the traced graph.

I feel both of these impure cases still have value. For example, the first is nice when debugging shape issues (such as debugging shape mismatches during tracing) or perhaps disabling parts of the function using some global configuration object:

config = dict(relu=False)

@jax.jit
def fn(W, x):
    y = x @ W
    if config['relu']:
        y = jax.nn.relu(y)
    return y

W, x = jnp.ones((2,2)), jnp.ones((2,))
jax.make_jaxpr(fn)(W, x)
===
Out:
{ lambda ; a:f32[2,2] b:f32[2]. let
    c:f32[2] = pjit[
      jaxpr={ lambda ; d:f32[2,2] e:f32[2]. let
          f:f32[2] = dot_general[dimension_numbers=(([0], [0]), ([], []))] e d
        in (f,) }
      name=fn
    ] a b
  in (c,) }

You can see in the jaxpr that only the dot_general is present in the graph. The relu function was not traced as the Python interpreter didn’t execute the body of the if statement, and hence didn’t add it to the graph. It is important to emphasise that only a single conditional branch was compiled: there is no branching in the final graph.

Arguably, there is a case for using static_argnums if you expect to use both options in a single execution of your program. However if your config object won’t change, I feel the above pattern is fine!

It is possible to add conditionals in the compiled function. However, Python-level conditionals are only used when tracing. The branch that is traversed will be unrolled in the traced graph. Special functions (shown later) must be used to add conditionals in the final compiled function.

The second point can be useful if we have some object we know won’t change, for example a pretrained machine learning model that we just want to run fast inference on:

bert = ... # some pretrained JAX BERT model that we can call

@jax.jit
def fn(x):
  return bert(x)

The above would work, but changes to bert would not be reflected in the compiled function until the shape of x changes. We could even set bert to be None following the first call and fn would still work, provided we used the same input shape.

In general, I feel the emphasis on making things functionally pure is a bit overstated in JAX. In my (perhaps misinformed) opinion, it is better to simply understand the differences between trace-time and compiled behaviour, and when they will be triggered. Python is ridiculously expressive and making use of that is part of the power of JAX, so it would be a shame to needlessly restrict that.

Conditionals and Loops in Compiled Functions

I hope now that you have developed a bit of an intuition into the difference between trace-time and compiled behaviour. But if not, here is a summary:

  • Tracing occurs when a jit compiled function encounters a set of input shapes and static argument values that it hasn’t encountered yet. In such cases, JAX relies on the Python interpreter to step through the function. All normal Python rules apply in this case. The traced graph will contain traceable operations that were encountered during this specific instance of tracing.
  • Calling the compiled version occurs when a jit compiled function is called and the set of input shapes and static argument values match one in the cache. In such cases, behaviour is simply calling the compiled function and nothing more.

This behaviour is powerful, as it allows us to define what we want to happen in expressive Python, and rely on fast, optimised code for the actual execution. However, it does come with some issues:

  • We can only trace one conditional path per combination of input shapes and static values.
  • As tracing steps through op-by-op, loops will simply be unrolled, rather than being loops in the final compiled function.

Sometimes these properties are attractive. The first can be used to simply disable branches we don’t care about – almost like compile time flags in C. The second is useful for small numbers of loop iterations where cross-iteration dependencies can be optimised. However, sometimes this works against us.

We’ve already seen one example of this, recall stupid_fn:

def stupid_fn(x):
  y = jnp.copy(x)
  for _ in range(1000):
    x = x * x
  return y

jax.make_jaxpr(stupid_fn)(jnp.array([1.1, -1.1]))
===
Out:
Out: { lambda ; a:f32[4]. let
    b:f32[4] = copy a
    c:f32[4] = mul a a
    d:f32[4] = mul c c
    e:f32[4] = mul d d
    f:f32[4] = mul e e
    ... <truncated>
    bmh:f32[4] = mul bmg bmg
    bmi:f32[4] = mul bmh bmh
    bmj:f32[4] = mul bmi bmi
    bmk:f32[4] = mul bmj bmj
    bml:f32[4] = mul bmk bmk
    bmm:f32[4] = mul bml bml
    _:f32[4] = mul bmm bmm
  in (b,) }

The output is egregiously long. During tracing the entire loop gets unrolled. Not only is this annoying to look at, but it makes optimising the graph take a long time, making the first call to the function lengthy to complete. JAX isn’t aware we are in a for-loop context, it simply just takes the operations as they come and adds it to the graph.

Luckily, JAX exposes control flow primitives as part of its jax.lax submodule:

def less_stupid_fn(x):
    y = jnp.copy(x)
    x = jax.lax.fori_loop(start=0, stop=1000, body_fun=lambda i, x: x * x, init_val=x)
    return y

jax.make_jaxpr(less_stupid_fn)(jnp.array([1.1, -1.1]))
===
Out:
{ lambda ; a:f32[2]. let
    b:f32[2] = copy a
    _:i32[] _:f32[2] = scan[
      jaxpr={ lambda ; c:i32[] d:f32[2]. let
          e:i32[] = add c 1
          f:f32[2] = mul d d
        in (e, f) }
      length=1000
      linear=(False, False)
      num_carry=2
      num_consts=0
      reverse=False
      unroll=1
    ] 0 a
  in (b,) }

In the above example, we convert our Python for-loop into jax.lax.fori_loop. This takes arguments for the (integer) start and end of the for loop range, as well as the function to execute in the body and the starting input value. The return value of body_fun must be the same type and shape as init_val and the same type and shape across all iterations. In addition, the input to body_fun also takes the current loop index.

Taking a look at the jaxpr, we can see the massive unrolling of operations has been replaced with a much more compact version, using the scan primitive. This essentially executes the body_fun and fixed number of times, carrying state from one iteration to the next. scan compiles body_fun (like jax.jit does) and hence needs a fixed input and output shape.

If the number of loops was not static, then we would see a while loop primitive instead! There is no for-loop primitive, it is just implemented in terms of scan or while.

Let’s compiled our less stupid function less_stupid_fn and see if we get the same code out. Even with our fancy primitive functions, XLA should optimise the function in the same way.

print(jax.jit(less_stupid_fn).lower(x).compile().as_text())
===
Out:
HloModule jit_less_stupid_fn, entry_computation_layout={(f32[2]{0})->f32[2]{0}}, allow_spmd_sharding_propagation_to_output={true}

ENTRY %main.2 (Arg_0.1: f32[2]) -> f32[2] {
  %Arg_0.1 = f32[2]{0} parameter(0), sharding={replicated}
  ROOT %copy = f32[2]{0} copy(f32[2]{0} %Arg_0.1)
}

And indeed, we get a single copy operation again.

A similar function exists for while loops named jax.lax.while_loop. An equivalent to less_stupid_fn would be:

def less_stupid_fn(x):
    y = jnp.copy(x)
    x = jax.lax.while_loop(
        cond_fun=lambda ix: ix[0] < 1000, 
        body_fun=lambda ix: (ix[0]+1, ix[1]*ix[1]),
        init_val=(0, x)
    )
    return y

jax.make_jaxpr(less_stupid_fn)(jnp.array([1.1, -1.1]))
===
Out:
{ lambda ; a:f32[2]. let
    b:f32[2] = copy a
    _:i32[] _:f32[2] = while[
      body_jaxpr={ lambda ; c:i32[] d:f32[2]. let
          e:i32[] = add c 1
          f:f32[2] = mul d d
        in (e, f) }
      body_nconsts=0
      cond_jaxpr={ lambda ; g:i32[] h:f32[2]. let i:bool[] = lt g 1000 in (i,) }
      cond_nconsts=0
    ] 0 a
  in (b,) }

Where body_fun will continue to be executed so long as cond_fun returns True, carrying state between iterations and starting with state init_val.

These loops aren’t as pretty as Python-level equivalents, but they get the job done. Remember that it isn’t possible to do cross-iteration optimisation with these loop primitives as body_fun gets compiled as its own unit. The same rules apply as with jax.jit: make body_fun as large as possible to give maximum context to XLA.

If the number of loop iterations is small and constant it may be worth using Python loops instead. For example, you may use a fori_loop to wrap your whole diffusion model during inference, but a regular loop training an unrolled model for only two, fixed steps.

For conditionals in compiled functions, we have a lot of options available to us in JAX. I won’t enumerate them all here, there is a nice summary in the JAX docs here. The function closest to the behaviour of a regular if statement is jax.lax.cond:

@jax.jit
def cond_fn(x):
  pred = jnp.abs(x.max() - x.min()) <= 1.0
  return jax.lax.cond(pred, lambda x: x, lambda x: x / 2, x)

print(cond_fn(jnp.array([0.1, 0.2])))
print(cond_fn(jnp.array([-0.5, 0.5])))
print(cond_fn(jnp.array([1.0, -1.0])))
===
Out: [0.1 0.2]
[-0.5  0.5]
[ 0.5 -0.5]

jax.lax.cond takes a single boolean value, two functions and the operands to the functions. The first function will execute using operands if pred is True and the second if pred is False. In the above function, we check the absolute difference between the minimum and maximum values of x. If they are less than or equal to 1.0 the array is returned unchanged, else the array gets halved.

We can print the jaxpr and see that both branches do get traced:

jax.make_jaxpr(cond_fn)(jnp.array([1.0, -1.0]))
===
Out:
{ lambda ; a:f32[2]. let
    b:f32[2] = pjit[
      jaxpr={ lambda ; c:f32[2]. let
          d:f32[] = reduce_max[axes=(0,)] c
          e:f32[] = reduce_min[axes=(0,)] c
          f:f32[] = sub d e
          g:f32[] = abs f
          h:bool[] = le g 1.0
          i:i32[] = convert_element_type[new_dtype=int32 weak_type=False] h
          j:f32[2] = cond[
            branches=(
              { lambda ; k:f32[2]. let l:f32[2] = div k 2.0 in (l,) }
              { lambda ; m:f32[2]. let  in (m,) }
            )
            linear=(False,)
          ] i c
        in (j,) }
      name=cond_fn
    ] a
  in (b,) }

The equivalent for n branches (rather than just the implied two with jax.lax.cond) is jax.lax.switch. With this, we can implement a highly performant is_even function!

@jax.jit
def is_even_fast(x):
  return jax.lax.switch(x, [
    lambda: True,
    lambda: False,
    lambda: True,
    lambda: False,
    lambda: True,
    lambda: False,
    lambda: True,
    lambda: False,
    lambda: True,
    ... <truncated>
    lambda: False
  ])

is_even_fast(123512)
===
Out: Array(True, dtype=bool)

Do not look at the jaxpr of the above function.

Briefly, PyTrees

You may have noticed that so far, all the functions we have compiled using jax.jit only take flat structures like single arrays or values as inputs. This poses a problem if we later want to use JAX for massive machine learning problems. Are we going to write one-by-one all the parameter arrays of GPT-3?

In reality, we can use arbitrary PyTrees as inputs, intermediates, and outputs to our jit compiled functions.

The formal definition of a PyTree is “a tree-like structure built out of container-like Python objects. Classes are considered container-like if they are in the PyTree registry”. By default, the PyTree registry includes the classes list, tuple, and dict. Additionally, any object not in the registry is considered a leaf (i.e: a single element or single array). A PyTree can contain other PyTrees, forming a nested structure, and leaves.

It is possible to register your own custom classes to the PyTree registry, but this is outside the scope of this blog.

When calling a jit function, JAX will check for an existing cached compiled function with the same PyTree structure, leaf shapes, and static argument values. If all this matches, the compiled function will be reused. Like keeping the argument shapes the same as much as possible in order to use cached functions, you should aim to keep the PyTree structure the same.

Let’s have a concrete example, implementing the forward pass of a simple multi-layer perceptron. First, we will build a list of dictionaries. Each dictionary in the list represents one layer, and the dictionary stores the weights and biases for that particular layer:

dims = [784, 64, 10]

key, *subkeys = jax.random.split(key, len(dims))

params = [
    {
        'W': jax.random.normal(w_key, (out_dim, in_dim)),
        'b': jnp.zeros((out_dim,))
    }
    for w_key, in_dim, out_dim in zip(subkeys, dims[:-1], dims[1:])
]

jax.tree_util.tree_structure(params), jax.tree_util.tree_map(lambda l: str(l.shape), params)
===
Out: 
(PyTreeDef([{'W': *, 'b': *}, {'W': *, 'b': *}]),
[{'W': '(64, 784)', 'b': '(64,)'}, {'W': '(10, 64)', 'b': '(10,)'}])

The variable params fits the definition of a PyTree. The outputs of the cell are the structure of the PyTree and another PyTree showing the shapes of the leaves of params. Let’s define the forward pass as function that takes the PyTree params and an array x as its inputs, and decorate it with jax.jit:

@jax.jit
def feed_forward(params, x):
    for p in params:
        x = jax.nn.tanh(p['W'] @ x + p['b'])

    return x
    
key, x_key = jax.random.split(key)
feed_forward(params, jax.random.normal(x_key, (dims[0],)))
===
Out:
Array([-1.        , -0.93132854, -1.        , -0.99993926,  0.9998755 ,
       -0.9970358 , -0.8498685 ,  1.        , -0.9999984 ,  1.        ],      dtype=float32)

If you’ve ever printed a PyTorch model model.state_dict() before, you should be able to see how we can achieve something similar by solely using nested dictionaries. I just used a list in the above example to demonstrate how we can nest arbitrary combinations of containers, so long as they are in the PyTree registry.

In the simplest case, PyTrees are simply nice containers to help us package together inputs to our functions. They can get much more involved and complex than that, but I haven’t delved deep into the topic yet. For another time I guess.

Function Transformations

It can’t really be a JAX blog post without mentioning function transformations. One of the first things you see on the Github repository for JAX is “Dig […] deeper, and you’ll see that JAX is really an extensible system for composable function transformations”. I’ve begun tinkering with this system myself but not enough to write in depth on it, though I suspect it would mandate an entirely separate post to do it justice.

Just to give you a taste of what is possible, see this repository that lets you add LoRA to arbitrary JAX functions!

A function transformation is simply a function that takes another function as input, and returns yet another function. Hey, a function transformation transforms functions.

JAX comes with a number of inbuilt function transformations that must be mentioned. You’ve already met one in the form of jax.jit. Two others are the jax.grad and jax.value_and_grad transforms, forming the auto-differentiation component of JAX. Autodiff is an essential ingredient for training machine learning models.

In a nutshell, jax.grad takes in a function f, and returns another function that computes the derivative of f. jax.value_and_grad returns a function that in turn returns a tuple (value, grad) where value is the output of f(x) and grad is the output of jax.grad(f)(x):

def fn(x):
    return 2*x # derivative is 2 everywhere

print(fn(5.))
print(jax.grad(fn)(5.))
print(jax.value_and_grad(fn)(5.))
===
Out:
10.0
2.0
(Array(10., dtype=float32, weak_type=True), Array(2., dtype=float32, weak_type=True))

By default, the autodiff functions will take the gradient with respect to the first function argument, and hence the output of the new function jax.grad(f) will be of the same shape and structure as the first argument of f:

def dummy_loss_fn(params, x):
    y = feed_forward(params, x)
    return y.sum()

grad_loss_fn = jax.grad(dummy_loss_fn)
grads = grad_loss_fn(params, jnp.zeros(dims[0]))
jax.tree_util.tree_structure(grads)
===
Out: PyTreeDef([{'W': *, 'b': *}, {'W': *, 'b': *}])

The above is a dummy example where we package together a model forward pass and “loss” computation in a single function. We then call jax.grad on it to get gradients with respect to the model parameters. This is a common pattern in JAX training loops, usually followed by calculating the parameter updates and computing the new parameters. In a follow up post I will make on Flax, you will see this pattern crop up a lot.

We can change this default behaviour of selecting the first argument by specifying the argnums parameter to the index of the argument we want to differentiate with respect to. We can even specify multiple arguments by passing a sequence of integers.

We can even apply grad to a function that already computes the first derivative, obtaining a function that computes the second derivative:

def fn(x):
    return 2 * x**3

x = 1.0
grad_fn = jax.grad(fn)
grad_grad_fn = jax.grad(grad_fn)

print(f"d0x: {fn(x)}, d1x: {grad_fn(x)}, d2x: {grad_grad_fn(x)}")
===
Out: d0x: 2.0, d1x: 6.0, d2x: 12.0

The above behaviour is very hard to achieve in other machine learning frameworks such as PyTorch or Tensorflow. But in JAX, thanks to its emphasis on function transformations, it is trivial to achieve.

Sometimes, we want to compute the gradient of a function that also outputs auxilliary data. A common example is a loss function that also outputs other metrics like accuracy. We want to exclude this auxilliary data from gradient calculations, which can be achieved by passing has_aux=True to grad. We do this in the following example, to return both our fake “loss” and the output of feed_forward itself, whilst also computing the gradient with respect to params! A lot going on!

def dummy_loss_fn(params, x):
    y = feed_forward(params, x)
    return y.sum(), y

grad_loss_fn = jax.value_and_grad(dummy_loss_fn, has_aux=True)
values, grads = grad_loss_fn(params, jnp.zeros(dims[0]))
values, jax.tree_util.tree_structure(grads)
===
Out:
((Array(0., dtype=float32),
  Array([0., 0., 0., 0., 0., 0., 0., 0., 0., 0.], dtype=float32)),
 PyTreeDef([{'W': *, 'b': *}, {'W': *, 'b': *}]))

Like I mentioned earlier, JAX transforms are composable and can be combined together to generate complex behaviour. We’ve already seen an example of this by applying jax.grad twice to get the second derivative. Another example is combining jax.jit and jax.grad to produce a jit compiled autodiff function!

At risk of becoming an “autodiff” section rather than a function transformation section, I should mention other transformations. A particularly famous one is jax.vmap which simply converts a function on a single input to one that can accept batches of inputs.

Personally I haven’t found much use for this as I am too used to writing batched code anyway. But your mileage may vary.

A more powerful transformation is jax.pmap which converts a function into one that can be parallelised across multiple accelerators, usually in a single-program, multiple-data (data parallel) fashion. A big pull to using JAX is its inbuilt and easy support for parallelism using pmap and other “p” functions. This is a topic in and of itself though, so I leave exploring this to future blogs.

Conclusion

In this lengthy post, I’ve introduced JAX and drilled deep into some key concepts within it, as well as share some highly opinionated takes. I’ve yet demonstrate a full machine learning training loop in JAX but I will cover this using high level libraries like Flax and Optax in later posts.

If I was to summarise the takeaways from this post, they would be:

  • jax.jit is very powerful and should be utilised wherever possible in the widest context.
  • Take care to understand the differences between trace-time and compiled behaviour.
  • Most machine learning code can be rewritten in a static way, and should be done so as much as possible to make the most of XLA.

There is much more to JAX than that, but I think this is a good set of points for a foundational understanding that can be built upon later to great effect.

Arguably, you don’t need this long of an introduction to JAX to start writing training loops and this wasn’t really my original intention. However, as I was writing I found it quite fun to dig deep into the foundations of JAX and its behaviour, and I hope this exploration is useful to others also starting to learn JAX, or even those with more experience. If it wasn’t your cup of tea, I promise that future entries will be much more practical.

If you liked this post please consider following me on Twitter or use this RSS feed for notifications on future ramblings about machine learning and other topics. Alternatively you can navigate to the root of this website and repeatedly refresh until something happens. Thank you for reading this far and I hope you found it useful!

Acknowledgements and Further Resources

Some good extra resources:

Thanks to Kamil Hepak for doing a language review of this blog post!