Tensorflow.js tf.sum() Function

Tensorflow.js is an open-source library developed by Google for running machine learning models and deep learning neural networks in the browser or node environment.

The tf.sum() function is used to calculate sum of the elements of a specified Tensor across its dimension. It reduces the given input elements along the dimensions of axes. If the parameter “keepDims” is true, the reduced dimensions are retained with length 1 else the rank of Tensor is reduced by 1. If the axes parameter has no entries, it returns a Tensor with a single element with all reduced dimensions.

Syntax:

tf.sum(x, axis, keepDims)

Parameters: This function accepts three parameters which are illustrated below:

• x: The input tensor on which sum operation is being computed. If the data type is Boolean value, it will be converted into int32 and the returned output will also be in int32.
• axis: The specified dimension(s) to reduce. By default it reduces all dimensions. It is optional parameter.
• keepDims: If this parameter value is true, it retains reduced dimensions with length 1 else the rank of Tensor is reduced by 1. It is also optional parameter.

Return Value: It returns a Tensor for the result of sum operation.

Example 1:

// Importing the tensorflow.js library
import * as tf from "@tensorflow/tfjs"

// Initializing a some tensors 
const a = tf.tensor1d([0, 1]);
const b = tf.tensor1d([3, 5]);
const c = tf.tensor1d([2, 4, 7]);

// Calling the .sum() function over 
// the above tensors
a.sum().print();
b.sum().print();
c.sum().print();

Output:

Tensor
   1
Tensor
   8
Tensor
   13

Example 2:

// Importing the tensorflow.js library
import * as tf from "@tensorflow/tfjs"

// Initializing a some tensors 
const a = tf.tensor1d([0, 1]);
const b = tf.tensor2d([3, 5, 2, 8], [2, 2]);
const c = tf.tensor1d([2, 4, 7]);

// Initializing a axis parameters
const axis1 = -1;
const axis2 = -2;
const axis3 = 0;

// Calling the .sum() function over 
// the above tensors
a.sum(axis1).print();
b.sum(axis2, true).print();
c.sum(axis1, false).print();
b.sum(axis3, false).print();

Output:

Tensor
   1
Tensor
    [[5, 13],]
Tensor
   13
Tensor
   [5, 13]