Skip to content

Commit 28014d7

Browse files
Merge pull request #293 from KernelTuner/update_documentation
update documentation
2 parents 199fd99 + d0f0840 commit 28014d7

File tree

4 files changed

+4
-9
lines changed

4 files changed

+4
-9
lines changed

INSTALL.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -125,7 +125,7 @@ Or you could install Kernel Tuner and PyOpenCL together if you haven't done so a
125125
If this fails, please see the PyOpenCL installation guide (https://wiki.tiker.net/PyOpenCL/Installation)
126126

127127
HIP and HIP Python
128-
-------------
128+
------------------
129129

130130
Before we can install HIP Python, you'll need to have the HIP runtime and compiler installed on your system.
131131
The HIP compiler is included as part of the ROCm software stack. Here is AMD's installation guide:

doc/source/architecture.png

10.6 KB
Loading

doc/source/design.rst

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -89,14 +89,8 @@ kernel_tuner.runners.sequential.SimulationRunner
8989
:members:
9090

9191

92-
Device Interfaces
93-
-----------------
94-
95-
kernel_tuner.core.DeviceInterface
96-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
97-
.. autoclass:: kernel_tuner.core.DeviceInterface
98-
:special-members: __init__
99-
:members:
92+
Backends
93+
--------
10094

10195
kernel_tuner.backends.pycuda.PyCudaFunctions
10296
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

kernel_tuner/backends/hip.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -104,6 +104,7 @@ def __init__(self, device=0, iterations=7, compiler_options=None, observers=None
104104

105105
def ready_argument_list(self, arguments):
106106
"""Ready argument list to be passed to the HIP function.
107+
107108
:param arguments: List of arguments to be passed to the HIP function.
108109
The order should match the argument list on the HIP function.
109110
Allowed values are np.ndarray, and/or np.int32, np.float32, and so on.

0 commit comments

Comments
 (0)