-
Notifications
You must be signed in to change notification settings - Fork 22
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
Implement docs for ufunc. Update docs for logic element-wise functions. #1967
base: master
Are you sure you want to change the base?
Changes from all commits
d87a689
71262da
6edab8c
023cd53
048ef8e
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -5,7 +5,49 @@ Universal Functions (ufunc) | |
|
||
.. https://docs.scipy.org/doc/numpy/reference/ufuncs.html | ||
|
||
DPNP provides universal functions (a.k.a. ufuncs) to support various element-wise operations. | ||
A universal function (or ufunc for short) is a function that operates on ndarrays in an element-by-element fashion, \ | ||
supporting array broadcasting, type casting, and several other standard features. That is, a ufunc is a “vectorized” \ | ||
wrapper for a function that takes a fixed number of specific inputs and produces a fixed number of specific outputs. \ | ||
For full documentation refer to :obj:`numpy.ufunc`. | ||
|
||
ufuncs | ||
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. Can we put here a link to :class: |
||
------ | ||
.. autosummary:: | ||
:toctree: generated/ | ||
|
||
dpnp.ufunc | ||
|
||
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. What if about |
||
Attributes | ||
~~~~~~~~~~ | ||
|
||
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. Do we need to specify .. index::
pair: ufunc; attributes |
||
There are some informational attributes that universal functions | ||
possess. None of the attributes can be set. | ||
|
||
============ ================================================================= | ||
**__doc__** A docstring for each ufunc. The first part of the docstring is | ||
dynamically generated from the number of outputs, the name, and | ||
the number of inputs. The second part of the docstring is | ||
provided at creation time and stored with the ufunc. | ||
|
||
**__name__** The name of the ufunc. | ||
============ ================================================================= | ||
|
||
.. autosummary:: | ||
:toctree: generated/ | ||
:nosignatures: | ||
|
||
dpnp.ufunc.nin | ||
dpnp.ufunc.nout | ||
dpnp.ufunc.nargs | ||
dpnp.ufunc.types | ||
dpnp.ufunc.ntypes | ||
|
||
Methods | ||
~~~~~~~ | ||
.. autosummary:: | ||
:toctree: generated/ | ||
|
||
dpnp.ufunc.outer | ||
|
||
Available ufuncs | ||
---------------- | ||
|
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
\
here? Is it helps somehow to format the output? (and in what way?)I don't see that we used it previously somewhere and so wonder why do we need it here.