Skip to content

Commit

Permalink
Add changes for 4ff2fb8
Browse files Browse the repository at this point in the history
  • Loading branch information
actions-user committed Oct 4, 2023
1 parent 22ff549 commit 3deb48c
Show file tree
Hide file tree
Showing 31 changed files with 116 additions and 118 deletions.
2 changes: 1 addition & 1 deletion latest/.buildinfo
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: 741ac9b96a79260a1482b8ea2f1100b0
config: 67d9c95c93c4646ed46a56a7665573a8
tags: 645f666f9bcd5a90fca523b33c5a78b7
3 changes: 0 additions & 3 deletions latest/_sources/contributing.rst.txt
Original file line number Diff line number Diff line change
@@ -1,8 +1,5 @@
.. toctree::
:maxdepth: 2

.. _contributing:


.. include:: ../../CONTRIBUTING.rst

1 change: 1 addition & 0 deletions latest/_sources/design.rst.txt
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
.. toctree::
:maxdepth: 2

.. _design documentation:

Design documentation
====================
Expand Down
8 changes: 4 additions & 4 deletions latest/cache_files.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Cache files &mdash; python-constraint 1.0.0b1 documentation</title>
<title>Cache files &mdash; Kernel Tuner 1.0.0b1 documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<!--[if lt IE 9]>
Expand All @@ -31,7 +31,7 @@


<a href="contents.html" class="icon icon-home">
python-constraint
Kernel Tuner
</a>
<div class="version">
1.0.0b1
Expand Down Expand Up @@ -82,7 +82,7 @@

<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="contents.html">python-constraint</a>
<a href="contents.html">Kernel Tuner</a>
</nav>

<div class="wy-nav-content">
Expand Down Expand Up @@ -124,7 +124,7 @@
<hr/>

<div role="contentinfo">
<p>&#169; Copyright 2016-2023, Ben van Werkhoven.</p>
<p>&#169; Copyright 2016-2023, Ben van Werkhoven, Alessio Sclocco, Stijn Heldens, Floris-Jan Willemsen, Willem-Jan Palenstijn, Bram Veenboer and Richard Schoonhoven.</p>
</div>

Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
Expand Down
8 changes: 4 additions & 4 deletions latest/contents.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>The Kernel Tuner documentation &mdash; python-constraint 1.0.0b1 documentation</title>
<title>The Kernel Tuner documentation &mdash; Kernel Tuner 1.0.0b1 documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<!--[if lt IE 9]>
Expand All @@ -30,7 +30,7 @@


<a href="#" class="icon icon-home">
python-constraint
Kernel Tuner
</a>
<div class="version">
1.0.0b1
Expand Down Expand Up @@ -81,7 +81,7 @@

<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="#">python-constraint</a>
<a href="#">Kernel Tuner</a>
</nav>

<div class="wy-nav-content">
Expand Down Expand Up @@ -152,7 +152,7 @@ <h1>The Kernel Tuner documentation<a class="headerlink" href="#the-kernel-tuner-
<hr/>

<div role="contentinfo">
<p>&#169; Copyright 2016-2023, Ben van Werkhoven.</p>
<p>&#169; Copyright 2016-2023, Ben van Werkhoven, Alessio Sclocco, Stijn Heldens, Floris-Jan Willemsen, Willem-Jan Palenstijn, Bram Veenboer and Richard Schoonhoven.</p>
</div>

Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
Expand Down
16 changes: 8 additions & 8 deletions latest/contributing.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Contribution guide &mdash; python-constraint 1.0.0b1 documentation</title>
<title>Contribution guide &mdash; Kernel Tuner 1.0.0b1 documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<!--[if lt IE 9]>
Expand All @@ -30,7 +30,7 @@


<a href="contents.html" class="icon icon-home">
python-constraint
Kernel Tuner
</a>
<div class="version">
1.0.0b1
Expand Down Expand Up @@ -92,7 +92,7 @@

<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="contents.html">python-constraint</a>
<a href="contents.html">Kernel Tuner</a>
</nav>

