forked from intel/nauta
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathREADME.html
289 lines (179 loc) · 13 KB
/
README.html
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
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Nauta Installation, Configuration, and Administration Guide — Nauta 1.1 documentation</title>
<script type="text/javascript" src="../_static/js/modernizr.min.js"></script>
<script type="text/javascript" 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 type="text/javascript" src="../_static/js/theme.js"></script>
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="prev" title="Product Overview" href="../user-guide/README.html" />
</head>
<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"> Nauta
</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">
<p class="caption"><span class="caption-text">Contents:</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../user-guide/README.html">Product Overview</a></li>
<li class="toctree-l1"><a class="reference internal" href="../user-guide/README.html#nauta-user-guide">Nauta User Guide</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Nauta Installation, Configuration, and Administration Guide</a></li>
<li class="toctree-l1"><a class="reference internal" href="#nauta-hardware-requirement-overview">Nauta Hardware Requirement Overview</a></li>
<li class="toctree-l1"><a class="reference internal" href="#nauta-installation-procedures">Nauta Installation Procedures</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#removing-nauta">Removing Nauta</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="#installation-details">Installation details</a></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">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../index.html">Nauta</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="../index.html">Docs</a> »</li>
<li>Nauta Installation, Configuration, and Administration Guide</li>
<li class="wy-breadcrumbs-aside">
<a href="../_sources/installation-and-configuration/README.md.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="nauta-installation-configuration-and-administration-guide">
<h1>Nauta Installation, Configuration, and Administration Guide<a class="headerlink" href="#nauta-installation-configuration-and-administration-guide" title="Permalink to this headline">¶</a></h1>
<p>This Nauta Installation, Configuration, and Administration guide provides step-by-step instructions for installing, configuring, upgrading, and removing Nauta. This guide also provides an overview of Nauta requirements, configuration options, and administration tasks.</p>
<p>This section discusses the following main topics:</p>
<ul class="simple">
<li><p><a class="reference external" href="#nauta-hardware-requirement-overview">Nauta Hardware Requirement Overview</a>: Provides an overview of Nauta Hardware requirements.</p></li>
<li><p><a class="reference external" href="#nauta-installation-procedures">Nauta Installation Procedures</a>: Provides the Installation Instructions.</p></li>
<li><p><a class="reference external" href="#document-flow">Document Flow</a>: This is your gateway to the Nauta installation documentation instructions; start here.</p></li>
</ul>
<p><strong>Note:</strong> For instructions on configuring the Nauta client, refer to the <a class="reference external" href="../user-guide/">Nauta User Guide</a>.</p>
<p>Nauta is a software suite that provides a multi-user, distributed computing environment for running deep learning model training experiments. Results of experiments can be viewed and monitored using a Command Line Interface (CLI), Web UI and/or TensorBoard. You can use existing data sets, your own data, or downloaded data from online sources, as well as create public or private folders to make collaboration among teams easier.</p>
<p>Nauta runs on Kubernetes and Docker for scalability and ease of management. Nauta uses customizable templates to remove the complexities of creating and running single and multi-node deep learning training experiments without all the system’s complexity and scripting needed with standard container environments.</p>
</div>
<div class="section" id="nauta-hardware-requirement-overview">
<h1>Nauta Hardware Requirement Overview<a class="headerlink" href="#nauta-hardware-requirement-overview" title="Permalink to this headline">¶</a></h1>
<p>Nauta is intended to run on a multi-server Kubernetes cluster. To run Nauta, you will need at least one Master node, and one or more Worker nodes. Nauta is a platform for performing Deep Learning training, and requires robust hardware specifications to run with optimal performance.</p>
</div>
<div class="section" id="nauta-installation-procedures">
<h1>Nauta Installation Procedures<a class="headerlink" href="#nauta-installation-procedures" title="Permalink to this headline">¶</a></h1>
<p>To install Nauta in a ‘bare metal’ (for example, non-cloud) server environment, you will need to:</p>
<ol class="simple">
<li><p>Execute the following commands from the command line:</p></li>
</ol>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">git</span> <span class="pre">clone</span> <span class="pre">--recursive</span> <span class="pre">https://github.com/IntelAI/nauta.git</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">cd</span> <span class="pre">nauta</span></code></p></li>
</ul>
<ol class="simple">
<li><p>Build the base package (a makefile will automate the bulk of the process, but there are some minimum packages needed for Nauta).</p></li>
</ol>
<ul class="simple">
<li><p><strong>Note:</strong> To see the list of installed components and their versions, refer to: <a class="reference internal" href="System_Software_Components_Requisites/SSCR.html"><span class="doc">List of Software Components</span></a> and for Package information, refer to: <a class="reference internal" href="Installation_Package_Requirements/IPR.html"><span class="doc">Installation Package Requirements</span></a>.</p></li>
</ul>
<ol class="simple">
<li><p>Populate or create Nauta’s inventory file to define where your master and worker nodes are, and how to access them. To create the Inventory file:</p>
<ul class="simple">
<li><p>Copy the Inventory file example information: <a class="reference internal" href="Inventory_Tasks/IT.html"><span class="doc">Inventory File Information</span></a>.</p></li>
<li><p>Modify the newly created Inventory file to suit your needs.</p></li>
</ul>
</li>
<li><p>Modify Nauta’s configuration file to define your proxy, network quirks and filesystem preferences. To create the configuration file:</p>
<ul class="simple">
<li><p>Copy the Configuration file example infomation: <a class="reference internal" href="Configuration_Tasks_Variables/CTV.html"><span class="doc">Configuration File Information</span></a>.</p></li>
<li><p>Modify the newly created Configuration file to suit your needs.</p></li>
</ul>
</li>
<li><p>Run the installation script (see <a class="reference internal" href="Installation_Process/IP.html"><span class="doc">Installation Process</span></a> for more information).</p></li>
</ol>
<p>This process does the following:</p>
<ul class="simple">
<li><p>Creates a Kubernetes cluster, all the Docker files you need to run Tensorflow, Jupyter, Tensorboard, and Horovod.</p></li>
<li><p>Installs the Nauta server-side application on your new Kubernetes cluster, and starts the system running.</p></li>
</ul>
<p>Completing all of the above takes some time. We are working on streamlining the process.</p>
<div class="section" id="removing-nauta">
<h2>Removing Nauta<a class="headerlink" href="#removing-nauta" title="Permalink to this headline">¶</a></h2>
<p>Should you ever need to delete/remove Nauta, refer to: <a class="reference external" href="../Installation_Process/IP">Installation Process</a> page for more details.</p>
</div>
</div>
<div class="section" id="installation-details">
<h1>Installation details<a class="headerlink" href="#installation-details" title="Permalink to this headline">¶</a></h1>
<p>This guide consists of the following main topics, in order. Start here to move through the correct sequence of events.</p>
<ul class="simple">
<li><p><a class="reference internal" href="System_Software_Components_Requisites/SSCR.html"><span class="doc">System Software Components Requisites</span></a></p></li>
<li><p><a class="reference internal" href="How_to_Build_Nauta/HBN.html"><span class="doc">Building Nauta</span></a></p>
<ul>
<li><p><a class="reference internal" href="Installer_System_Requirements/ISR.html"><span class="doc">Installer System Requirements</span></a></p></li>
<li><p><a class="reference internal" href="Target_Host_Requirements/THR.html"><span class="doc">Target Host Requirements</span></a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="Inventory_Tasks/IT.html"><span class="doc">Inventory Configuration</span></a></p></li>
<li><p><a class="reference internal" href="Configuration_Tasks_Variables/CTV.html"><span class="doc">Nauta Configuration (Variables)</span></a></p>
<ul>
<li><p><a class="reference internal" href="Installation_Package_Requirements/IPR.html"><span class="doc">Installation Package Requirements</span></a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="Installation_Process/IP.html"><span class="doc">Installating and Starting Nauta</span></a></p></li>
<li><p><a class="reference internal" href="User_Management/UM.html"><span class="doc">User Management</span></a></p></li>
<li><p><a class="reference internal" href="Troubleshooting/T.html"><span class="doc">Troubleshooting</span></a></p></li>
</ul>
<p>Terms and Conditions</p>
<p>To read Intel Terms and Conditions check <a class="reference internal" href="TaC.html"><span class="doc">this</span></a> document.</p>
<p>This user guide is subject to <a class="reference external" href="https://creativecommons.org/licenses/by-nd/4.0/">CC-BY-ND 4.0</a>.</p>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="../user-guide/README.html" class="btn btn-neutral float-left" title="Product Overview" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
© Copyright 2019, Intel Corporation
</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>
</div>
</div>
</section>
</div>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>