-
Notifications
You must be signed in to change notification settings - Fork 12
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add functionality for cartesian from polar coords #216
Open
akhilg-nv
wants to merge
1
commit into
main
Choose a base branch
from
dev-akhilg-cartesian-polar
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change | ||||
---|---|---|---|---|---|---|
@@ -0,0 +1,67 @@ | ||||||
# | ||||||
# SPDX-FileCopyrightText: Copyright (c) 2024 NVIDIA CORPORATION & AFFILIATES. All rights reserved. | ||||||
# SPDX-License-Identifier: Apache-2.0 | ||||||
# | ||||||
# Licensed under the Apache License, Version 2.0 (the "License"); | ||||||
# you may not use this file except in compliance with the License. | ||||||
# You may obtain a copy of the License at | ||||||
# | ||||||
# http://www.apache.org/licenses/LICENSE-2.0 | ||||||
# | ||||||
# Unless required by applicable law or agreed to in writing, software | ||||||
# distributed under the License is distributed on an "AS IS" BASIS, | ||||||
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||||||
# See the License for the specific language governing permissions and | ||||||
# limitations under the License. | ||||||
# | ||||||
|
||||||
from tripy import export, constraints | ||||||
|
||||||
|
||||||
@export.public_api(document_under="operations/functions") | ||||||
@constraints.dtype_info( | ||||||
dtype_variables={"T1": ["float32", "float16", "bfloat16", "float8"]}, | ||||||
dtype_constraints={"abs": "T1", "angles": "T1", constraints.RETURN_VALUE: "T1"}, | ||||||
) | ||||||
def cartesian_via_polar(abs: "tripy.Tensor", angles: "tripy.Tensor") -> "tripy.Tensor": | ||||||
r""" | ||||||
Constructs the real-valued cartesian coordinates from magnitude and angle representing polar coordinates. For input | ||||||
``abs`` and ``angle`` of shape :math:`(m_1, m_2, \ldots, m_i),` this function returns a new real tensor of shape | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
:math:`(m_1, m_2, \ldots, m_i, 2)` where the last dimension of size 2 represents the real and imaginary components. | ||||||
|
||||||
.. math:: | ||||||
\text{out}[\ldots, 0] = \text{abs} * \cos(\text{angle}) \\ | ||||||
\text{out}[\ldots, 1] = \text{abs} * \sin(\text{angle}) | ||||||
|
||||||
Args: | ||||||
abs: Tensor of absolute values. | ||||||
angles: Tensor of angles in radians. | ||||||
|
||||||
Returns: | ||||||
A real-valued tensor representing the Cartesian coordinates from the input polar coordinates. | ||||||
|
||||||
.. code-block:: python | ||||||
:linenos: | ||||||
:caption: Example | ||||||
|
||||||
import math | ||||||
|
||||||
abs = tp.Tensor([1.0, 2.0, 3.0]) | ||||||
angles = tp.Tensor([0.0, math.pi/4, math.pi/2]) | ||||||
output = tp.cartesian_via_polar(abs, angles) | ||||||
|
||||||
torch_abs = torch.Tensor([1., 2., 3.]) # doc: omit | ||||||
torch_angles = torch.Tensor([0.0, math.pi/4, math.pi/2]) # doc: omit | ||||||
torch_out = torch.view_as_real(torch.polar(torch_abs, torch_angles)) # doc: omit | ||||||
assert tp.allclose(output, tp.Tensor(torch_out)) | ||||||
assert output.shape == torch_out.shape | ||||||
""" | ||||||
from tripy.frontend.trace.ops.unary_elementwise import sin, cos | ||||||
from tripy.frontend.ops.stack import stack | ||||||
|
||||||
# Convert polar to complex | ||||||
real = abs * cos(angles) | ||||||
imag = abs * sin(angles) | ||||||
|
||||||
# Stack real and imaginary parts | ||||||
return stack([real, imag], dim=-1) |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why do we need this as an API in Tripy and why can't it be a user function? Can you point to similar functionality provided by torch, jax?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This recreates the functionality of torch.polar and torch.view_as_real. Since we don't support complex numbers, I think it's useful to have an existing function that directly accomplishes the same purpose.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe it's better as a helper in the example?