<div class="wy-nav-content">
Expand Down Expand Up @@ -138,10 +138,10 @@ <h2>Contributing Code<a class="headerlink" href="#contributing-code" title="Perm
<li><p>Any matching entries in the roadmap.md are updated/removed</p></li>
</ul>
<p>If you are in doubt on where to put your additions to the Kernel Tuner, please
have look at the <a class="reference external" href="https://kerneltuner.github.io/kernel_tuner/stable/design.html">design documentation</a>, or discuss it in the issue regarding your additions.</p>
have look at the <a class="reference internal" href="design.html#design-documentation"><span class="std std-ref">design documentation</span></a>, or discuss it in the issue regarding your additions.</p>
</section>
<section id="development-environment">
<h2>Development environment<a class="headerlink" href="#development-environment" title="Permalink to this heading"></a></h2>
<span id="id1"></span><h2>Development environment<a class="headerlink" href="#development-environment" title="Permalink to this heading"></a></h2>
<p>The following steps help you set up a development environment.</p>
<section id="local-setup">
<h3>Local setup<a class="headerlink" href="#local-setup" title="Permalink to this heading"></a></h3>
Expand All @@ -158,7 +158,7 @@ <h3>Local setup<a class="headerlink" href="#local-setup" title="Permalink to thi
<li><p>Install the required Python versions: <code class="code highlight bash docutils literal highlight-bash">pyenv<span class="w"> </span>install<span class="w"> </span><span class="m">3</span>.8<span class="w"> </span><span class="m">3</span>.9<span class="w"> </span><span class="m">3</span>.10<span class="w"> </span><span class="m">3</span>.11</code>.</p></li>
<li><p>Set the Python versions so they can be found: <code class="code highlight bash docutils literal highlight-bash">pyenv<span class="w"> </span>global<span class="w"> </span><span class="m">3</span>.8<span class="w"> </span><span class="m">3</span>.10<span class="w"> </span><span class="m">3</span>.11</code> (replace <code class="code highlight bash docutils literal highlight-bash">global</code> with <code class="code highlight bash docutils literal highlight-bash"><span class="nb">local</span></code> when using the virtualenv).</p></li>
<li><p><a class="reference external" href="https://python-poetry.org/docs/#installing-with-the-official-installer">Install Poetry</a>: <code class="code highlight bash docutils literal highlight-bash">curl<span class="w"> </span>-sSL<span class="w"> </span>https://install.python-poetry.org<span class="w"> </span><span class="p">|</span><span class="w"> </span>python3<span class="w"> </span>-</code>.</p></li>
<li><p>Make sure that non-Python dependencies are installed if applicable, such as CUDA, OpenCL or HIP. This is described in <a class="reference external" href="https://kerneltuner.github.io/kernel_tuner/stable/install.html">Installation</a>.</p></li>
<li><p>Make sure that non-Python dependencies are installed if applicable, such as CUDA, OpenCL or HIP. This is described in <a class="reference internal" href="install.html#installation"><span class="std std-ref">Installation</span></a>.</p></li>
<li><dl class="simple">
<dt>Install the project, dependencies and extras: <code class="code highlight bash docutils literal highlight-bash">poetry<span class="w"> </span>install<span class="w"> </span>--with<span class="w"> </span>test,docs<span class="w"> </span>-E<span class="w"> </span>cuda<span class="w"> </span>-E<span class="w"> </span>opencl<span class="w"> </span>-E<span class="w"> </span>hip</code>, leaving out <code class="code highlight bash docutils literal highlight-bash">-E<span class="w"> </span>cuda</code>, <code class="code highlight bash docutils literal highlight-bash">-E<span class="w"> </span>opencl</code> or <code class="code highlight bash docutils literal highlight-bash">-E<span class="w"> </span>hip</code> if this does not apply on your system. To go all-out, use <code class="code highlight bash docutils literal highlight-bash">--all-extras</code></dt><dd><ul class="simple">
<li><p>Depending on the environment, it may be necessary or convenient to install extra packages such as <code class="code highlight bash docutils literal highlight-bash">cupy-cuda11x</code> / <code class="code highlight bash docutils literal highlight-bash">cupy-cuda12x</code>, and <code class="code highlight bash docutils literal highlight-bash">cuda-python</code>. These are currently not defined as dependencies for kernel-tuner, but can be part of tests.</p></li>
Expand Down Expand Up @@ -188,7 +188,7 @@ <h3>Cluster setup<a class="headerlink" href="#cluster-setup" title="Permalink to
<li><dl class="simple">
<dt>Activate the virtual environment: <code class="code highlight bash docutils literal highlight-bash">conda<span class="w"> </span>activate<span class="w"> </span>kerneltuner</code>.</dt><dd><ul class="simple">
<li><p>[Optional] to use the correct environment by default, execute <code class="code highlight bash docutils literal highlight-bash">conda<span class="w"> </span>config<span class="w"> </span>--set<span class="w"> </span>auto_activate_base<span class="w"> </span><span class="nb">false</span></code>, and add <cite>conda activate kerneltuner</cite> to your <code class="code highlight bash docutils literal highlight-bash">.bash_profile</code> or <code class="code highlight bash docutils literal highlight-bash">.bashrc</code>.</p></li>
<li><p>Make sure that non-Python dependencies are loaded if applicable, such as CUDA, OpenCL or HIP. On most clusters it is possible to load (or unload) modules (e.g. CUDA, OpenCL / ROCM). For more information, see <a class="reference external" href="https://kerneltuner.github.io/kernel_tuner/stable/install.html">Installation</a>.</p></li>
<li><p>Make sure that non-Python dependencies are loaded if applicable, such as CUDA, OpenCL or HIP. On most clusters it is possible to load (or unload) modules (e.g. CUDA, OpenCL / ROCM). For more information, see <a class="reference internal" href="install.html#installation"><span class="std std-ref">Installation</span></a>.</p></li>
<li><p>Do not forget to make sure the paths are set correctly. If you’re using CUDA, the desired CUDA version should be in <code class="code highlight bash docutils literal highlight-bash"><span class="nv">$PATH</span></code>, <code class="code highlight bash docutils literal highlight-bash"><span class="nv">$LD_LIBARY_PATH</span></code> and <code class="code highlight bash docutils literal highlight-bash"><span class="nv">$CPATH</span></code>.</p></li>
<li><p>[Optional] the loading of modules and setting of paths is likely convenient to put in your <code class="code highlight bash docutils literal highlight-bash">.bash_profile</code> or <code class="code highlight bash docutils literal highlight-bash">.bashrc</code>.</p></li>
</ul>
Expand Down Expand Up @@ -260,7 +260,7 @@ <h2>Building documentation<a class="headerlink" href="#building-documentation" t
<hr/>

