Skip to content

PR: Add note for functions that are not compatible with static memory allocation #168

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

Closed
wants to merge 41 commits into from
Closed

PR: Add note for functions that are not compatible with static memory allocation #168

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
41 commits
Select commit Hold shift + click to select a range
8815028
Add note for functions that doesn't support boolean array indexing
steff456 Apr 22, 2021
2757e73
clarify the notes
steff456 Apr 26, 2021
b98c908
remove note from where function
steff456 Apr 26, 2021
ad3156d
Some small fixes to function signatures to make them valid Python (#174)
asmeurer Apr 27, 2021
e6d827a
Update API specification for creation and manipulation functions (#167)
rgommers Apr 27, 2021
b0f4ca0
Change deployment to github actions for github pages (#176)
steff456 May 3, 2021
0c5d913
Specify the input types for logaddexp (#175)
asmeurer May 3, 2021
ffc4d0c
Create a unique admonition for data-dependent shapes
rgommers May 3, 2021
2e759ef
Add data type guidance (#173)
kgryte May 3, 2021
204e283
Rewrite note with the given suggestions
steff456 May 6, 2021
4d74293
Make axis keyword to squeeze() positional (#100)
rgommers May 11, 2021
76730f1
Add Cholesky function specification (#110)
kgryte May 12, 2021
059e4fe
Add slogdet specification (#111)
kgryte May 12, 2021
9893373
Add specification for computing the pseudo-inverse (linalg: pinv) (#118)
kgryte May 12, 2021
36fd440
Add specification for computing the dot product (linalg: vecdot) (#137)
kgryte May 12, 2021
0768fc8
Add specification for computing a tensor contraction (linalg: tensord…
kgryte May 12, 2021
5677c24
Add linalg solve function specification (#115)
kgryte May 12, 2021
56ce784
Add SVD function specification (#114)
kgryte May 12, 2021
e32a6a8
Add specification for returning the least-squares solution to a linea…
kgryte May 12, 2021
a33a710
Add specification for computing the qr factorization (#126)
kgryte May 12, 2021
3add230
Add specification for computing singular values using singular value …
kgryte May 12, 2021
fe3b410
Add specification for computing the eigenvalues and eigenvectors of a…
kgryte May 12, 2021
a1d00d5
Add specification for computing the eigenvalues of a symmetric matrix…
kgryte May 12, 2021
7557e69
Add specification for computing the matrix product (linalg: matmul) (…
kgryte May 12, 2021
e0c0c87
Add specification for computing the number of non-zero singular value…
kgryte May 12, 2021
30b0391
Add matrix_power specification (#112)
kgryte May 12, 2021
d00d255
Fix meshgrid formatting (#178)
leofang May 12, 2021
83c6be3
Add linear algebra design principles (#149)
kgryte May 12, 2021
c2ecccc
Fix matmul formatting (#179)
leofang May 12, 2021
9efd284
Fix norm formatting (#181)
leofang May 12, 2021
03a2b41
Move linear algebra APIs to an extension (#182)
kgryte May 20, 2021
0429693
Fix a typo in the spec (#184)
asmeurer May 20, 2021
2472846
Add a requirement for the producer of a DLPack capsule(#186)
leofang May 25, 2021
e3927fd
Improve documentation for `stream` argument to `__dlpack__` (#185)
rgommers May 26, 2021
192b4d7
Clarify that constants are Python scalars (#169)
kgryte May 31, 2021
63c592e
Fix typo in definition of __lshift__ (#190)
tomwhite Jun 4, 2021
4c8142c
Merge remote-tracking branch 'steff/add-boolean-indexing-notes' into …
kgryte Jun 7, 2021
0a61b94
Update notes
kgryte Jun 7, 2021
c9541aa
Add document stub
kgryte Jun 7, 2021
b1fd96e
Add admonition for boolean array indexing and update reference
kgryte Jun 7, 2021
9f336ae
Add explainer on data-dependent output shapes
kgryte Jun 7, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions spec/API_specification/searching_functions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,12 @@ Returns the indices of the minimum values along a specified axis. When the minim
(function-nonzero)=
### nonzero(x, /)

:::{admonition} Data-dependent output shape
:class: important

The shape of the output array for this function depends on the data values in the input array, hence it can be difficult to implement for libraries that build computation graphs for arrays without knowing their values. See {ref}`indexing` section for more details.
Copy link
Contributor

@kgryte kgryte May 11, 2021 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not clear to me what we are referring to in the "indexing section". I think, instead, what is wanted is to refer to a separate page under "Design topics" where we specifically discuss APIs which return arrays having data-dependent shapes (for further discussion, see here).

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we refer to this PR or to the boolean indexing section inside the spec or both?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we need to add a new section in "Design Topics" (via this PR) and then reference that section.

:::

Returns the indices of the array elements which are non-zero.

#### Parameters
Expand Down
6 changes: 6 additions & 0 deletions spec/API_specification/set_functions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,12 @@ A conforming implementation of the array API standard must provide and support t
(function-unique)=
### unique(x, /, *, return_counts=False, return_index=False, return_inverse=False)

:::{admonition} Data-dependent output shape
:class: important

The shape of the output array for this function depends on the data values in the input array, hence it can be difficult to implement for libraries that build computation graphs for arrays without knowing their values. See {ref}`indexing` section for more details.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same comment as above.

:::

Returns the unique elements of an input array `x`.

#### Parameters
Expand Down