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

Update docs for Universal Functions #1863

Draft
wants to merge 3 commits into
base: master
Choose a base branch
from
+682 −133
Draft

Update docs for Universal Functions #1863

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d75646a
Update docs for Universal Functions
npolina4 May 31, 2024
e986551
Update ufunc doc
npolina4 Jun 6, 2024
3809dca
Merge branch 'master' into update_ufunc
npolina4 Jun 7, 2024
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
3 changes: 2 additions & 1 deletion .pre-commit-config.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,6 +98,7 @@ repos:
"-sn", # Don't display the score
"--disable=import-error",
"--disable=redefined-builtin",
"--disable=unused-wildcard-import"
"--disable=unused-wildcard-import",
"--class-naming-style=snake_case"
Copy link
Contributor

Choose a reason for hiding this comment

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

it would be better to update pyproject.toml:

[tool.pylint.basic]
include-naming-hint = true
class-naming-style = "snake_case"

]
files: '^dpnp/(dpnp_iface.*|fft|linalg)'
13 changes: 11 additions & 2 deletions doc/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,13 @@

from sphinx.ext.autodoc import FunctionDocumenter

from dpnp.dpnp_algo.dpnp_elementwise_common import DPNPBinaryFunc, DPNPUnaryFunc
from dpnp.dpnp_algo.dpnp_elementwise_common import (
DPNPBinaryFunc,
DPNPUnaryFunc,
binary_ufunc,
ufunc,
unary_ufunc,
)

try:
import comparison_generator
Expand Down Expand Up @@ -202,7 +208,10 @@

# -- Options for todo extension ----------------------------------------------
def _can_document_member(member, *args, **kwargs):
if isinstance(member, (DPNPBinaryFunc, DPNPUnaryFunc)):
if isinstance(
member,
(DPNPBinaryFunc, DPNPUnaryFunc, ufunc, unary_ufunc, binary_ufunc),
):
return True
return orig(member, *args, **kwargs)

Expand Down
44 changes: 44 additions & 0 deletions doc/reference/ufunc.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,50 @@ 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.
DPNP ufunc supports following features of NumPy’s one:
Comment on lines 8 to +9
Copy link
Contributor

Choose a reason for hiding this comment

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

It would be better to reuse numpy like description here with a reference to numpy documentation at the end.


- Broadcasting
- Output type determination
- Casting rules

ufuncs
------
.. autosummary::
:toctree: generated/

dpnp.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
----------------
Expand Down
Loading
Loading