Skip to content

[doc-only] docs(cuda.core): use PEP 604 unions in docstrings #2601

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

Open
aryanputta wants to merge 1 commit into
base: main
Choose a base branch
from
Open

[doc-only] docs(cuda.core): use PEP 604 unions in docstrings #2601

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
12 changes: 6 additions & 6 deletions cuda_core/cuda/core/_launch_config.pyi
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,15 +18,15 @@ class LaunchConfig:

Attributes
----------
grid : Union[tuple, int]
grid : tuple | int
Collection of threads that will execute a kernel function. When cluster
is not specified, this represents the number of blocks, otherwise
this represents the number of clusters.
cluster : Union[tuple, int]
cluster : tuple | int
Group of blocks (Thread Block Cluster) that will execute on the same
GPU Processing Cluster (GPC). Blocks within a cluster have access to
distributed shared memory and can be explicitly synchronized.
block : Union[tuple, int]
block : tuple | int
Group of threads (Thread Block) that will execute on the same
streaming multiprocessor (SM). Threads within a thread blocks have
access to shared memory and can be explicitly synchronized.
Expand All @@ -46,11 +46,11 @@ class LaunchConfig:

Parameters
----------
grid : Union[tuple, int], optional
grid : tuple | int, optional
Grid dimensions (number of blocks or clusters if cluster is specified)
cluster : Union[tuple, int], optional
cluster : tuple | int, optional
Cluster dimensions (Thread Block Cluster)
block : Union[tuple, int], optional
block : tuple | int, optional
Block dimensions (threads per block)
shmem_size : int, optional
Dynamic shared memory size in bytes (default: 0)
Expand Down
12 changes: 6 additions & 6 deletions cuda_core/cuda/core/_launch_config.pyx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,15 +38,15 @@ cdef class LaunchConfig:

Attributes
----------
grid : Union[tuple, int]
grid : tuple | int
Collection of threads that will execute a kernel function. When cluster
is not specified, this represents the number of blocks, otherwise
this represents the number of clusters.
cluster : Union[tuple, int]
cluster : tuple | int
Group of blocks (Thread Block Cluster) that will execute on the same
GPU Processing Cluster (GPC). Blocks within a cluster have access to
distributed shared memory and can be explicitly synchronized.
block : Union[tuple, int]
block : tuple | int
Group of threads (Thread Block) that will execute on the same
streaming multiprocessor (SM). Threads within a thread blocks have
access to shared memory and can be explicitly synchronized.
Expand Down Expand Up @@ -77,11 +77,11 @@ cdef class LaunchConfig:

Parameters
----------
grid : Union[tuple, int], optional
grid : tuple | int, optional
Grid dimensions (number of blocks or clusters if cluster is specified)
cluster : Union[tuple, int], optional
cluster : tuple | int, optional
Cluster dimensions (Thread Block Cluster)
block : Union[tuple, int], optional
block : tuple | int, optional
Block dimensions (threads per block)
shmem_size : int, optional
Dynamic shared memory size in bytes (default: 0)
Expand Down
38 changes: 19 additions & 19 deletions cuda_core/cuda/core/_module.pyi
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -158,7 +158,7 @@ class KernelOccupancy:

Parameters
----------
dynamic_shared_memory_needed: Union[int, driver.CUoccupancyB2DSize]
dynamic_shared_memory_needed: int | driver.CUoccupancyB2DSize
The amount of dynamic shared memory in bytes needed by block.
Use `0` if block does not need shared memory. Use C-callable
represented by :obj:`~driver.CUoccupancyB2DSize` to encode
Expand Down Expand Up @@ -343,13 +343,13 @@ class ObjectCode:

