Skip to content

Commit a4f05c1

Browse files
authored
v0.9.1 release (#46)
[Bug Fix] Updated version numbers of the cudnn frontend release. [Update] Updated the documentation to reflect latest version numbers. [Update] Readme updated with cmake build instructions. [Samples] Added a new Batch Norm sample forward and backward example. [Acknowledgments] Thanks to @malfet for pointing out the [version number mismatch.](#45)
1 parent e7f6439 commit a4f05c1

21 files changed

+1602
-2571
lines changed

CMakeLists.txt

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
cmake_minimum_required(VERSION 3.17)
22

3-
project(cudnn_frontend VERSION 0.8)
3+
project(cudnn_frontend VERSION 0.9)
4+
5+
option(CUDNN_FRONTEND_BUILD_SAMPLES "Defines if samples are built or not." ON)
46

57
add_library(cudnn_frontend INTERFACE)
68

@@ -12,4 +14,6 @@ target_include_directories(
1214

1315
target_compile_features(cudnn_frontend INTERFACE cxx_std_11)
1416

17+
if (${CUDNN_FRONTEND_BUILD_SAMPLES})
1518
add_subdirectory(samples)
19+
endif()

Doxyfile

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,13 +32,13 @@ DOXYFILE_ENCODING = UTF-8
3232
# title of most generated pages and in a few other places.
3333
# The default value is: My Project.
3434

35-
PROJECT_NAME = "CUDNN API"
35+
PROJECT_NAME = "CUDNN Frontend API"
3636

3737
# The PROJECT_NUMBER tag can be used to enter a project or revision number. This
3838
# could be handy for archiving the generated documentation or if some version
3939
# control system is used.
4040

41-
PROJECT_NUMBER = 8.0.0
41+
PROJECT_NUMBER = 0.9.1
4242

4343
# Using the PROJECT_BRIEF tag one can provide an optional one line description
4444
# for a project that appears at the top of each page and should give viewer a

README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,10 +56,14 @@ Sample tests are written using the [Catch2](https://github.com/catchorg/Catch2)
5656
- Headers are in CUDNN_PATH/include
5757
- Libraries are in CUDNN_PATH/lib or CUDNN_PATH/lib64 or CUDNN_PATH/lib/x64
5858

59+
From Project Root,
60+
5961
mkdir build; cd build
6062
cmake -DCUDNN_PATH=/path/to/cudnn -DCUDAToolkit_ROOT=/path/to/cuda ../
6163
cmake --build . -j16
6264
bin/samples
65+
66+
- You can skip building samples by providing CUDNN_FRONTEND_BUILD_SAMPLES=0 to the cmake.
6367

6468
## cudnnFindPlan and cudnnGetPlan:
6569
Prior to cuDNN V8, cuDNN provided `cudnnFindConvolution*` and `cudnnGetConvolution*` functions, which provided a way to sample all the algorithms for a given problem and study the run times. This can be further used to cache the best algorithms for a given problem. In cuDNN V8, this has been replaced with `cudnnFindPlan` and `cudnnGetPlan`.
@@ -129,6 +133,9 @@ Calling `cudnn_frontend::getStream() = stream_name` can be used to assign the ou
129133
## Documentation
130134
Documentation can be found at https://nvidia.github.io/cudnn-frontend/
131135

136+
## Contributing:
137+
At this point we are not accepting any external PRs. Please create an issue in github and we will get to it.
138+
132139
## Feedback
133140
Support, resources, and information about cuDNN can be found online at https://developer.nvidia.com/cudnn.
134141

docs/html/dynsections.js

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -95,3 +95,10 @@ function toggleInherit(id)
9595
}
9696
}
9797

98+
99+
$(document).ready(function() {
100+
$('.code,.codeRef').each(function() {
101+
$(this).data('powertip',$('#'+$(this).attr('href').replace(/.*\//,'').replace(/[^a-z_A-Z0-9]/g,'_')).html());
102+
$(this).powerTip({ placement: 's', smartPlacement: true, mouseOnToPopup: true });
103+
});
104+
});

docs/html/graph_legend.html

Lines changed: 32 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,17 @@
55
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
66
<meta name="generator" content="Doxygen 1.8.13"/>
77
<meta name="viewport" content="width=device-width, initial-scale=1"/>
8-
<title>My Project: Graph Legend</title>
8+
<title>CUDNN Frontend API: Graph Legend</title>
99
<link href="tabs.css" rel="stylesheet" type="text/css"/>
1010
<script type="text/javascript" src="jquery.js"></script>
1111
<script type="text/javascript" src="dynsections.js"></script>
12+
<link href="navtree.css" rel="stylesheet" type="text/css"/>
13+
<script type="text/javascript" src="resize.js"></script>
14+
<script type="text/javascript" src="navtreedata.js"></script>
15+
<script type="text/javascript" src="navtree.js"></script>
16+
<script type="text/javascript">
17+
$(document).ready(initResizable);
18+
</script>
1219
<link href="search/search.css" rel="stylesheet" type="text/css"/>
1320
<script type="text/javascript" src="search/searchdata.js"></script>
1421
<script type="text/javascript" src="search/search.js"></script>
@@ -21,7 +28,8 @@
2128
<tbody>
2229
<tr style="height: 56px;">
2330
<td id="projectalign" style="padding-left: 0.5em;">
24-
<div id="projectname">My Project
31+
<div id="projectname">CUDNN Frontend API
32+
&#160;<span id="projectnumber">0.9.1</span>
2533
</div>
2634
</td>
2735
</tr>
@@ -43,6 +51,20 @@
4351
</script>
4452
<div id="main-nav"></div>
4553
</div><!-- top -->
54+
<div id="side-nav" class="ui-resizable side-nav-resizable">
55+
<div id="nav-tree">
56+
<div id="nav-tree-contents">
57+
<div id="nav-sync" class="sync"></div>
58+
</div>
59+
</div>
60+
<div id="splitbar" style="-moz-user-select:none;"
61+
class="ui-resizable-handle">
62+
</div>
63+
</div>
64+
<script type="text/javascript">
65+
$(document).ready(function(){initNavTree('graph_legend.html','');});
66+
</script>
67+
<div id="doc-content">
4668
<!-- window showing the filter options -->
4769
<div id="MSearchSelectWindow"
4870
onmouseover="return searchBox.OnSearchSelectShow()"
@@ -92,11 +114,14 @@
92114
A yellow dashed arrow denotes a relation between a template instance and the template class it was instantiated from. The arrow is labelled with the template parameters of the instance. </li>
93115
</ul>
94116
</div><!-- contents -->
117+
</div><!-- doc-content -->
95118
<!-- start footer part -->
96-
<hr class="footer"/><address class="footer"><small>
97-
Generated by &#160;<a href="http://www.doxygen.org/index.html">
98-
<img class="footer" src="doxygen.png" alt="doxygen"/>
99-
</a> 1.8.13
100-
</small></address>
119+
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
120+
<ul>
121+
<li class="footer">Generated by
122+
<a href="http://www.doxygen.org/index.html">
123+
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
124+
</ul>
125+
</div>
101126
</body>
102127
</html>

docs/html/index.html

Lines changed: 33 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,17 @@
55
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
66
<meta name="generator" content="Doxygen 1.8.13"/>
77
<meta name="viewport" content="width=device-width, initial-scale=1"/>
8-
<title>My Project: Main Page</title>
8+
<title>CUDNN Frontend API: Main Page</title>
99
<link href="tabs.css" rel="stylesheet" type="text/css"/>
1010
<script type="text/javascript" src="jquery.js"></script>
1111
<script type="text/javascript" src="dynsections.js"></script>
12+
<link href="navtree.css" rel="stylesheet" type="text/css"/>
13+
<script type="text/javascript" src="resize.js"></script>
14+
<script type="text/javascript" src="navtreedata.js"></script>
15+
<script type="text/javascript" src="navtree.js"></script>
16+
<script type="text/javascript">
17+
$(document).ready(initResizable);
18+
</script>
1219
<link href="search/search.css" rel="stylesheet" type="text/css"/>
1320
<script type="text/javascript" src="search/searchdata.js"></script>
1421
<script type="text/javascript" src="search/search.js"></script>
@@ -21,7 +28,8 @@
2128
<tbody>
2229
<tr style="height: 56px;">
2330
<td id="projectalign" style="padding-left: 0.5em;">
24-
<div id="projectname">My Project
31+
<div id="projectname">CUDNN Frontend API
32+
&#160;<span id="projectnumber">0.9.1</span>
2533
</div>
2634
</td>
2735
</tr>
@@ -43,6 +51,20 @@
4351
</script>
4452
<div id="main-nav"></div>
4553
</div><!-- top -->
54+
<div id="side-nav" class="ui-resizable side-nav-resizable">
55+
<div id="nav-tree">
56+
<div id="nav-tree-contents">
57+
<div id="nav-sync" class="sync"></div>
58+
</div>
59+
</div>
60+
<div id="splitbar" style="-moz-user-select:none;"
61+
class="ui-resizable-handle">
62+
</div>
63+
</div>
64+
<script type="text/javascript">
65+
$(document).ready(function(){initNavTree('index.html','');});
66+
</script>
67+
<div id="doc-content">
4668
<!-- window showing the filter options -->
4769
<div id="MSearchSelectWindow"
4870
onmouseover="return searchBox.OnSearchSelectShow()"
@@ -59,15 +81,18 @@
5981

6082
<div class="header">
6183
<div class="headertitle">
62-
<div class="title">My Project Documentation</div> </div>
84+
<div class="title">CUDNN Frontend API Documentation</div> </div>
6385
</div><!--header-->
6486
<div class="contents">
6587
</div><!-- contents -->
88+
</div><!-- doc-content -->
6689
<!-- start footer part -->
67-
<hr class="footer"/><address class="footer"><small>
68-
Generated by &#160;<a href="http://www.doxygen.org/index.html">
69-
<img class="footer" src="doxygen.png" alt="doxygen"/>
70-
</a> 1.8.13
71-
</small></address>
90+
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
91+
<ul>
92+
<li class="footer">Generated by
93+
<a href="http://www.doxygen.org/index.html">
94+
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
95+
</ul>
96+
</div>
7297
</body>
7398
</html>

docs/html/navtree.css

Lines changed: 146 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,146 @@
1+
#nav-tree .children_ul {
2+
margin:0;
3+
padding:4px;
4+
}
5+
6+
#nav-tree ul {
7+
list-style:none outside none;
8+
margin:0px;
9+
padding:0px;
10+
}
11+
12+
#nav-tree li {
13+
white-space:nowrap;
14+
margin:0px;
15+
padding:0px;
16+
}
17+
18+
#nav-tree .plus {
19+
margin:0px;
20+
}
21+
22+
#nav-tree .selected {
23+
background-image: url('tab_a.png');
24+
background-repeat:repeat-x;
25+
color: #fff;
26+
text-shadow: 0px 1px 1px rgba(0, 0, 0, 1.0);
27+
}
28+
29+
#nav-tree img {
30+
margin:0px;
31+
padding:0px;
32+
border:0px;
33+
vertical-align: middle;
34+
}
35+
36+
#nav-tree a {
37+
text-decoration:none;
38+
padding:0px;
39+
margin:0px;
40+
outline:none;
41+
}
42+
43+
#nav-tree .label {
44+
margin:0px;
45+
padding:0px;
46+
font: 12px 'Lucida Grande',Geneva,Helvetica,Arial,sans-serif;
47+
}
48+
49+
#nav-tree .label a {
50+
padding:2px;
51+
}
52+
53+
#nav-tree .selected a {
54+
text-decoration:none;
55+
color:#fff;
56+
}
57+
58+
#nav-tree .children_ul {
59+
margin:0px;
60+
padding:0px;
61+
}
62+
63+
#nav-tree .item {
64+
margin:0px;
65+
padding:0px;
66+
}
67+
68+
#nav-tree {
69+
padding: 0px 0px;
70+
background-color: #FAFAFF;
71+
font-size:14px;
72+
overflow:auto;
73+
}
74+
75+
#doc-content {
76+
overflow:auto;
77+
display:block;
78+
padding:0px;
79+
margin:0px;
80+
-webkit-overflow-scrolling : touch; /* iOS 5+ */
81+
}
82+
83+
#side-nav {
84+
padding:0 6px 0 0;
85+
margin: 0px;
86+
display:block;
87+
position: absolute;
88+
left: 0px;
89+
width: 250px;
90+
}
91+
92+
.ui-resizable .ui-resizable-handle {
93+
display:block;
94+
}
95+
96+
.ui-resizable-e {
97+
background-image:url("splitbar.png");
98+
background-size:100%;
99+
background-repeat:no-repeat;
100+
background-attachment: scroll;
101+
cursor:ew-resize;
102+
height:100%;
103+
right:0;
104+
top:0;
105+
width:6px;
106+
}
107+
108+
.ui-resizable-handle {
109+
display:none;
110+
font-size:0.1px;
111+
position:absolute;
112+
z-index:1;
113+
}
114+
115+
#nav-tree-contents {
116+
margin: 6px 0px 0px 0px;
117+
}
118+
119+
#nav-tree {
120+
background-image:url('nav_h.png');
121+
background-repeat:repeat-x;
122+
background-color: #F9FAFC;
123+
-webkit-overflow-scrolling : touch; /* iOS 5+ */
124+
}
125+
126+
#nav-sync {
127+
position:absolute;
128+
top:5px;
129+
right:24px;
130+
z-index:0;
131+
}
132+
133+
#nav-sync img {
134+
opacity:0.3;
135+
}
136+
137+
#nav-sync img:hover {
138+
opacity:0.9;
139+
}
140+
141+
@media print
142+
{
143+
#nav-tree { display: none; }
144+
div.ui-resizable-handle { display: none; position: relative; }
145+
}
146+

0 commit comments

Comments
 (0)