Skip to content

Commit

Permalink
Pushing changes to GitHub Pages.
Browse files Browse the repository at this point in the history
  • Loading branch information
docs-sched-rebuild committed Sep 18, 2024
1 parent 97f9cd4 commit 2c689d3
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
6 changes: 3 additions & 3 deletions main/hugectr_contributor_guide.html
Original file line number Diff line number Diff line change
Expand Up @@ -196,10 +196,10 @@ <h3>Build HugeCTR Training Container from Source<a class="headerlink" href="#bui
<li><p><strong>ENABLE_INFERENCE</strong>: You can use this option to build HugeCTR in inference mode, which was designed for the inference framework. In this mode, an inference shared library
will be built for the HugeCTR Backend. Only interfaces that support the HugeCTR Backend can be used. Therefore, you can’t train models in this mode. This option is set to
OFF by default. For building inference container, please refer to <a class="reference internal" href="#build-hugectr-inference-container-from-source">Build HugeCTR Inference Container from Source</a></p></li>
<li><p><strong>ENABLE_HDFS</strong>: You can use this option to build HugeCTR together with HDFS to enable HDFS related functions. Permissible values are <code class="docutils literal notranslate"><span class="pre">ON</span></code>, <code class="docutils literal notranslate"><span class="pre">MINIMAL</span></code> and <code class="docutils literal notranslate"><span class="pre">OFF</span></code> <em>(default)</em>. Setting this option to <code class="docutils literal notranslate"><span class="pre">ON</span></code> leads to building all necessary Hadoop modules that are required for building AND running both HugeCTR and HDFS. In contrast, <code class="docutils literal notranslate"><span class="pre">MINIMAL</span></code> restricts building only the minimum necessary set of components for building HugeCTR.</p></li>
<li><p><strong>ENABLE_HDFS</strong>: You can use this option to build HugeCTR together with HDFS to enable HDFS related functions. Permissible values are <code class="docutils literal notranslate"><span class="pre">ON</span></code> and <code class="docutils literal notranslate"><span class="pre">OFF</span></code> <em>(default)</em>. Setting this option to <code class="docutils literal notranslate"><span class="pre">ON</span></code> leads to building all necessary Hadoop modules that are required for building so that it can connect to HDFS deployments.</p></li>
<li><p><strong>ENABLE_S3</strong>: You can use this option to build HugeCTR together with Amazon AWS S3 SDK to enable S3 related functions. Permissible values are <code class="docutils literal notranslate"><span class="pre">ON</span></code> and <code class="docutils literal notranslate"><span class="pre">OFF</span></code> <em>(default)</em>. Setting this option to <code class="docutils literal notranslate"><span class="pre">ON</span></code> leads to building all necessary AWS SKKs and dependencies that are required for building AND running both HugeCTR and S3.</p></li>
</ul>
<p><strong>Please note that setting DENABLE_HDFS=ON/MINIMAL or DENABLE_S3=ON requires root permission. So before using these two options to do the customized building, make sure you use <code class="docutils literal notranslate"><span class="pre">-u</span> <span class="pre">root</span></code> when you run the docker container.</strong></p>
<p><strong>Please note that setting DENABLE_HDFS=ON or DENABLE_S3=ON requires root permission. So before using these two options to do the customized building, make sure you use <code class="docutils literal notranslate"><span class="pre">-u</span> <span class="pre">root</span></code> when you run the docker container.</strong></p>
<p>Here are some examples of how you can build HugeCTR using these build options:</p>
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>$<span class="w"> </span>mkdir<span class="w"> </span>-p<span class="w"> </span>build<span class="w"> </span><span class="o">&amp;&amp;</span><span class="w"> </span><span class="nb">cd</span><span class="w"> </span>build
$<span class="w"> </span>cmake<span class="w"> </span>-DCMAKE_BUILD_TYPE<span class="o">=</span>Release<span class="w"> </span>-DSM<span class="o">=</span><span class="m">80</span><span class="w"> </span>..<span class="w"> </span><span class="c1"># Target is NVIDIA A100</span>
Expand All @@ -212,7 +212,7 @@ <h3>Build HugeCTR Training Container from Source<a class="headerlink" href="#bui
</pre></div>
</div>
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>$<span class="w"> </span>mkdir<span class="w"> </span>-p<span class="w"> </span>build<span class="w"> </span><span class="o">&amp;&amp;</span><span class="w"> </span><span class="nb">cd</span><span class="w"> </span>build
$<span class="w"> </span>cmake<span class="w"> </span>-DCMAKE_BUILD_TYPE<span class="o">=</span>Release<span class="w"> </span>-DSM<span class="o">=</span><span class="s2">&quot;70;80&quot;</span><span class="w"> </span>-DENABLE_HDFS<span class="o">=</span>MINIMAL<span class="w"> </span>..<span class="w"> </span><span class="c1"># Target is NVIDIA V100 / A100 with only minimum HDFS components mode on.</span>
$<span class="w"> </span>cmake<span class="w"> </span>-DCMAKE_BUILD_TYPE<span class="o">=</span>Release<span class="w"> </span>-DSM<span class="o">=</span><span class="s2">&quot;70;80&quot;</span><span class="w"> </span>-DENABLE_HDFS<span class="o">=</span>ON<span class="w"> </span>..<span class="w"> </span><span class="c1"># Target is NVIDIA V100 / A100 with HDFS components mode on.</span>
$<span class="w"> </span>make<span class="w"> </span>-j<span class="w"> </span><span class="o">&amp;&amp;</span><span class="w"> </span>make<span class="w"> </span>install
</pre></div>
</div>
Expand Down
2 changes: 1 addition & 1 deletion main/searchindex.js

Large diffs are not rendered by default.

0 comments on commit 2c689d3

Please sign in to comment.