You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.rst
+5-1Lines changed: 5 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -100,21 +100,25 @@ Steps without :bash:`sudo` access (e.g. on a cluster):
100
100
* If you used Venv in step 2, to :bash:`venv`.
101
101
* If you used Virtualenv in step 2, this is already the default.
102
102
* Be sure to adjust this when changing backends.
103
-
* The settings file also has :bash:`envdir`, which allows you to `change the directory Nox caches environments in<https://nox.thea.codes/en/stable/usage.html#opt-envdir>`_, particularly helpful if you have a diskquota on your user directory.
103
+
* The settings file also has :bash:`envdir`, which allows you to `change the directory Nox caches environments in<https://nox.thea.codes/en/stable/usage.html#opt-envdir>`_, particularly helpful if you have a diskquota on your user directory.
104
104
#. [Optional] Run the tests on Nox as described below.
105
105
106
106
107
107
Running tests
108
108
-------------
109
109
To run the tests you can use :bash:`nox` (to run against all supported Python versions in isolated environments) and :bash:`pytest` (to run against the local Python version, see below) in the top-level directory.
110
110
For full coverage, make Nox use the additional tests (such as cupy and cuda-python) with :bash:`nox -- additional-tests`.
111
+
111
112
The Nox isolated environments can take up to 1 gigabyte in size, so users tight on diskspace can run :bash:`nox` with the :bash:`small-disk` option. This removes the other environment caches before each session is ran (note that this will take longer to run). A better option would be to change the location environments are stored in with :bash:`envdir` in the :bash:`noxsettings.toml` file.
113
+
112
114
Please note that the command-line options can be combined, e.g. :bash:`nox -- additional-tests skip-hip small-disk`.
113
115
If you do not have fully compatible hardware or environment, you can use the following options:
116
+
114
117
* :bash:`nox -- skip-cuda` to skip tests involving CUDA.
115
118
* :bash:`nox -- skip-hip` to skip tests involving HIP.
116
119
* :bash:`nox -- skip-opencl` to skip tests involving OpenCL.
117
120
* :bash:`nox -- skip-gpu` to skip all tests on the GPU (the same as :bash:`nox -- skip-cuda skip-hip skip-opencl`), especially helpful if you don't have a GPU locally.
121
+
118
122
Contributions you make to the Kernel Tuner should not break any of the tests even if you cannot run them locally!
119
123
120
124
Running with :bash:`pytest` will test against your local Python version and PIP packages.
0 commit comments