Skip to main content

'Hello, World!' Forward Mode Autdiff library with Tensorflow 1 like interface.

Project description

A 'Hello, World!' forward mode autodiff library.

This small (~500 lines) library is meant as an illustration of how forward mode autodiff can possibly be implemented. It lets you compute the value and the derivative of a function expressed as a computational flow using the primitives provided by the library. Interface of the library is very similar to Tensorflow 1.*. All the samples provided in examples folder can very well be run if you do import tensorflow as tf as opposed to import yodf as tf It supports following operations { "add", "subtract", "divide", "multiply", "pow", "sin", "cos", "log", "exp", "matmul", "sigmoid", "reduce_mean", "reduce_sum" }.

Installation

pip install yodf will install the library. Only dependency it has is numpy. Samples provided in examples folder also have dependency on matplotlib.

Basic usage

Below code computes the value and the derivative of the function x^2 at x=5.0

import yodf as tf
x = tf.Variable(5.0)
cost = x**2
with tf.Session() as s:
    # global_variables_initializer API added just so as to
	# resemble Tensorflow, it hardly does anything
    s.run(tf.global_variables_initializer())
    s.run(cost)
print(x.value, cost.value, cost.gradient)

## Output
## 5.0 25.0 10.0

Basic gradient descent example

Below code computes optima of the function x^2 along with the value at which optima occurs starting with x=5.0

import yodf as tf
x = tf.Variable(5.0)
cost = x**2
train = tf.train.GradientDescentOptimizer(learning_rate=0.2).minimize(cost)
with tf.Session() as s:
    s.run(tf.global_variables_initializer())
    for _ in range(50):
        _, cost_final, x_final = s.run([train, x, cost])
print(f"Minima: {cost_final:.10f}, x at minima: {x_final:.10f}")

## Output
## Minima: 0.0000000000, x at minima: 0.0000000000

How does it work?

It has a class called Tensor with Variable and _Constant as subclasses. Tensor object holds a value and a gradient. Gradient of a constant is 0 and that of a variable is 1 which is as good as saying d(x)/dx.
A tensor can also represent an operation and a tensor representating an operation gets created using a convenient function call like tf.sin() or tf.matmul() etc.

import numpy as np
import yodf as tf
x = tf.Variable(np.array([[1,1],[2,2]]))
op_sin = tf.sin(x)
print(op_sin)

## Output
## <yod.Tensor type=TensorType.INT, shape=(2, 2), operation='sin'>

You typically pass a tensor to run method of Session class which ends up evaluating the tensor along with its derivative. Execute method of tensor just knows how to compute derivative of basic arithmatic operations, power function and some of the transcendental functions like sin, cos, log, exp. It also knows how to compute derivative when matrix multiplication operation is involved. By applying the chain rule repeatedly to these operations, derivative of an arbitrary function (represented as a tensor) gets computed automatically. run method simply builds post order traversal tree of the tensor passed to it and evaluates all the nodes in the tree. GradientDescentOptimizer simply updates the value of the variable based on the gradient of the cost tensor passed to its minimize function.
With multiple independent variables, partial derivative of one variable gets computed at a time. For the rest of the variables gradient is set to 0 during computational flow path. This is handled by GradientDescentOptimizer which is not very clean.

Examples

Examples folder shows use of this library for

  1. A gradient descent problem for a simple cost function
  2. A gradient descent problem for a simple cost function with 2 independent variables
  3. A linear regression problem
  4. A logistic regression problem
  5. A neural network with one hidden layer and one output
  6. A neural network with one hidden layer and 10 outputs (MNIST digit classification)

Limitiation of forward mode autodiff

Though with forward mode autodiff, derivative of a function with one independent variables gets computed during forward pass itself and no backward pass is needed as is the case with reverse mode autodiff (generalized backpropagation), with multiple indepdent variables (say weights in a neural network), as many passes are needed as number of indepdent variables. So as can be seen in linear regression sample, time needed by gradient descent linearly increases with increase in degree of polynomial you are trying to fit. For MNIST digit classification, this library becomes almost unusable due to large number of independent variables whose gradient needs to be computed.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

yodf-1.0.10.tar.gz (8.8 kB view details)

Uploaded Source

Built Distribution

yodf-1.0.10-py3-none-any.whl (7.7 kB view details)

Uploaded Python 3

File details

Details for the file yodf-1.0.10.tar.gz.

File metadata

  • Download URL: yodf-1.0.10.tar.gz
  • Upload date:
  • Size: 8.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.4 CPython/3.7.4 Darwin/17.5.0

File hashes

Hashes for yodf-1.0.10.tar.gz
Algorithm Hash digest
SHA256 2f6b052763d9853e9483c6f86614a209bee0e0ac28f014cb4da2d3ff6bf79d3d
MD5 80a366785333b27b11d4af83d32f034a
BLAKE2b-256 190681e245adcba40f22e7cbb4a9cb52066c168a510a91b4ecab48c0fdcc0ad1

See more details on using hashes here.

File details

Details for the file yodf-1.0.10-py3-none-any.whl.

File metadata

  • Download URL: yodf-1.0.10-py3-none-any.whl
  • Upload date:
  • Size: 7.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.4 CPython/3.7.4 Darwin/17.5.0

File hashes

Hashes for yodf-1.0.10-py3-none-any.whl
Algorithm Hash digest
SHA256 a23dd87cb764be910a42b3bf9feb57dbaf0bfc5ae5af266fc00eb5ce9a827cc8
MD5 9c76e6734d724bd2a57dda096609506c
BLAKE2b-256 349f795d264ecf086aa4340d7874c0de89ec9fa081d864a245b0125e60c32942

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page