Parameters
----------
module : Union[bytes, str, os.PathLike]
module : bytes | str | os.PathLike
Either a bytes object containing the in-memory cubin to load, or
a file path object (or its string representation) pointing to the
on-disk cubin to load.
name : Optional[str]
name : str | None
A human-readable identifier representing this code object.
symbol_mapping : Optional[dict]
symbol_mapping : dict | None
A dictionary specifying how the unmangled symbol names (as keys)
should be mapped to the mangled names before trying to retrieve
them (default to no mappings).
Expand All @@ -361,13 +361,13 @@ class ObjectCode:

Parameters
----------
module : Union[bytes, str, os.PathLike]
module : bytes | str | os.PathLike
Either a bytes object containing the in-memory ptx code to load, or
a file path object (or its string representation) pointing to the
on-disk ptx file to load.
name : Optional[str]
name : str | None
A human-readable identifier representing this code object.
symbol_mapping : Optional[dict]
symbol_mapping : dict | None
A dictionary specifying how the unmangled symbol names (as keys)
should be mapped to the mangled names before trying to retrieve
them (default to no mappings).
Expand All @@ -379,13 +379,13 @@ class ObjectCode:

Parameters
----------
module : Union[bytes, str, os.PathLike]
module : bytes | str | os.PathLike
Either a bytes object containing the in-memory ltoir code to load,
or a file path object (or its string representation) pointing to the
on-disk ltoir file to load.
name : Optional[str]
name : str | None
A human-readable identifier representing this code object.
symbol_mapping : Optional[dict]
symbol_mapping : dict | None
A dictionary specifying how the unmangled symbol names (as keys)
should be mapped to the mangled names before trying to retrieve
them (default to no mappings).
Expand All @@ -397,13 +397,13 @@ class ObjectCode:

Parameters
----------
module : Union[bytes, str, os.PathLike]
module : bytes | str | os.PathLike
Either a bytes object containing the in-memory fatbin to load, or
or a file path object (or its string representation) pointing to the
on-disk fatbin to load.
name : Optional[str]
name : str | None
A human-readable identifier representing this code object.
symbol_mapping : Optional[dict]
symbol_mapping : dict | None
A dictionary specifying how the unmangled symbol names (as keys)
should be mapped to the mangled names before trying to retrieve
them (default to no mappings).
Expand All @@ -415,12 +415,12 @@ class ObjectCode:

Parameters
----------
module : Union[bytes, str]
module : bytes | str
Either a bytes object containing the in-memory object code to load, or
a file path string pointing to the on-disk object code to load.
name : Optional[str]
name : str | None
A human-readable identifier representing this code object.
symbol_mapping : Optional[dict]
symbol_mapping : dict | None
A dictionary specifying how the unmangled symbol names (as keys)
should be mapped to the mangled names before trying to retrieve
them (default to no mappings).
Expand All @@ -432,12 +432,12 @@ class ObjectCode:

Parameters
----------
module : Union[bytes, str]
module : bytes | str
Either a bytes object containing the in-memory library to load, or
a file path string pointing to the on-disk library to load.
name : Optional[str]
name : str | None
A human-readable identifier representing this code object.
symbol_mapping : Optional[dict]
symbol_mapping : dict | None
A dictionary specifying how the unmangled symbol names (as keys)
should be mapped to the mangled names before trying to retrieve
them (default to no mappings).
Expand Down
38 changes: 19 additions & 19 deletions cuda_core/cuda/core/_module.pyx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -300,7 +300,7 @@ cdef class KernelOccupancy:

Parameters
----------
dynamic_shared_memory_needed: Union[int, driver.CUoccupancyB2DSize]
dynamic_shared_memory_needed: int | driver.CUoccupancyB2DSize
The amount of dynamic shared memory in bytes needed by block.
Use `0` if block does not need shared memory. Use C-callable
represented by :obj:`~driver.CUoccupancyB2DSize` to encode
Expand Down Expand Up @@ -669,13 +669,13 @@ cdef class ObjectCode:

