[GitHub] [incubator-mxnet] barry-jin commented on a change in pull request #20592: [API Standardization]Standardize MXNet NumPy Statistical & Linalg Functions

[GitBox <gi...@apache.org>]

barry-jin commented on a change in pull request #20592:
URL: https://github.com/apache/incubator-mxnet/pull/20592#discussion_r725336377



##########
File path: python/mxnet/numpy/multiarray.py
##########
@@ -8679,6 +9172,97 @@ def arctan2(x1, x2, out=None, **kwargs):
     """
     return _mx_nd_np.arctan2(x1, x2, out=out)
 
+atan2 = arctan2
+atan2.__doc__ = """
+    Element-wise arc tangent of ``x1/x2`` choosing the quadrant correctly.
+
+    The quadrant (i.e., branch) is chosen so that ``atan2(x1, x2)`` is
+    the signed angle in radians between the ray ending at the origin and
+    passing through the point (1,0), and the ray ending at the origin and
+    passing through the point (`x2`, `x1`).  (Note the role reversal: the
+    "`y`-coordinate" is the first function parameter, the "`x`-coordinate"
+    is the second.)  By IEEE convention, this function is defined for
+    `x2` = +/-0 and for either or both of `x1` and `x2` = +/-inf (see
+    Notes for specific values).
+
+    This function is not defined for complex-valued arguments; for the
+    so-called argument of complex values, use `angle`.
+    
+    >>>np.atan2 is np.arctan2
+    True
+
+    Parameters
+    ----------
+    x1 : ndarray or scalar
+        `y`-coordinates.
+    x2 : ndarray or scalar
+        `x`-coordinates. `x2` must be broadcastable to match the shape of
+        `x1` or vice versa.
+    out : ndarray or None, optional
+        A location into which the result is stored. If provided, it must have
+        a shape that the inputs broadcast to. If not provided or `None`,
+        a freshly-allocated array is returned.
+
+    Returns
+    -------
+    out : ndarray or scalar
+        Array of angles in radians, in the range ``[-pi, pi]``. This is a scalar if
+        `x1` and `x2` are scalars.
+
+    .. notes::
+       `atan2` is a alias for `arctan2`. It is a standard API in
+       https://data-apis.org/array-api/latest/API_specification/elementwise_functions.html#atan2-x

Review comment:
       ```suggestion
          https://data-apis.org/array-api/latest/API_specification/elementwise_functions.html#atan2-x1-x2
   ```




-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@mxnet.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org