Skip to content

Commit

Permalink
AlCatt91 published a site update
Browse files Browse the repository at this point in the history
  • Loading branch information
AlCatt91 committed Mar 4, 2024
1 parent d94b2f7 commit f947c7d
Show file tree
Hide file tree
Showing 51 changed files with 458 additions and 518 deletions.
Binary file removed _images/Terminal3.png
Binary file not shown.
1 change: 0 additions & 1 deletion _images/gradient-badge.svg

This file was deleted.

5 changes: 0 additions & 5 deletions _sources/user_guide.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -47,11 +47,6 @@ We recommend the following sequence:
2. `Link prediction on the YAGO3-10 dataset <https://github.com/graphcore-research/bess-kge/tree/main/notebooks/2_yago_topk_prediction.ipynb>`_.
3. `FP16 weights and compute on the OGBL-WikiKG2 dataset <https://github.com/graphcore-research/bess-kge/tree/main/notebooks/3_wikikg2_fp16.ipynb>`_.

.. |run_on_gradient| image:: ../gradient-badge.svg

Click on the |run_on_gradient| button inside the notebooks to run them **for free** on physical IPUs
available on `Paperspace <https://www.paperspace.com/graphcore>`_.

Limitations
------------------------

Expand Down
25 changes: 0 additions & 25 deletions contrib.html
Original file line number Diff line number Diff line change
Expand Up @@ -76,31 +76,6 @@
<h1>How to contribute to the BESS-KGE project<a class="headerlink" href="#how-to-contribute-to-the-bess-kge-project" title="Permalink to this heading"></a></h1>
<p><img alt="PRs Welcome" src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square" /></p>
<p>You can contribute to the development of the BESS-KGE project, even if you don’t have access to IPUs (you can use the <a class="reference external" href="https://docs.graphcore.ai/projects/poptorch-user-guide/en/3.2.0/reference.html#poptorch.Options.useIpuModel">IPUModel</a> to emulate most functionalities of the physical hardware).</p>
<section id="vs-code-server-on-paperspace">
<h2>VS Code server on Paperspace<a class="headerlink" href="#vs-code-server-on-paperspace" title="Permalink to this heading"></a></h2>
<p>Setting up a VS Code server on <a class="reference external" href="https://www.paperspace.com/graphcore">Paperspace</a> will allow you to tunnel into a machine with IPUs from the VS Code web editor or the desktop app. This requires minimum effort and is an excellent solution for developing and testing code directly on IPU hardware. Here’s how to do it.</p>
<ol class="arabic">
<li><p>Fork the <a class="reference external" href="https://github.com/graphcore-research/bess-kge">BESS-KGE repository</a>.</p></li>
<li><p>You can launch a 6-hours session on a Paperspace machine with access to 4 IPUs <strong>for free</strong> by using a link of the form:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>https://console.paperspace.com/github/{USERID}/{REPONAME}?container=graphcore%2Fpytorch-paperspace%3A3.3.0-ubuntu-20.04-20230703&amp;machine=Free-IPU-POD4
</pre></div>
</div>
<p>where <code class="docutils literal notranslate"><span class="pre">{USERID}/{REPOPNAME}</span></code> is the github address of the forked repository (e.g. <code class="docutils literal notranslate"><span class="pre">graphcore-research/bess-kge</span></code> for the original repo).</p>
</li>
<li><p>Start the machine (this will also clone the repo for you) and open up a terminal from the left pane.</p>
<p><img alt="terminal_pane" src="_images/Terminal3.png" /></p>
</li>
<li><p>In the terminal, run the command</p>
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>bash<span class="w"> </span>.gradient/launch_vscode_server.sh<span class="w"> </span><span class="o">{</span>tunnel-name<span class="o">}</span>
</pre></div>
</div>
<p>where <code class="docutils literal notranslate"><span class="pre">tunnel-name</span></code> is an optional argument that you can use to define the name of the remote tunnel (if not set, it will default to <code class="docutils literal notranslate"><span class="pre">ipu-paperspace</span></code>). The script will download and install all dependencies and start the tunnel.</p>
</li>
<li><p>When asked, authorize the tunnel through GitHub (with an account having writing privileges to the forked repository). You will be then provided with the tunnel link. Please refer to <a class="reference external" href="https://ipu.dev/fmo4AZ">this notebook</a> for additional details on these steps and to connect the VS Code desktop app to the remote tunnel.</p></li>
<li><p>Once VS Code is connected to the Paperspace machine, run <code class="docutils literal notranslate"><span class="pre">./dev</span> <span class="pre">build</span></code> to build all custom ops. You are now ready to start developing!</p></li>
</ol>
<p>When closing a session and stopping the Paperspace machine, remember to unregister the tunnel in VS Code as explained in the “Common Issues” paragraph of the <a class="reference external" href="https://ipu.dev/fmo4AZ">notebook</a>. To resume your work, just access the clone of the BESS-KGE repo in the “Projects” section of your Paperspace profile, start a new machine and repeat the operations above. All code changes to the local repo, as well as VS Code settings and extensions installed, will persist across sessions.</p>
</section>
<section id="setup-on-local-machine">
<h2>Setup on local machine<a class="headerlink" href="#setup-on-local-machine" title="Permalink to this heading"></a></h2>
<p>To develop on a local machine, first install the Poplar SDK following the instructions in the <a class="reference external" href="https://docs.graphcore.ai/en/latest/getting-started.html#getting-started">Getting Started guide for your IPU system</a>.</p>
Expand Down
Loading

0 comments on commit f947c7d

Please sign in to comment.