Parameters
----------
module : Union[bytes, str, os.PathLike]
module : bytes | str | os.PathLike
Either a bytes object containing the in-memory cubin to load, or
a file path object (or its string representation) pointing to the
on-disk cubin to load.
name : Optional[str]
name : str | None
A human-readable identifier representing this code object.
symbol_mapping : Optional[dict]
symbol_mapping : dict | None
A dictionary specifying how the unmangled symbol names (as keys)
should be mapped to the mangled names before trying to retrieve
them (default to no mappings).
Expand All @@ -688,13 +688,13 @@ cdef class ObjectCode:

Parameters
----------
module : Union[bytes, str, os.PathLike]
module : bytes | str | os.PathLike
Either a bytes object containing the in-memory ptx code to load, or
a file path object (or its string representation) pointing to the
on-disk ptx file to load.
name : Optional[str]
name : str | None
A human-readable identifier representing this code object.
symbol_mapping : Optional[dict]
symbol_mapping : dict | None
A dictionary specifying how the unmangled symbol names (as keys)
should be mapped to the mangled names before trying to retrieve
them (default to no mappings).
Expand All @@ -707,13 +707,13 @@ cdef class ObjectCode:

Parameters
----------
module : Union[bytes, str, os.PathLike]
module : bytes | str | os.PathLike
Either a bytes object containing the in-memory ltoir code to load,
or a file path object (or its string representation) pointing to the
on-disk ltoir file to load.
name : Optional[str]
name : str | None
A human-readable identifier representing this code object.
symbol_mapping : Optional[dict]
symbol_mapping : dict | None
A dictionary specifying how the unmangled symbol names (as keys)
should be mapped to the mangled names before trying to retrieve
them (default to no mappings).
Expand All @@ -726,13 +726,13 @@ cdef class ObjectCode:

Parameters
----------
module : Union[bytes, str, os.PathLike]
module : bytes | str | os.PathLike
Either a bytes object containing the in-memory fatbin to load, or
or a file path object (or its string representation) pointing to the
on-disk fatbin to load.
name : Optional[str]
name : str | None
A human-readable identifier representing this code object.
symbol_mapping : Optional[dict]
symbol_mapping : dict | None
A dictionary specifying how the unmangled symbol names (as keys)
should be mapped to the mangled names before trying to retrieve
them (default to no mappings).
Expand All @@ -745,12 +745,12 @@ cdef class ObjectCode:

Parameters
----------
module : Union[bytes, str]
module : bytes | str
Either a bytes object containing the in-memory object code to load, or
a file path string pointing to the on-disk object code to load.
name : Optional[str]
name : str | None
A human-readable identifier representing this code object.
symbol_mapping : Optional[dict]
symbol_mapping : dict | None
A dictionary specifying how the unmangled symbol names (as keys)
should be mapped to the mangled names before trying to retrieve
them (default to no mappings).
Expand All @@ -763,12 +763,12 @@ cdef class ObjectCode:

