Skip to content

Commit

Permalink
[ci skip] DOC add info how to install pixi bd29d4e
Browse files Browse the repository at this point in the history
  • Loading branch information
glemaitre committed Apr 17, 2024
1 parent 60bfec1 commit 2e31347
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 3 deletions.
6 changes: 5 additions & 1 deletion _sources/install.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,10 @@ Deploy Ragger Duck
==================

To ease the deployment, we rely on `pixi`. Refer to following
`link <https://pixi.sh/#installation>`_ for installing `pixi`.
`link <https://pixi.sh/#installation>`_ for installing `pixi` but in short, for the
currently supported platform, the following should be enough::

curl -fsSL https://pixi.sh/install.sh | bash

In the latest stage, `pixi` will be in charge to create the Python environments to
build the scikit-learn documentation, train the retrievers, and launch the Web Console.
Expand All @@ -37,6 +40,7 @@ Note that you can modify the `pixi.toml` to create your own environments since t
cuda version used in the `cuda-12-1` or `cuda-11-7` environment might not suits your
needs.


Cloning the project
-------------------

Expand Down
6 changes: 5 additions & 1 deletion install.html
Original file line number Diff line number Diff line change
Expand Up @@ -441,7 +441,11 @@ <h2>Use the Ragger Duck library<a class="headerlink" href="#use-the-ragger-duck-
<section id="deploy-ragger-duck">
<h2>Deploy Ragger Duck<a class="headerlink" href="#deploy-ragger-duck" title="Link to this heading">#</a></h2>
<p>To ease the deployment, we rely on <code class="docutils literal notranslate"><span class="pre">pixi</span></code>. Refer to following
<a class="reference external" href="https://pixi.sh/#installation">link</a> for installing <code class="docutils literal notranslate"><span class="pre">pixi</span></code>.</p>
<a class="reference external" href="https://pixi.sh/#installation">link</a> for installing <code class="docutils literal notranslate"><span class="pre">pixi</span></code> but in short, for the
currently supported platform, the following should be enough:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">curl</span> <span class="o">-</span><span class="n">fsSL</span> <span class="n">https</span><span class="p">:</span><span class="o">//</span><span class="n">pixi</span><span class="o">.</span><span class="n">sh</span><span class="o">/</span><span class="n">install</span><span class="o">.</span><span class="n">sh</span> <span class="o">|</span> <span class="n">bash</span>
</pre></div>
</div>
<p>In the latest stage, <code class="docutils literal notranslate"><span class="pre">pixi</span></code> will be in charge to create the Python environments to
build the scikit-learn documentation, train the retrievers, and launch the Web Console.
We already setup several environments for you depending on the platform and hardware
Expand Down
Loading

0 comments on commit 2e31347

Please sign in to comment.