1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
|
% \iffalse meta-comment
%
% Copyright (C) 2021 by Carlos Cardoso Dias <carlosdias.dev@gmail.com>
% ---------------------------------------------------------------------------
% This work may be distributed and/or modified under the
% conditions of the LaTeX Project Public License, either version 1.3
% of this license or (at your option) any later version.
% The latest version of this license is in
% http://www.latex-project.org/lppl.txt
% and version 1.3 or later is part of all distributions of LaTeX
% version 2005/12/01 or later.
%
% This work has the LPPL maintenance status `maintained'.
%
% The Current Maintainer of this work is Carlos Cardoso Dias.
%
% This work consists of the files nndraw.dtx and nndraw.ins
% and the derived filebase nndraw.sty.
%
% \fi
%
% \iffalse
%<*driver>
\ProvidesFile{nndraw.dtx}
%</driver>
%<package>\NeedsTeXFormat{LaTeX2e}[1999/12/01]
%<package>\ProvidesPackage{nndraw}
%<*package>
[2021/06/22 1.0 nndraw is a LaTeX package which provides utilities to draw neural networks.]
%</package>
%
%<*driver>
\documentclass{ltxdoc}
\usepackage{nndraw}[2021/06/22]
\EnableCrossrefs
\CodelineIndex
\RecordChanges
\begin{document}
\DocInput{nndraw.dtx}
\PrintChanges
\PrintIndex
\end{document}
%</driver>
% \fi
%
% \CheckSum{129}
%
% \CharacterTable
% {Upper-case \A\B\C\D\E\F\G\H\I\J\K\L\M\N\O\P\Q\R\S\T\U\V\W\X\Y\Z
% Lower-case \a\b\c\d\e\f\g\h\i\j\k\l\m\n\o\p\q\r\s\t\u\v\w\x\y\z
% Digits \0\1\2\3\4\5\6\7\8\9
% Exclamation \! Double quote \" Hash (number) \#
% Dollar \$ Percent \% Ampersand \&
% Acute accent \' Left paren \( Right paren \)
% Asterisk \* Plus \+ Comma \,
% Minus \- Point \. Solidus \/
% Colon \: Semicolon \; Less than \<
% Equals \= Greater than \> Question mark \?
% Commercial at \@ Left bracket \[ Backslash \\
% Right bracket \] Circumflex \^ Underscore \_
% Grave accent \` Left brace \{ Vertical bar \|
% Right brace \} Tilde \~}
%
%
% \changes{1.0}{2021/06/22}{Converted to DTX file}
%
% \DoNotIndex{\newcommand,\newenvironment}
%
% \providecommand*{\url}{\texttt}
% \GetFileInfo{nndraw.dtx}
% \title{The \textsf{nndraw} package}
% \author{Carlos Cardoso Dias \\ \url{carlosdias.dev@gmail.com}}
% \date{\fileversion~from \filedate}
%
% \maketitle
%
% \section{Introduction}
%
\textbf{nndraw} is a \LaTeX package which provides utilities to draw neural networks in an efficient way.
Currently this package provides utilities to draw fully connected feedforward neural networks with an arbitrary
number of layers described inside the `fullyconnectednn` environment using the command `nnlayer`.
%
% \section{Usage}
%
An example of usage is shown below, in this example, a fully connected feedforward
deep neural network is provided with two inputs in the first layer, one hidden layer
with four neurons and one output layer with one output. This example shows how easy it is
to customize the presence/absence of biases in any layer as well as its position.
\begin{verbatim}
\begin{fullyconnectednn}[biasy = -4.5,
titley = 1,
inout = false]
\nnlayer[title = Input layer]{2}
\nnlayer[title = Hidden layer]{4}
\nnlayer[title = Ouput layer, hasbias = false]{1}
\end{fullyconnectednn}
\end{verbatim}
\noindent Which is drawn as
\begin{fullyconnectednn}[biasy = -4.5,
titley = 1,
inout = false]
\nnlayer[title = Input layer]{2}
\nnlayer[title = Hidden layer]{4}
\nnlayer[title = Ouput layer, hasbias = false]{1}
\end{fullyconnectednn}
%
%
% \StopEventually{}
%
% \section{Implementation}
%
% \iffalse
%<*package>
% \fi
%
% \begin{macrocode}
\NeedsTeXFormat{LaTeX2e}
\ProvidesPackage{nndraw}[2021/06/20 Neural Networks Draw LaTeX package]
\RequirePackage{tikz}
\pgfdeclarelayer{back}
\pgfsetlayers{back,main}
% \end{macrocode}
%
% \begin{macro}{\nnlayerNoText}
% \begin{macrocode}
\newcommand\nnlayerNoText[1]{}
% \end{macrocode}
% \end{macro}
%
% \begin{macrocode}
\newif\ifnnlayerHasBias
\pgfkeys{
/nnlayer/.is family, /nnlayer,
default/.style = {title = , text = \nnlayerNoText, hasbias = true, bias = , color = , biascolor = },
title/.estore in = \nnlayerTitle,
text/.store in = \nnlayerText,
hasbias/.is if = nnlayerHasBias,
bias/.estore in = \nnlayerBias,
color/.estore in = \nnlayerColor,
biascolor/.estore in = \nnlayerBiasColor,
}
\newcounter{numlayers}
\newcounter{nninputlayer}
\newcounter{lastnnsize}
\tikzstyle{neuron}=[circle, minimum size=6mm, fill=gray!70]
\tikzstyle{neuron_connection}=[->, shorten >=1pt, gray!70]
% \end{macrocode}
%
% \begin{macro}{\nnlayer}
% \begin{macrocode}
\newcommand\nnlayer[2][]{
\pgfkeys{/nnlayer, default, #1}
\node[text width = \fullyconnectednnTextWidth, align = center] at (\fullyconnectednnLayersep *
\thenumlayers,\fullyconnectednnTitleY) {\nnlayerTitle};
\if\thenninputlayer0
\setcounter{nninputlayer}{#2}
\fi
\foreach \i in {1,...,#2}
{
\node[neuron, yshift=(#2 - \thenninputlayer)*5 mm, fill=\nnlayerColor] (\thenumlayers-\i) at (\thenumlayers * \fullyconnectednnLayersep,-\i) {\nnlayerText{\i}};
}
\if\thelastnnsize0
\else
\ifnnlayerHasBias
\node[neuron, yshift=5mm, fill=\nnlayerBiasColor] (bias-\thenumlayers) at (\thenumlayers * \fullyconnectednnLayersep -\fullyconnectednnLayersep + \fullyconnectednnBiasX, \fullyconnectednnBiasY) {\nnlayerBias};
\fi
\begin{pgfonlayer}{back}
% \end{macrocode}
% node connections
% \begin{macrocode}
\foreach \i in {1,...,\thelastnnsize}
{
\foreach \j in {1,...,#2}
{
\draw[neuron_connection] (\the\numexpr\thenumlayers-1\relax-\i) -- (\thenumlayers-\j);
}
}
% \end{macrocode}
% bias connections
% \begin{macrocode}
\ifnnlayerHasBias
\foreach \j in {1,...,#2}
{
\draw[neuron_connection] (bias-\thenumlayers) -- (\thenumlayers-\j);
}
\fi
\end{pgfonlayer}
\fi
\setcounter{lastnnsize}{#2}
\stepcounter{numlayers}
}
% \end{macrocode}
% \end{macro}
%
% \begin{macrocode}
\newif\iffullyconnectednnInout
\pgfkeys{
/fullyconnectednn/.is family, /fullyconnectednn,
default/.style = {input = \nnlayerNoText, output = \nnlayerNoText, layersep = 3, biasx = 0.75, biasy = -8.75, titley = 0.75, inout = true, text width = 2cm},
input/.store in = \fullyconnectednnInput,
output/.store in = \fullyconnectednnOutput,
layersep/.estore in = \fullyconnectednnLayersep,
biasx/.estore in = \fullyconnectednnBiasX,
biasy/.estore in = \fullyconnectednnBiasY,
titley/.estore in = \fullyconnectednnTitleY,
inout/.is if = fullyconnectednnInout,
text width/.estore in = \fullyconnectednnTextWidth,
}
% \end{macrocode}
%
% \begin{environment}{fullyconnectednn}
% \begin{macrocode}
\newenvironment{fullyconnectednn}[1][]
{
\pgfkeys{/fullyconnectednn, default, #1}
\begin{center}
\begin{tikzpicture}
\setcounter{numlayers}{0}
\setcounter{nninputlayer}{0}
\setcounter{lastnnsize}{0}
}
{
\iffullyconnectednnInout
\begin{pgfonlayer}{back}
% \end{macrocode}
% Inputs
% \begin{macrocode}
\foreach \i in {1,...,\thenninputlayer}
{
\draw[<-, shorten <=1pt] (0-\i) -- ++(-1,0) node[left]{\fullyconnectednnInput{\i}};
}
% \end{macrocode}
% Outputs
% \begin{macrocode}
\foreach \i in {1,...,\thelastnnsize}
{
\draw[->, shorten <=1pt] (\the\numexpr\thenumlayers-1\relax-\i) -- ++(1,0) node[right]{\fullyconnectednnOutput{\i}};
}
\end{pgfonlayer}
\fi
\end{tikzpicture}
\end{center}
}
% \end{macrocode}
% \end{environment}
%
%
% \iffalse
%</package>
% \fi
%
% \Finale
\endinput
|