Parameters
----------
module : Union[bytes, str]
module : bytes | str
Either a bytes object containing the in-memory library to load, or
a file path string pointing to the on-disk library to load.
name : Optional[str]
name : str | None
A human-readable identifier representing this code object.
symbol_mapping : Optional[dict]
symbol_mapping : dict | None
A dictionary specifying how the unmangled symbol names (as keys)
should be mapped to the mangled names before trying to retrieve
them (default to no mappings).
Expand Down
16 changes: 8 additions & 8 deletions cuda_core/cuda/core/_program.pyi
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -166,7 +166,7 @@ class ProgramOptions:
Enable device code optimization. When specified along with '-G', enables limited debug information generation
for optimized device code.
Default: None
ptxas_options : Union[str, list[str]], optional
ptxas_options : str | list[str], optional
Specify one or more options directly to ptxas, the PTX optimizing assembler. Options should be strings.
For example ["-v", "-O2"].
Default: None
Expand Down Expand Up @@ -200,17 +200,17 @@ class ProgramOptions:
gen_opt_lto : bool, optional
Run the optimizer passes before generating the LTO IR.
Default: False
define_macro : Union[str, tuple[str, str], list[Union[str, tuple[str, str]]]], optional
define_macro : str | tuple[str, str] | list[str | tuple[str, str]], optional
Predefine a macro. Can be either a string, in which case that macro will be set to 1, a 2 element tuple of
strings, in which case the first element is defined as the second, or a list of strings or tuples.
Default: None
undefine_macro : Union[str, list[str]], optional
undefine_macro : str | list[str], optional
Cancel any previous definition of a macro, or list of macros.
Default: None
include_path : Union[str, list[str]], optional
include_path : str | list[str], optional
Add the directory or directories to the list of directories to be searched for headers.
Default: None
pre_include : Union[str, list[str]], optional
pre_include : str | list[str], optional
Preinclude one or more headers during preprocessing. Can be either a string or a list of strings.
Default: None
no_source_include : bool, optional
Expand Down Expand Up @@ -243,13 +243,13 @@ class ProgramOptions:
no_display_error_number : bool, optional
Disable the display of a diagnostic number for warning messages.
Default: False
diag_error : Union[int, list[int]], optional
diag_error : int | list[int], optional
Emit error for a specified diagnostic message number or comma-separated list of numbers.
Default: None
diag_suppress : Union[int, list[int]], optional
diag_suppress : int | list[int], optional
Suppress a specified diagnostic message number or comma-separated list of numbers.
Default: None
diag_warn : Union[int, list[int]], optional
diag_warn : int | list[int], optional
Emit warning for a specified diagnostic message number or comma-separated list of numbers.
Default: None
brief_diagnostics : bool, optional
Expand Down
16 changes: 8 additions & 8 deletions cuda_core/cuda/core/_program.pyx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -319,7 +319,7 @@ class ProgramOptions:
Enable device code optimization. When specified along with '-G', enables limited debug information generation
for optimized device code.
Default: None
ptxas_options : Union[str, list[str]], optional
ptxas_options : str | list[str], optional
Specify one or more options directly to ptxas, the PTX optimizing assembler. Options should be strings.
For example ["-v", "-O2"].
Default: None
Expand Down Expand Up @@ -353,17 +353,17 @@ class ProgramOptions:
gen_opt_lto : bool, optional
Run the optimizer passes before generating the LTO IR.
Default: False
define_macro : Union[str, tuple[str, str], list[Union[str, tuple[str, str]]]], optional
define_macro : str | tuple[str, str] | list[str | tuple[str, str]], optional
Predefine a macro. Can be either a string, in which case that macro will be set to 1, a 2 element tuple of
strings, in which case the first element is defined as the second, or a list of strings or tuples.
Default: None
undefine_macro : Union[str, list[str]], optional
undefine_macro : str | list[str], optional
Cancel any previous definition of a macro, or list of macros.
Default: None
include_path : Union[str, list[str]], optional
include_path : str | list[str], optional
Add the directory or directories to the list of directories to be searched for headers.
Default: None
pre_include : Union[str, list[str]], optional
pre_include : str | list[str], optional
Preinclude one or more headers during preprocessing. Can be either a string or a list of strings.
Default: None
no_source_include : bool, optional
Expand Down Expand Up @@ -396,13 +396,13 @@ class ProgramOptions:
no_display_error_number : bool, optional
Disable the display of a diagnostic number for warning messages.
Default: False
diag_error : Union[int, list[int]], optional
diag_error : int | list[int], optional
Emit error for a specified diagnostic message number or comma-separated list of numbers.
Default: None
diag_suppress : Union[int, list[int]], optional
diag_suppress : int | list[int], optional
Suppress a specified diagnostic message number or comma-separated list of numbers.
Default: None
diag_warn : Union[int, list[int]], optional
diag_warn : int | list[int], optional
Emit warning for a specified diagnostic message number or comma-separated list of numbers.
Default: None
brief_diagnostics : bool, optional
Expand Down
Loading