Skip to content

Commit 7a0216b

Browse files
MgepahmgeMgepahmge
committed
Update doc
1 parent 1781f91 commit 7a0216b

159 files changed

Lines changed: 7557 additions & 0 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎docs/html/_model_8cu_source.html‎

Lines changed: 543 additions & 0 deletions
Large diffs are not rendered by default.

‎docs/html/_model_8cuh.html‎

Lines changed: 167 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,167 @@
1+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2+
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
3+
<head>
4+
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5+
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
6+
<meta name="generator" content="Doxygen 1.12.0"/>
7+
<meta name="viewport" content="width=device-width, initial-scale=1"/>
8+
<title>NeuZephyr: D:/Users/Mgepahmge/Documents/C Program/NeuZephyr/include/NeuZephyr/Model.cuh File Reference</title>
9+
<link rel="icon" href="NZ_logo2.png" type="image/x-icon" />
10+
<link href="tabs.css" rel="stylesheet" type="text/css"/>
11+
<script type="text/javascript" src="jquery.js"></script>
12+
<script type="text/javascript" src="dynsections.js"></script>
13+
<link href="navtree.css" rel="stylesheet" type="text/css"/>
14+
<script type="text/javascript" src="resize.js"></script>
15+
<link href="doxygen.css" rel="stylesheet" type="text/css" />
16+
</head>
17+
<body>
18+
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
19+
<div id="titlearea">
20+
<table cellspacing="0" cellpadding="0">
21+
<tbody>
22+
<tr id="projectrow">
23+
<td id="projectlogo"><img alt="Logo" src="NZ_logo2.png"/></td>
24+
<td id="projectalign">
25+
<div id="projectname">NeuZephyr
26+
</div>
27+
<div id="projectbrief">Simple DL Framework</div>
28+
</td>
29+
</tr>
30+
</tbody>
31+
</table>
32+
</div>
33+
<!-- end header part -->
34+
<!-- Generated by Doxygen 1.12.0 -->
35+
<script type="text/javascript">
36+
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
37+
$(function() { codefold.init(0); });
38+
/* @license-end */
39+
</script>
40+
<div id="navrow1" class="tabs">
41+
<ul class="tablist">
42+
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
43+
<li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
44+
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
45+
<li><a href="annotated.html"><span>Classes</span></a></li>
46+
<li class="current"><a href="files.html"><span>Files</span></a></li>
47+
</ul>
48+
</div>
49+
<div id="navrow2" class="tabs2">
50+
<ul class="tablist">
51+
<li><a href="files.html"><span>File&#160;List</span></a></li>
52+
</ul>
53+
</div>
54+
<script type="text/javascript">
55+
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
56+
$(function(){ initResizable(false); });
57+
/* @license-end */
58+
</script>
59+
<div id="nav-path" class="navpath">
60+
<ul>
61+
<li class="navelem"><a class="el" href="dir_d522931ffa1371640980b621734a4381.html">Users</a></li><li class="navelem"><a class="el" href="dir_a7e6ee1ae3f772c9504a0b543f2027e2.html">Mgepahmge</a></li><li class="navelem"><a class="el" href="dir_e03f57e346cc4845a4c354a35630b169.html">Documents</a></li><li class="navelem"><a class="el" href="dir_231a0482af2b83c895f27ba7fe745141.html">C Program</a></li><li class="navelem"><a class="el" href="dir_0fa7fc3a0dfd304dbfc9dce9f6facfa2.html">NeuZephyr</a></li><li class="navelem"><a class="el" href="dir_e7295b03dab2e9cdf32139bd8ec2e607.html">include</a></li><li class="navelem"><a class="el" href="dir_657344ecc65cfc28732701509f8d8421.html">NeuZephyr</a></li> </ul>
62+
</div>
63+
</div><!-- top -->
64+
<div id="doc-content">
65+
<div class="header">
66+
<div class="summary">
67+
<a href="#nested-classes">Classes</a> </div>
68+
<div class="headertitle"><div class="title">Model.cuh File Reference</div></div>
69+
</div><!--header-->
70+
<div class="contents">
71+
72+
<p>Core class for computational graph construction and neural network modeling.
73+
<a href="#details">More...</a></p>
74+
<div class="textblock"><code>#include &quot;<a class="el" href="_compute_graph_8cuh_source.html">ComputeGraph.cuh</a>&quot;</code><br />
75+
</div><div class="textblock"><div class="dynheader">
76+
Include dependency graph for Model.cuh:</div>
77+
<div class="dyncontent">
78+
<div class="center"><img src="_model_8cuh__incl.png" border="0" usemap="#a_d_1_2_users_2_mgepahmge_2_documents_2_c_01_program_2_neu_zephyr_2include_2_neu_zephyr_2_model_8cuh" alt=""/></div>
79+
<map name="a_d_1_2_users_2_mgepahmge_2_documents_2_c_01_program_2_neu_zephyr_2include_2_neu_zephyr_2_model_8cuh" id="a_d_1_2_users_2_mgepahmge_2_documents_2_c_01_program_2_neu_zephyr_2include_2_neu_zephyr_2_model_8cuh">
80+
<area shape="rect" title="Core class for computational graph construction and neural network modeling." alt="" coords="75,5,277,80"/>
81+
<area shape="rect" href="_compute_graph_8cuh.html" title="Defines the ComputeGraph class for constructing and managing computational graphs in neural network m..." alt="" coords="109,128,243,155"/>
82+
<area shape="poly" title=" " alt="" coords="179,80,179,112,173,112,173,80"/>
83+
<area shape="rect" title=" " alt="" coords="5,203,59,229"/>
84+
<area shape="poly" title=" " alt="" coords="152,158,72,198,70,193,150,153"/>
85+
<area shape="rect" title=" " alt="" coords="82,203,139,229"/>
86+
<area shape="poly" title=" " alt="" coords="167,157,134,193,130,189,163,153"/>
87+
<area shape="rect" href="_operation_kernels_8cuh.html" title="CUDA Kernel Definitions for High&#45;Performance Tensor Operations." alt="" coords="71,352,217,379"/>
88+
<area shape="poly" title=" " alt="" coords="177,156,151,337,145,336,172,155"/>
89+
<area shape="rect" href="_optimizer_8cuh.html" title="Definition of optimization algorithms for training deep learning models." alt="" coords="213,203,315,229"/>
90+
<area shape="poly" title=" " alt="" coords="193,153,239,191,235,195,190,157"/>
91+
<area shape="rect" href="utils_8cuh_source.html" title=" " alt="" coords="461,277,531,304"/>
92+
<area shape="poly" title=" " alt="" coords="211,153,328,200,461,267,459,272,326,205,209,158"/>
93+
<area shape="rect" title=" " alt="" coords="78,501,135,528"/>
94+
<area shape="poly" title=" " alt="" coords="128,381,107,401,90,428,87,442,88,457,96,487,91,488,82,458,82,442,86,426,103,398,125,377"/>
95+
<area shape="rect" href="_dimension_8cuh_source.html" title=" " alt="" coords="144,427,253,453"/>
96+
<area shape="poly" title=" " alt="" coords="156,378,182,412,178,416,151,381"/>
97+
<area shape="poly" title=" " alt="" coords="184,456,136,494,133,490,181,452"/>
98+
<area shape="rect" title=" " alt="" coords="440,501,512,528"/>
99+
<area shape="poly" title=" " alt="" coords="248,451,426,497,424,503,246,456"/>
100+
<area shape="rect" title=" " alt="" coords="190,501,268,528"/>
101+
<area shape="poly" title=" " alt="" coords="206,453,221,486,216,488,202,455"/>
102+
<area shape="rect" href="dl__export_8cuh_source.html" title=" " alt="" coords="309,501,408,528"/>
103+
<area shape="poly" title=" " alt="" coords="228,451,318,492,316,497,225,456"/>
104+
<area shape="rect" title=" " alt="" coords="326,277,436,304"/>
105+
<area shape="poly" title=" " alt="" coords="286,228,350,267,347,271,283,232"/>
106+
<area shape="rect" href="_nodes_8cuh.html" title="Declaration of the Node class and various derived node classes for neural network operations." alt="" coords="218,277,302,304"/>
107+
<area shape="poly" title=" " alt="" coords="266,230,264,262,259,262,261,230"/>
108+
<area shape="rect" title=" " alt="" coords="351,352,420,379"/>
109+
<area shape="poly" title=" " alt="" coords="283,302,352,342,349,346,281,307"/>
110+
<area shape="rect" href="_tensor_8cuh.html" title="Definition of the Tensor class for GPU&#45;based tensor operations." alt="" coords="241,352,327,379"/>
111+
<area shape="poly" title=" " alt="" coords="267,304,278,336,273,338,262,305"/>
112+
<area shape="poly" title=" " alt="" coords="242,382,178,404,151,416,134,428,118,457,111,487,106,486,113,455,130,425,149,412,176,399,240,377"/>
113+
<area shape="poly" title=" " alt="" coords="271,381,226,419,223,415,267,377"/>
114+
<area shape="poly" title=" " alt="" coords="285,379,280,414,268,454,249,490,244,487,263,452,274,412,280,378"/>
115+
<area shape="poly" title=" " alt="" coords="328,374,369,393,388,407,404,425,409,443,405,460,385,492,381,489,400,458,403,443,399,428,385,411,367,397,326,379"/>
116+
<area shape="rect" title=" " alt="" coords="328,427,389,453"/>
117+
<area shape="poly" title=" " alt="" coords="299,377,337,414,333,418,295,381"/>
118+
<area shape="poly" title=" " alt="" coords="498,305,481,486,476,486,492,304"/>
119+
</map>
120+
</div>
121+
</div><div class="textblock"><div class="dynheader">
122+
This graph shows which files directly or indirectly include this file:</div>
123+
<div class="dyncontent">
124+
<div class="center"><img src="_model_8cuh__dep__incl.png" border="0" usemap="#a_d_1_2_users_2_mgepahmge_2_documents_2_c_01_program_2_neu_zephyr_2include_2_neu_zephyr_2_model_8cuhdep" alt=""/></div>
125+
<map name="a_d_1_2_users_2_mgepahmge_2_documents_2_c_01_program_2_neu_zephyr_2include_2_neu_zephyr_2_model_8cuhdep" id="a_d_1_2_users_2_mgepahmge_2_documents_2_c_01_program_2_neu_zephyr_2include_2_neu_zephyr_2_model_8cuhdep">
126+
<area shape="rect" title="Core class for computational graph construction and neural network modeling." alt="" coords="5,5,208,80"/>
127+
<area shape="rect" href="_model_8cu_source.html" title=" " alt="" coords="22,128,191,187"/>
128+
<area shape="poly" title=" " alt="" coords="109,95,109,127,104,127,104,95"/>
129+
</map>
130+
</div>
131+
</div>
132+
<p><a href="_model_8cuh_source.html">Go to the source code of this file.</a></p>
133+
<table class="memberdecls">
134+
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
135+
Classes</h2></td></tr>
136+
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classnz_1_1_model.html">nz::Model</a></td></tr>
137+
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Base class for constructing neural network models with automatic computation graph management. <a href="classnz_1_1_model.html#details">More...</a><br /></td></tr>
138+
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
139+
</table>
140+
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
141+
<div class="textblock"><p>Core class for computational graph construction and neural network modeling. </p>
142+
<p>This header defines the Model class architecture supporting dynamic neural network composition, providing high-level abstractions for layer configuration, loss computation, and distributed execution. Implements GPU-accelerated computational graph management with automatic differentiation capabilities.</p>
143+
<p>The Model class provides the following principal components:</p><ul>
144+
<li><b>Graph Topology Management</b>: Declarative API for building directed acyclic computation graphs with lazy evaluation semantics</li>
145+
<li><b>Operator Fusion</b>: Optimizes kernel launches through vertical integration of tensor operations</li>
146+
<li><b>Memory Optimization</b>: Implements arena-based allocation with smart tensor lifetime tracking</li>
147+
<li><b>Distributed Computing</b>: Native support for multi-GPU/multi-node execution through NCCL integration</li>
148+
<li><b>Operator Registry</b>: Extensible layer registration system supporting custom kernel development</li>
149+
</ul>
150+
<dl class="section note"><dt>Note</dt><dd><ul>
151+
<li>Runtime graph validation occurs during first forward pass</li>
152+
<li>Device memory allocation patterns adapt to available VRAM</li>
153+
<li>Use Model::Finalize() before deployment for graph optimization</li>
154+
</ul>
155+
</dd></dl>
156+
<dl class="section author"><dt>Author</dt><dd>Mgepahmge(<a href="https://github.com/Mgepahmge">https://github.com/Mgepahmge</a>)</dd></dl>
157+
<dl class="section date"><dt>Date</dt><dd>2024/06/18 </dd></dl>
158+
159+
<p class="definition">Definition in file <a class="el" href="_model_8cuh_source.html">Model.cuh</a>.</p>
160+
</div></div><!-- contents -->
161+
<!-- start footer part -->
162+
<hr class="footer"/><address class="footer"><small>
163+
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.12.0
164+
</small></address>
165+
</div><!-- doc-content -->
166+
</body>
167+
</html>

‎docs/html/_model_8cuh__dep__incl.map‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
<map id="D:/Users/Mgepahmge/Documents/C Program/NeuZephyr/include/NeuZephyr/Model.cuh" name="D:/Users/Mgepahmge/Documents/C Program/NeuZephyr/include/NeuZephyr/Model.cuh">
2+
<area shape="rect" id="Node000001" title="Core class for computational graph construction and neural network modeling." alt="" coords="5,5,208,80"/>
3+
<area shape="rect" id="Node000002" href="$_model_8cu_source.html" title=" " alt="" coords="22,128,191,187"/>
4+
<area shape="poly" id="edge1_Node000001_Node000002" title=" " alt="" coords="109,95,109,127,104,127,104,95"/>
5+
</map>

‎docs/html/_model_8cuh__dep__incl.md5‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
0d1662a02c3768dac777f51226f014bf

‎docs/html/_model_8cuh__dep__incl.png‎

3.04 KB
Loading

‎docs/html/_model_8cuh__incl.map‎

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
<map id="D:/Users/Mgepahmge/Documents/C Program/NeuZephyr/include/NeuZephyr/Model.cuh" name="D:/Users/Mgepahmge/Documents/C Program/NeuZephyr/include/NeuZephyr/Model.cuh">
2+
<area shape="rect" id="Node000001" title="Core class for computational graph construction and neural network modeling." alt="" coords="75,5,277,80"/>
3+
<area shape="rect" id="Node000002" href="$_compute_graph_8cuh.html" title="Defines the ComputeGraph class for constructing and managing computational graphs in neural network m..." alt="" coords="109,128,243,155"/>
4+
<area shape="poly" id="edge1_Node000001_Node000002" title=" " alt="" coords="179,80,179,112,173,112,173,80"/>
5+
<area shape="rect" id="Node000003" title=" " alt="" coords="5,203,59,229"/>
6+
<area shape="poly" id="edge2_Node000002_Node000003" title=" " alt="" coords="152,158,72,198,70,193,150,153"/>
7+
<area shape="rect" id="Node000004" title=" " alt="" coords="82,203,139,229"/>
8+
<area shape="poly" id="edge3_Node000002_Node000004" title=" " alt="" coords="167,157,134,193,130,189,163,153"/>
9+
<area shape="rect" id="Node000005" href="$_operation_kernels_8cuh.html" title="CUDA Kernel Definitions for High&#45;Performance Tensor Operations." alt="" coords="71,352,217,379"/>
10+
<area shape="poly" id="edge4_Node000002_Node000005" title=" " alt="" coords="177,156,151,337,145,336,172,155"/>
11+
<area shape="rect" id="Node000011" href="$_optimizer_8cuh.html" title="Definition of optimization algorithms for training deep learning models." alt="" coords="213,203,315,229"/>
12+
<area shape="poly" id="edge11_Node000002_Node000011" title=" " alt="" coords="193,153,239,191,235,195,190,157"/>
13+
<area shape="rect" id="Node000017" href="$utils_8cuh_source.html" title=" " alt="" coords="461,277,531,304"/>
14+
<area shape="poly" id="edge21_Node000002_Node000017" title=" " alt="" coords="211,153,328,200,461,267,459,272,326,205,209,158"/>
15+
<area shape="rect" id="Node000006" title=" " alt="" coords="78,501,135,528"/>
16+
<area shape="poly" id="edge5_Node000005_Node000006" title=" " alt="" coords="128,381,107,401,90,428,87,442,88,457,96,487,91,488,82,458,82,442,86,426,103,398,125,377"/>
17+
<area shape="rect" id="Node000007" href="$_dimension_8cuh_source.html" title=" " alt="" coords="144,427,253,453"/>
18+
<area shape="poly" id="edge6_Node000005_Node000007" title=" " alt="" coords="156,378,182,412,178,416,151,381"/>
19+
<area shape="poly" id="edge9_Node000007_Node000006" title=" " alt="" coords="184,456,136,494,133,490,181,452"/>
20+
<area shape="rect" id="Node000008" title=" " alt="" coords="440,501,512,528"/>
21+
<area shape="poly" id="edge7_Node000007_Node000008" title=" " alt="" coords="248,451,426,497,424,503,246,456"/>
22+
<area shape="rect" id="Node000009" title=" " alt="" coords="190,501,268,528"/>
23+
<area shape="poly" id="edge8_Node000007_Node000009" title=" " alt="" coords="206,453,221,486,216,488,202,455"/>
24+
<area shape="rect" id="Node000010" href="$dl__export_8cuh_source.html" title=" " alt="" coords="309,501,408,528"/>
25+
<area shape="poly" id="edge10_Node000007_Node000010" title=" " alt="" coords="228,451,318,492,316,497,225,456"/>
26+
<area shape="rect" id="Node000012" title=" " alt="" coords="326,277,436,304"/>
27+
<area shape="poly" id="edge12_Node000011_Node000012" title=" " alt="" coords="286,228,350,267,347,271,283,232"/>
28+
<area shape="rect" id="Node000013" href="$_nodes_8cuh.html" title="Declaration of the Node class and various derived node classes for neural network operations." alt="" coords="218,277,302,304"/>
29+
<area shape="poly" id="edge13_Node000011_Node000013" title=" " alt="" coords="266,230,264,262,259,262,261,230"/>
30+
<area shape="rect" id="Node000014" title=" " alt="" coords="351,352,420,379"/>
31+
<area shape="poly" id="edge14_Node000013_Node000014" title=" " alt="" coords="283,302,352,342,349,346,281,307"/>
32+
<area shape="rect" id="Node000015" href="$_tensor_8cuh.html" title="Definition of the Tensor class for GPU&#45;based tensor operations." alt="" coords="241,352,327,379"/>
33+
<area shape="poly" id="edge15_Node000013_Node000015" title=" " alt="" coords="267,304,278,336,273,338,262,305"/>
34+
<area shape="poly" id="edge18_Node000015_Node000006" title=" " alt="" coords="242,382,178,404,151,416,134,428,118,457,111,487,106,486,113,455,130,425,149,412,176,399,240,377"/>
35+
<area shape="poly" id="edge20_Node000015_Node000007" title=" " alt="" coords="271,381,226,419,223,415,267,377"/>
36+
<area shape="poly" id="edge17_Node000015_Node000009" title=" " alt="" coords="285,379,280,414,268,454,249,490,244,487,263,452,274,412,280,378"/>
37+
<area shape="poly" id="edge19_Node000015_Node000010" title=" " alt="" coords="328,374,369,393,388,407,404,425,409,443,405,460,385,492,381,489,400,458,403,443,399,428,385,411,367,397,326,379"/>
38+
<area shape="rect" id="Node000016" title=" " alt="" coords="328,427,389,453"/>
39+
<area shape="poly" id="edge16_Node000015_Node000016" title=" " alt="" coords="299,377,337,414,333,418,295,381"/>
40+
<area shape="poly" id="edge22_Node000017_Node000008" title=" " alt="" coords="498,305,481,486,476,486,492,304"/>
41+
</map>

‎docs/html/_model_8cuh__incl.md5‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
c15cf0af383ea236084142eb2eb37671

‎docs/html/_model_8cuh__incl.png‎

35.4 KB
Loading

0 commit comments

Comments
 (0)