<div role="contentinfo">
<p>&#169; Copyright 2016-2023, Ben van Werkhoven.</p>
<p>&#169; Copyright 2016-2023, Ben van Werkhoven, Alessio Sclocco, Stijn Heldens, Floris-Jan Willemsen, Willem-Jan Palenstijn, Bram Veenboer and Richard Schoonhoven.</p>
</div>

Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
Expand Down
8 changes: 4 additions & 4 deletions latest/convolution.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Convolution &mdash; python-constraint 1.0.0b1 documentation</title>
<title>Convolution &mdash; Kernel Tuner 1.0.0b1 documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/nbsphinx-code-cells.css" type="text/css" />
Expand Down Expand Up @@ -34,7 +34,7 @@


<a href="contents.html" class="icon icon-home">
python-constraint
Kernel Tuner
</a>
<div class="version">
1.0.0b1
Expand Down Expand Up @@ -91,7 +91,7 @@

<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="contents.html">python-constraint</a>
<a href="contents.html">Kernel Tuner</a>
</nav>

<div class="wy-nav-content">
Expand Down Expand Up @@ -380,7 +380,7 @@ <h2>More tunable parameters<a class="headerlink" href="#More-tunable-parameters"
<hr/>

<div role="contentinfo">
<p>&#169; Copyright 2016-2023, Ben van Werkhoven.</p>
<p>&#169; Copyright 2016-2023, Ben van Werkhoven, Alessio Sclocco, Stijn Heldens, Floris-Jan Willemsen, Willem-Jan Palenstijn, Bram Veenboer and Richard Schoonhoven.</p>
</div>

Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
Expand Down
8 changes: 4 additions & 4 deletions latest/correctness.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Correctness Verification &mdash; python-constraint 1.0.0b1 documentation</title>
<title>Correctness Verification &mdash; Kernel Tuner 1.0.0b1 documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<!--[if lt IE 9]>
Expand All @@ -31,7 +31,7 @@


