This document is relevant for: Trn1, Trn2, Trn3

nki.language.sign#

nki.language.sign(x, dtype=None)[source]#

Sign of the numbers of the input, element-wise.

((Similar to numpy.sign))

Warning

This API is experimental and may change in future releases.

The sign function returns -1 if x < 0, 0 if x==0, 1 if x > 0.

Parameters:

  • x – a tile.

  • dtype – (optional) data type to cast the output type to (see Supported Data Types for more information); if not specified, it will default to be the same as the data type of the input tile.

Returns:

a tile that has sign values of x.

Examples:

import nki.language as nl

# nki.language.sign -- sign(-5.0) = -1.0
a = nl.full((128, 512), -5.0, dtype=nl.float32,
            buffer=nl.sbuf)
b = nl.sign(a)
expected = nl.full((128, 512), -1.0, dtype=nl.float32,
                   buffer=nl.sbuf)
assert nl.equal(b, expected)

This document is relevant for: Trn1, Trn2, Trn3