[go: nahoru, domu]
Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Documentation for tf.linalg.set_diag() is missing return information #67255

Closed
khatchad opened this issue May 9, 2024 · 12 comments
Closed

Documentation for tf.linalg.set_diag() is missing return information #67255

khatchad opened this issue May 9, 2024 · 12 comments
Assignees
@tilakrayal
Labels
comp:apis Highlevel API related issues stale This label marks the issue/pr stale - to be closed automatically if no activity stat:awaiting response Status - Awaiting response from author type:bug Bug type:docs-bug Document issues

Comments

@khatchad
Copy link
khatchad commented May 9, 2024 •
edited
Loading

Issue type

Documentation Bug

Have you reproduced the bug with TensorFlow Nightly?

No

Source

source

TensorFlow version

2.16.1

Custom code

No

OS platform and distribution

No response

Mobile device

No response

Python version

No response

Bazel version

No response

GCC/compiler version

No response

CUDA/cuDNN version

No response

GPU model and memory

No response

Current behavior?

Return information at https://www.tensorflow.org/api_docs/python/tf/linalg/set_diag. I only see args.

Standalone code to reproduce the issue

It's a documentation "bug."

Relevant log output

No response
@google-ml-butler google-ml-butler bot added type:bug Bug type:docs-bug Document issues labels May 9, 2024
@khatchad
Copy link
Author
khatchad commented May 9, 2024

Actually, I'm unsure whether these docs are for the correct API. I don't see a call to it anywhere in the examples.

@khatchad
Copy link
Author
khatchad commented May 9, 2024

Ah, they haven't been updated for TF2. They still refer to the old matrix_set_diag API.

@sushreebarsa
Copy link
Contributor
sushreebarsa commented May 10, 2024 •
edited
Loading

@khatchad You're right, the official TF documentation for tf.linalg.set_diag() doesn't explicitly mention the return value in the descriptiontf.linalg.set_diag. Please refer the master branch for the detailed information.
Thank you!

@sushreebarsa sushreebarsa added the stat:awaiting response Status - Awaiting response from author label May 14, 2024
@github-actions GitHub Actions
Copy link

This issue is stale because it has been open for 7 days with no activity. It will be closed if no further activity occurs. Thank you.

@github-actions github-actions bot added the stale This label marks the issue/pr stale - to be closed automatically if no activity label May 22, 2024
@github-actions GitHub Actions
Copy link

This issue was closed because it has been inactive for 7 days since being marked as stale. Please reopen if you'd like to work on this further.

@google-ml-butler Google-ML-Butler
Copy link

Are you satisfied with the resolution of your issue?
Yes
No

@sushreebarsa sushreebarsa reopened this Jun 4, 2024
@sushreebarsa sushreebarsa removed stat:awaiting response Status - Awaiting response from author stale This label marks the issue/pr stale - to be closed automatically if no activity labels Jun 4, 2024
@sushreebarsa
Copy link
Contributor

@khatchad Could you please let us know if you have referred to the above comment and you could see the return information ?
Thank you!

@sushreebarsa sushreebarsa added the stat:awaiting response Status - Awaiting response from author label Jun 4, 2024
@khatchad
Copy link
Author
khatchad commented Jun 4, 2024

@khatchad Could you please let us know if you have referred to the above comment and you could see the return information ? Thank you!

Not sure if I understand the question. It's missing here as well:

tensorflow/tensorflow/python/ops/array_ops.py

Lines 2515 to 2530 in 3825f79

Args:
input: A `Tensor` with rank `k + 1`, where `k >= 1`.
diagonal: A `Tensor` with rank `k`, when `d_lower == d_upper`, or `k + 1`,
otherwise. `k >= 1`.
name: A name for the operation (optional).
k: Diagonal offset(s). Positive value means superdiagonal, 0 refers to the
main diagonal, and negative value means subdiagonals. `k` can be a single
integer (for a single diagonal) or a pair of integers specifying the low
and high ends of a matrix band. `k[0]` must not be larger than `k[1]`.
align: Some diagonals are shorter than `max_diag_len` and need to be padded.
`align` is a string specifying how superdiagonals and subdiagonals should
be aligned, respectively. There are four possible alignments: "RIGHT_LEFT"
(default), "LEFT_RIGHT", "LEFT_LEFT", and "RIGHT_RIGHT". "RIGHT_LEFT"
aligns superdiagonals to the right (left-pads the row) and subdiagonals to
the left (right-pads the row). It is the packing format LAPACK uses.
cuSPARSE uses "LEFT_RIGHT", which is the opposite alignment.

@google-ml-butler google-ml-butler bot removed the stat:awaiting response Status - Awaiting response from author label Jun 4, 2024
@tilakrayal
Copy link
Contributor

@khatchad,
Could you please try to contribute with the PR for the respective changes to be made in the mentioned document? Thank you!

@tilakrayal tilakrayal added comp:apis Highlevel API related issues stat:awaiting response Status - Awaiting response from author labels Jun 10, 2024
@github-actions GitHub Actions
Copy link

This issue is stale because it has been open for 7 days with no activity. It will be closed if no further activity occurs. Thank you.

@github-actions github-actions bot added the stale This label marks the issue/pr stale - to be closed automatically if no activity label Jun 18, 2024
@github-actions GitHub Actions
Copy link

This issue was closed because it has been inactive for 7 days since being marked as stale. Please reopen if you'd like to work on this further.

@google-ml-butler Google-ML-Butler
Copy link

Are you satisfied with the resolution of your issue?
Yes
No

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@tilakrayal tilakrayal

Labels
comp:apis Highlevel API related issues stale This label marks the issue/pr stale - to be closed automatically if no activity stat:awaiting response Status - Awaiting response from author type:bug Bug type:docs-bug Document issues
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@khatchad @tilakrayal @sushreebarsa