<a href="contents.html" class="icon icon-home">
python-constraint
Kernel Tuner
</a>
<div class="version">
1.0.0b1
Expand Down Expand Up @@ -82,7 +82,7 @@

<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="contents.html">python-constraint</a>
<a href="contents.html">Kernel Tuner</a>
</nav>

<div class="wy-nav-content">
Expand Down Expand Up @@ -214,7 +214,7 @@ <h1>Correctness Verification<a class="headerlink" href="#correctness-verificatio
<hr/>

<div role="contentinfo">
<p>&#169; Copyright 2016-2023, Ben van Werkhoven.</p>
<p>&#169; Copyright 2016-2023, Ben van Werkhoven, Alessio Sclocco, Stijn Heldens, Floris-Jan Willemsen, Willem-Jan Palenstijn, Bram Veenboer and Richard Schoonhoven.</p>
</div>

Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
Expand Down
10 changes: 5 additions & 5 deletions latest/design.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Design documentation &mdash; python-constraint 1.0.0b1 documentation</title>
<title>Design documentation &mdash; Kernel Tuner 1.0.0b1 documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<!--[if lt IE 9]>
Expand All @@ -31,7 +31,7 @@


<a href="contents.html" class="icon icon-home">
python-constraint
Kernel Tuner
</a>
<div class="version">
1.0.0b1
Expand Down Expand Up @@ -187,7 +187,7 @@

<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="contents.html">python-constraint</a>
<a href="contents.html">Kernel Tuner</a>
</nav>

<div class="wy-nav-content">
Expand All @@ -208,7 +208,7 @@
<div class="toctree-wrapper compound">
</div>
<section id="design-documentation">
<h1>Design documentation<a class="headerlink" href="#design-documentation" title="Permalink to this heading"></a></h1>
<span id="id1"></span><h1>Design documentation<a class="headerlink" href="#design-documentation" title="Permalink to this heading"></a></h1>
<p>This section provides detailed information about the design and internals
of the Kernel Tuner. <strong>This information is mostly relevant for developers.</strong></p>
<p>The Kernel Tuner is designed to be extensible and support
Expand Down Expand Up @@ -1848,7 +1848,7 @@ <h2>Util Functions<a class="headerlink" href="#util-functions" title="Permalink
<hr/>

<div role="contentinfo">
<p>&#169; Copyright 2016-2023, Ben van Werkhoven.</p>
<p>&#169; Copyright 2016-2023, Ben van Werkhoven, Alessio Sclocco, Stijn Heldens, Floris-Jan Willemsen, Willem-Jan Palenstijn, Bram Veenboer and Richard Schoonhoven.</p>
</div>

Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
Expand Down
8 changes: 4 additions & 4 deletions latest/diffusion.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Diffusion &mdash; python-constraint 1.0.0b1 documentation</title>
<title>Diffusion &mdash; Kernel Tuner 1.0.0b1 documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/nbsphinx-code-cells.css" type="text/css" />
Expand Down Expand Up @@ -34,7 +34,7 @@


<a href="contents.html" class="icon icon-home">
python-constraint
Kernel Tuner
</a>
<div class="version">
1.0.0b1
Expand Down Expand Up @@ -94,7 +94,7 @@

<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="contents.html">python-constraint</a>
<a href="contents.html">Kernel Tuner</a>
</nav>

<div class="wy-nav-content">
Expand Down Expand Up @@ -908,7 +908,7 @@ <h2>Storing the results<a class="headerlink" href="#Storing-the-results" title="
<hr/>

<div role="contentinfo">
<p>&#169; Copyright 2016-2023, Ben van Werkhoven.</p>
<p>&#169; Copyright 2016-2023, Ben van Werkhoven, Alessio Sclocco, Stijn Heldens, Floris-Jan Willemsen, Willem-Jan Palenstijn, Bram Veenboer and Richard Schoonhoven.</p>
</div>

Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
Expand Down
Loading

0 comments on commit 3deb48c

Please sign in to comment.