Skip to content

Commit 027de95

Browse files
committed
Update description based on review comments
1 parent 91f77be commit 027de95

File tree

1 file changed

+14
-17
lines changed

1 file changed

+14
-17
lines changed

dpnp/dpnp_iface_trigonometric.py

Lines changed: 14 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1202,7 +1202,7 @@ def cumlogsumexp(
12021202
See Also
12031203
--------
12041204
:obj:`dpnp.log` : Natural logarithm, element-wise.
1205-
:obj:`dpnp.log2` : Return the base 2 logarithm of the input array, element-wise.
1205+
:obj:`dpnp.log2` : Return the base-2 logarithm of the input array, element-wise.
12061206
:obj:`dpnp.log1p` : Return the natural logarithm of one plus the input array, element-wise.
12071207
12081208
Examples
@@ -1263,7 +1263,7 @@ def cumlogsumexp(
12631263
:obj:`dpnp.expm1` : ``exp(x) - 1``, the inverse of :obj:`dpnp.log1p`.
12641264
:obj:`dpnp.log` : Natural logarithm, element-wise.
12651265
:obj:`dpnp.log10` : Return the base 10 logarithm of the input array, element-wise.
1266-
:obj:`dpnp.log2` : Return the base 2 logarithm of the input array, element-wise.
1266+
:obj:`dpnp.log2` : Return the base-2 logarithm of the input array, element-wise.
12671267
12681268
Examples
12691269
--------
@@ -1391,7 +1391,10 @@ def cumlogsumexp(
13911391
--------
13921392
:obj:`dpnp.log` : Natural logarithm, element-wise.
13931393
:obj:`dpnp.exp` : Exponential, element-wise.
1394-
:obj:`dpnp.logsumdexp` : Logarithm of the sum of exponents of elements in the input array.
1394+
:obj:`dpnp.logaddexp2`: Logarithm of the sum of exponentiations of inputs in
1395+
base-2, element-wise.
1396+
:obj:`dpnp.logsumexp` : Logarithm of the sum of exponents of elements in the
1397+
input array.
13951398
13961399
Examples
13971400
--------
@@ -1414,21 +1417,13 @@ def cumlogsumexp(
14141417

14151418

14161419
_LOGADDEXP2_DOCSTRING = """
1417-
Calculates the logarithm of the sum of exponents for each element `x1_i`
1418-
of the input array `x1` with the respective element `x2_i` of the input
1420+
Calculates the logarithm of the sum of exponents in base-2 for each element
1421+
`x1_i` of the input array `x1` with the respective element `x2_i` of the input
14191422
array `x2`.
14201423
1421-
Logarithm of the sum of exponentiations of the inputs in base-2.
1422-
1423-
Calculates ``log2(2**x1 + 2**x2)``. This function is useful in machine
1424-
learning when the calculated probabilities of events may be so small as
1425-
to exceed the range of normal floating point numbers. In such cases
1426-
the base-2 logarithm of the calculated probability can be used instead.
1427-
This function allows adding probabilities stored in such a fashion.
1428-
14291424
This function calculates `log2(2**x1 + 2**x2)`. It is useful in machine
14301425
learning when the calculated probabilities of events may be so small as
1431-
to exceed the range of normal floating point numbers. In such cases the base-2
1426+
to exceed the range of normal floating point numbers. In such cases the base-2
14321427
logarithm of the calculated probability can be used instead. This function
14331428
allows adding probabilities stored in such a fashion.
14341429
@@ -1466,9 +1461,9 @@ def cumlogsumexp(
14661461
14671462
See Also
14681463
--------
1469-
:obj:`dpnp.log` : Natural logarithm, element-wise.
1470-
:obj:`dpnp.exp` : Exponential, element-wise.
1471-
:obj:`dpnp.logsumdexp` : Logarithm of the sum of exponents of elements in the input array.
1464+
:obj:`dpnp.logaddexp`: Natural logarithm of the sum of exponentiations of
1465+
inputs, element-wise.
1466+
:obj:`dpnp.logsumexp` : Logarithm of the sum of exponentiations of the inputs.
14721467
14731468
Examples
14741469
--------
@@ -1550,6 +1545,8 @@ def logsumexp(x, /, *, axis=None, dtype=None, keepdims=False, out=None):
15501545
:obj:`dpnp.exp` : Exponential, element-wise.
15511546
:obj:`dpnp.logaddexp` : Logarithm of the sum of exponents of
15521547
the inputs, element-wise.
1548+
:obj:`dpnp.logaddexp2` : Logarithm of the sum of exponents of
1549+
the inputs in base-2, element-wise.
15531550
15541551
Examples
15551552
--------

0 commit comments

Comments
 (0)