relu#
- ivy.relu(x, /, *, out=None)[source]#
Apply the rectified linear unit function element-wise.
- Parameters:
- Return type:
- Returns:
ret – an array containing the rectified linear unit activation of each element in
x
.
Examples
With
ivy.Array
input:>>> x = ivy.array([-1., 0., 1.]) >>> y = ivy.relu(x) >>> print(y) ivy.array([0., 0., 1.])
>>> x = ivy.array([1.5, 0.7, -2.4]) >>> y = ivy.zeros(3) >>> ivy.relu(x, out = y) >>> print(y) ivy.array([1.5, 0.7, 0.])
With
ivy.Container
input:>>> x = ivy.Container(a=ivy.array([1.0, -1.2]), b=ivy.array([0.4, -0.2])) >>> x = ivy.relu(x, out=x) >>> print(x) { a: ivy.array([1., 0.]), b: ivy.array([0.40000001, 0.]) }
- Array.relu(self, /, *, out=None)#
ivy.Array instance method variant of ivy.relu. This method simply wraps the function, and so the docstring for ivy.relu also applies to this method with minimal changes.
- Parameters:
self (
Array
) – input array.out (
Optional
[Array
]) – optional output array, for writing the result to. It must have a shape (default:None
) that the inputs broadcast to.
- Return type:
Array
- Returns:
ret – an array with the relu activation function applied element-wise.
Examples
>>> x = ivy.array([-1., 0., 1.]) >>> y = x.relu() >>> print(y) ivy.array([0., 0., 1.])
- Container.relu(self, /, *, key_chains=None, to_apply=True, prune_unapplied=False, map_sequences=False, out=None)#
ivy.Container instance method variant of ivy.relu. This method simply wraps the function, and so the docstring for ivy.relu also applies to this method with minimal changes.
- Parameters:
self (
Container
) – input container.key_chains (
Optional
[Union
[List
[str
],Dict
[str
,str
]]]) – The key-chains to apply or not apply the method to. Default isNone
. (default:None
)to_apply (
bool
) – If True, the method will be applied to key_chains, otherwise key_chains (default:True
) will be skipped. Default isTrue
.prune_unapplied (
bool
) – Whether to prune key_chains for which the function was not applied. (default:False
) Default isFalse
.map_sequences (
bool
) – Whether to also map method to sequences (lists, tuples). (default:False
) Default isFalse
.out (
Optional
[Container
]) – optional output container, for writing the result to. It must have a shape (default:None
) that the inputs broadcast to.
- Return type:
Container
- Returns:
ret – a container with the rectified linear activation unit function applied element-wise.
Examples
>>> x = ivy.Container(a=ivy.array([1.0, -1.2]), b=ivy.array([0.4, -0.2])) >>> y = x.relu() >>> print(y) { a: ivy.array([1., 0.]), b: ivy.array([0.40000001, 0.]) }