Skip to content

Commit

Permalink
steps to update documentation, readme to make documentation, fixed do…
Browse files Browse the repository at this point in the history 
…cumentation
  • Loading branch information
Akhil Kumar committed Jan 27, 2022
1 parent 5825e89 commit a71c010
Show file tree
Hide file tree
Showing 31 changed files with 12,749 additions and 1,570 deletions.
8 changes: 8 additions & 0 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -71,3 +71,11 @@ git submodule update --init --recursive
## Documentation
* Open `docs/build/html/index.html` using Google Chrome

### To regenerate documentation
```
To build docs
apt-install get python-sphinx
pip install sphinx-rtd-theme
cd docs
make html
```
Binary file modified docs/build/doctrees/CUDAKernelProgrammingGuide.doctree
View file
Binary file not shown.
Binary file modified docs/build/doctrees/Framework.doctree
View file
Binary file not shown.
Binary file modified docs/build/doctrees/Introduction.doctree
View file
Binary file not shown.
Binary file modified docs/build/doctrees/NvidiaCUDAModules.doctree
View file
Binary file not shown.
Binary file added docs/build/doctrees/Tutorial_Adding_New_Module.doctree
View file
Binary file not shown.
Binary file modified docs/build/doctrees/environment.pickle
View file
Binary file not shown.
Binary file modified docs/build/doctrees/index.doctree
View file
Binary file not shown.
2 changes: 1 addition & 1 deletion docs/build/html/.buildinfo
View file
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: 477b92312f52d3bdabcd52381d5452f2
config: 4a0f0f42c4756e69b064e8e0bad43745
tags: 645f666f9bcd5a90fca523b33c5a78b7
178 changes: 34 additions & 144 deletions docs/build/html/CUDAKernelProgrammingGuide.html
View file
Original file line number Diff line number Diff line change
@@ -1,90 +1,43 @@


<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<html class="writer-html4" lang="en" >
<head>
<meta charset="utf-8">

<meta name="viewport" content="width=device-width, initial-scale=1.0">

<title>CUDA Kernel Programming Guide &mdash; Apra Pipes v0 documentation</title>



<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/rtd.css" type="text/css" />







<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>CUDA Kernel Programming Guide &mdash; Apra Pipes v0 documentation</title><link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/rtd.css" type="text/css" />
<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->


<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/language_data.js"></script>

<script type="text/javascript" src="_static/js/theme.js"></script>


<script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" src="_static/language_data.js"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="prev" title="NVIDIA CUDA Modules" href="NvidiaCUDAModules.html" />
</head>

<body class="wy-body-for-nav">


<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">

<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >



<a href="index.html" class="icon icon-home" alt="Documentation Home"> Apra Pipes



<a href="index.html" class="icon icon-home"> Apra Pipes
</a>







<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>


</div>


<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">






</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<p class="caption"><span class="caption-text">Contents:</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="Introduction.html">Apra Pipes</a></li>
<li class="toctree-l1"><a class="reference internal" href="Introduction.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="Framework.html">Framework</a></li>
<li class="toctree-l1"><a class="reference internal" href="Tutorial_Adding_New_Module.html">Adding New Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="NvidiaCUDAModules.html">NVIDIA CUDA Modules</a></li>
Expand All @@ -99,69 +52,30 @@
</li>
</ul>



</div>

</div>
</nav>

<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">


<nav class="wy-nav-top" aria-label="top navigation">

<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="index.html">Apra Pipes</a>

</nav>


<div class="wy-nav-content">

<div class="rst-content">

















<div role="navigation" aria-label="breadcrumbs navigation">

<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">

<li><a href="index.html" class="icon icon-home"></a> &raquo;</li>

<li>CUDA Kernel Programming Guide</li>


<li class="wy-breadcrumbs-aside">


<a href="_sources/CUDAKernelProgrammingGuide.rst.txt" rel="nofollow"> View page source</a>


</li>

</ul>


<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">

<div class="section" id="cuda-kernel-programming-guide">
<h1>CUDA Kernel Programming Guide<a class="headerlink" href="#cuda-kernel-programming-guide" title="Permalink to this headline"></a></h1>
<div class="section" id="performance-guide">
Expand All @@ -171,15 +85,15 @@ <h2>Performance Guide<a class="headerlink" href="#performance-guide" title="Perm
<h3>Coalesced Access to Global Memory<a class="headerlink" href="#coalesced-access-to-global-memory" title="Permalink to this headline"></a></h3>
<p><a class="reference external" href="https://docs.nvidia.com/cuda/cuda-c-best-practices-guide/index.html#coalesced-access-to-global-memory">Coalesced Access to Global Memory</a></p>
<ul>
<li><div class="line-block">
<li><div class="first line-block">
<div class="line">Refer OverlayKernel.cu and EffectsKernel.cu</div>
</div>
</li>
<li><div class="line-block">
<li><div class="first line-block">
<div class="line">uchar4 (4 bytes) - 32x32 threads per block - 4x32x32 - 4K bytes</div>
</div>
</li>
<li><div class="line-block">
<li><div class="first line-block">
<div class="line">A big difference - like 2x in Performance</div>
</div>
</li>
Expand All @@ -189,11 +103,11 @@ <h3>Coalesced Access to Global Memory<a class="headerlink" href="#coalesced-acce
<h3>Math Library<a class="headerlink" href="#math-library" title="Permalink to this headline"></a></h3>
<p><a class="reference external" href="https://docs.nvidia.com/cuda/cuda-math-api/index.html">NVIDIA CUDA Math API</a></p>
<ul>
<li><div class="line-block">
<li><div class="first line-block">
<div class="line">multiplication use from here</div>
</div>
</li>
<li><div class="line-block">
<li><div class="first line-block">
<div class="line">big difference</div>
</div>
</li>
Expand All @@ -208,56 +122,32 @@ <h3>__device__ functions<a class="headerlink" href="#device-functions" title="Pe


</div>

</div>
<footer>

<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">


<a href="NvidiaCUDAModules.html" class="btn btn-neutral float-left" title="NVIDIA CUDA Modules" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>

<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="NvidiaCUDAModules.html" class="btn btn-neutral float-left" title="NVIDIA CUDA Modules" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
</div>


<hr/>

<div role="contentinfo">
<p>

&copy; Copyright 2020, Apra Labs

</p>
<p>&#169; Copyright 2020-2022, Apra Labs.</p>
</div>



Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a

<a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a>

provided by <a href="https://readthedocs.org">Read the Docs</a>.

</footer>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.


</footer>
</div>
</div>

</section>

</div>


<script type="text/javascript">
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>





</script>

</body>
</html>
Loading

0 comments on commit a71c010

Please sign in to comment.