tensorwrap 0.0.0.6

TensorWrap: A high level TensorFlow wrapper for JAX.

TensorWrap

TensorWrap - A full-fledged Deep Learning Library based on JAX and TensorFlow.

| Install guide

What is TensorWrap?

TensorWrap is high performance neural network library that acts as a wrapper around JAX (another high performance machine learning library), bringing the familiar feel of the TensorFlow (2.x.x). This is currently aimed towards prototyping over deployment, in the current state.

TensorWrap works by creating a layer of abstraction over JAX's low level api and introducing similar TensorFlow-like component's while supporting Autograd in native JAX operations. Additionally, the api has been updated to become more simpler and concise than TensorFlow's current API, by removing the redundant API's and deprecations that it possesses. Additionally, this library aims to improve the poor design of the TensorFlow API and making it more friendly towards research and educational audiences.

This is a personal project, not professionally affliated with Google in any way. Expect bugs and several incompatibilities/difference from the original libraries. Please help by trying it out, reporting bugs, and letting me know what you think!

Contents

• Examples
• Current gimmicks
• Installation
• Neural net libraries
• Citations
• Reference documentation

Examples

1. Custom Layers

import tensorwrap as tf
from tensorwrap import nn

class Dense(nn.layers.Layer):
    def __init__(self, units) -> None:
        super().__init__() # Needed for making it JIT compatible.
        self.units = units # Defining the output shape
  
    def build(self, input_shape: tuple) -> None:
        input_shape = tf.shape(input_shape) # Getting appropriate input shape
        self.kernel = self.add_weights([input_shape, self.units],
                                       initializer = 'glorot_uniform')
        self.bias = self.add_weights([self.units],
                                     initializer = 'zeros')
        super().build(self.kernel, self.bias) # Needed to add the kernel to model.
    
    # Use call not __call__ to define the flow. No tf.function needed either.
    def call(self, inputs):
        return inputs @ self.kernel + self.bias

2. Just In Time Compiling with tf.function

import tensorwrap as tf
from tensorwrap import nn
tf.test.is_device_available(device_type = 'cuda')

@tf.function
def mse(y_pred, y_true):
    return tf.mean(tf.square(y_pred - y_true))

print(mse(100, 102))

3. Customizing with Module Class

class CheckPoint(Module):
    def __init__(self, metrics) -> None:
        

Current Gimmicks

1. Current models are all compiled by JAX's internal jit, so any error may remain a bit more cryptic than PyTorchs. However, this problem is still being worked on.

2. Also, using tensorwrap.Module is currently not recommended, since other superclasses offer more functionality and ease of use.

3. Sometime, the JAX backend may give out and give an algorithmic error. Another high priority, though this one is hidden in the C++ api of JIT.

4. The JIT compilation is currently double of TensorFlow's on big models. However, the speed up is immense.

5. Graph execution is currently not available, which means that all exported models can only be deployed within a python environment.

Installation

The device installation of TensorWrap depends on its backend, being JAX. Thus, our normal install will be covering both the GPU and CPU installation.

pip install --upgrade pip
pip install --upgrade tensorwrap

On Linux, it is often necessary to first update pip to a version that supports manylinux2014 wheels. Also note that for Linux, we currently release wheels for x86_64 architectures only, other architectures require building from source. Trying to pip install with other Linux architectures may lead to jaxlib not being installed alongside jax, although jax may successfully install (but fail at runtime). These pip installations do not work with Windows, and may fail silently; see above.

Note

If any problems occur with cuda installation, please visit the JAX github page, in order to understand the problem with lower API installation.

Citations

This project have been heavily inspired by TensorFlow and once again, is built on the open-source machine learning XLA framework JAX. Therefore, I recognize the authors of JAX and TensorFlow for the exceptional work they have done and understand that my library doesn't profit in any sort of way, since it is merely an add-on to the already existing community.

@software{jax2018github,
  author = {James Bradbury and Roy Frostig and Peter Hawkins and Matthew James Johnson and Chris Leary and Dougal Maclaurin and George Necula and Adam Paszke and Jake Vander{P}las and Skye Wanderman-{M}ilne and Qiao Zhang},
  title = {{JAX}: composable transformations of {P}ython+{N}um{P}y programs},
  url = {http://github.com/google/jax},
  version = {0.3.13},
  year = {2018},
}

Reference documentation

For details about the TensorWrap API, see the [main documentation] (coming soon!)

For details about JAX, see the reference documentation.

For documentation on TensorFlow API, see the API documentation