Skip to content

Commit

Permalink
Updated installation instructions on MacOs
Browse files Browse the repository at this point in the history
  • Loading branch information
Aghiles SALAH committed Jul 24, 2018
1 parent cb63d94 commit a05ef2d
Show file tree
Hide file tree
Showing 18 changed files with 44 additions and 24 deletions.
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,9 @@ Then, please run the appropriate Cornac install command according to your platfo
```

* **MacOS**:
- You will need to install the Torch dependency first. Please follow the instructions [here](https://pytorch.org/) to install PyTorch on MacOS using conda. Then run the following command.
```
pip3 install https://github.com/PreferredAI/cornac/archive/master.zip
pip install https://github.com/PreferredAI/cornac/archive/master.zip
```


Expand Down
Binary file removed cornac/__pycache__/__init__.cpython-36.pyc
Binary file not shown.
Binary file removed cornac/models/__pycache__/__init__.cpython-36.pyc
Binary file not shown.
Binary file removed cornac/models/__pycache__/recommender.cpython-36.pyc
Binary file not shown.
Binary file removed cornac/models/cf/__pycache__/__init__.cpython-36.pyc
Binary file not shown.
Binary file removed cornac/models/cf/__pycache__/bpr.cpython-36.pyc
Binary file not shown.
Binary file removed cornac/models/cf/__pycache__/hpf.cpython-36.pyc
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file modified docs/build/doctrees/environment.pickle
Binary file not shown.
Binary file modified docs/build/doctrees/installation.doctree
Binary file not shown.
18 changes: 12 additions & 6 deletions docs/build/html/_sources/installation.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -5,18 +5,24 @@ Before to install Cornac, please make sure you are using Python 3 (version >=3.6
Then, please run the appropriate Cornac install command according to your platform.

* **Windows**:

- Some recommender models run with PyTorch. The latter library is not in PyPI, so when you install Cornac from the Wheel file this dependency is not handled automatically. You will, therefore need to install PyTorch first.

We provide the wheel (.whl) file for Python 3.6, please make sure this is the Python version you are using so as to install cornac directly from the whl file.

- Some recommender models run with PyTorch. The latter library is not in PyPI, so when you install Cornac from the Wheel file this dependency is not handled automatically. You will, therefore, need to install PyTorch first.

::

pip install http://download.pytorch.org/whl/cpu/torch-0.4.0-cp36-cp36m-win_amd64.whl
pip install https://github.com/PreferredAI/cornac/raw/master/dist/cornac-0.1.0-cp36-cp36m-win_amd64.whl
pip3 install http://download.pytorch.org/whl/cpu/torch-0.4.0-cp36-cp36m-win_amd64.whl
pip3 install https://github.com/PreferredAI/cornac/raw/master/dist/cornac-0.1.0-cp36-cp36m-win_amd64.whl

* **Linux**::

pip install https://github.com/PreferredAI/cornac/archive/master.zip --process-dependency-links
pip3 install https://github.com/PreferredAI/cornac/archive/master.zip --process-dependency-links
* **MacOS**::
* **MacOS**:

- You will need to install the Torch dependency first. Please follow the instructions `here <https://pytorch.org/>`_ to install PyTorch on MacOS using conda. Then run the following command.

::

pip install https://github.com/PreferredAI/cornac/archive/master.zip
31 changes: 19 additions & 12 deletions docs/build/html/installation.html
Original file line number Diff line number Diff line change
Expand Up @@ -161,33 +161,40 @@
<h1>Installation<a class="headerlink" href="#installation" title="Permalink to this headline"></a></h1>
<p>Before to install Cornac, please make sure you are using Python 3 (version &gt;=3.6, is recommended), and you are on the latest pip.
Then, please run the appropriate Cornac install command according to your platform.</p>
<ul>
<li><p class="first"><strong>Windows</strong>:</p>
<ul class="simple">
<li><strong>Windows</strong>:</li>
</ul>
<blockquote>
<div><p>We provide the wheel (.whl) file for Python 3.6, please make sure this is the Python version you are using so as to install cornac directly from the whl file.</p>
<blockquote>
<div><ul class="simple">
<li>Some recommender models run with PyTorch. The latter library is not in PyPI, so when you install Cornac from the Wheel file this dependency is not handled automatically. You will, therefore need to install PyTorch first.</li>
<li>Some recommender models run with PyTorch. The latter library is not in PyPI, so when you install Cornac from the Wheel file this dependency is not handled automatically. You will, therefore, need to install PyTorch first.</li>
</ul>
</div></blockquote>
</li>
</ul>
<blockquote>
<div><div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">pip</span> <span class="n">install</span> <span class="n">http</span><span class="p">:</span><span class="o">//</span><span class="n">download</span><span class="o">.</span><span class="n">pytorch</span><span class="o">.</span><span class="n">org</span><span class="o">/</span><span class="n">whl</span><span class="o">/</span><span class="n">cpu</span><span class="o">/</span><span class="n">torch</span><span class="o">-</span><span class="mf">0.4</span><span class="o">.</span><span class="mi">0</span><span class="o">-</span><span class="n">cp36</span><span class="o">-</span><span class="n">cp36m</span><span class="o">-</span><span class="n">win_amd64</span><span class="o">.</span><span class="n">whl</span>
<span class="n">pip</span> <span class="n">install</span> <span class="n">https</span><span class="p">:</span><span class="o">//</span><span class="n">github</span><span class="o">.</span><span class="n">com</span><span class="o">/</span><span class="n">PreferredAI</span><span class="o">/</span><span class="n">cornac</span><span class="o">/</span><span class="n">raw</span><span class="o">/</span><span class="n">master</span><span class="o">/</span><span class="n">dist</span><span class="o">/</span><span class="n">cornac</span><span class="o">-</span><span class="mf">0.1</span><span class="o">.</span><span class="mi">0</span><span class="o">-</span><span class="n">cp36</span><span class="o">-</span><span class="n">cp36m</span><span class="o">-</span><span class="n">win_amd64</span><span class="o">.</span><span class="n">whl</span>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">pip3</span> <span class="n">install</span> <span class="n">http</span><span class="p">:</span><span class="o">//</span><span class="n">download</span><span class="o">.</span><span class="n">pytorch</span><span class="o">.</span><span class="n">org</span><span class="o">/</span><span class="n">whl</span><span class="o">/</span><span class="n">cpu</span><span class="o">/</span><span class="n">torch</span><span class="o">-</span><span class="mf">0.4</span><span class="o">.</span><span class="mi">0</span><span class="o">-</span><span class="n">cp36</span><span class="o">-</span><span class="n">cp36m</span><span class="o">-</span><span class="n">win_amd64</span><span class="o">.</span><span class="n">whl</span>
<span class="n">pip3</span> <span class="n">install</span> <span class="n">https</span><span class="p">:</span><span class="o">//</span><span class="n">github</span><span class="o">.</span><span class="n">com</span><span class="o">/</span><span class="n">PreferredAI</span><span class="o">/</span><span class="n">cornac</span><span class="o">/</span><span class="n">raw</span><span class="o">/</span><span class="n">master</span><span class="o">/</span><span class="n">dist</span><span class="o">/</span><span class="n">cornac</span><span class="o">-</span><span class="mf">0.1</span><span class="o">.</span><span class="mi">0</span><span class="o">-</span><span class="n">cp36</span><span class="o">-</span><span class="n">cp36m</span><span class="o">-</span><span class="n">win_amd64</span><span class="o">.</span><span class="n">whl</span>
</pre></div>
</div>
</div></blockquote>
<ul>
<li><p class="first"><strong>Linux</strong>:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">pip</span> <span class="n">install</span> <span class="n">https</span><span class="p">:</span><span class="o">//</span><span class="n">github</span><span class="o">.</span><span class="n">com</span><span class="o">/</span><span class="n">PreferredAI</span><span class="o">/</span><span class="n">cornac</span><span class="o">/</span><span class="n">archive</span><span class="o">/</span><span class="n">master</span><span class="o">.</span><span class="n">zip</span> <span class="o">--</span><span class="n">process</span><span class="o">-</span><span class="n">dependency</span><span class="o">-</span><span class="n">links</span>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">pip3</span> <span class="n">install</span> <span class="n">https</span><span class="p">:</span><span class="o">//</span><span class="n">github</span><span class="o">.</span><span class="n">com</span><span class="o">/</span><span class="n">PreferredAI</span><span class="o">/</span><span class="n">cornac</span><span class="o">/</span><span class="n">archive</span><span class="o">/</span><span class="n">master</span><span class="o">.</span><span class="n">zip</span> <span class="o">--</span><span class="n">process</span><span class="o">-</span><span class="n">dependency</span><span class="o">-</span><span class="n">links</span>
</pre></div>
</div>
</li>
<li><p class="first"><strong>MacOS</strong>:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">pip</span> <span class="n">install</span> <span class="n">https</span><span class="p">:</span><span class="o">//</span><span class="n">github</span><span class="o">.</span><span class="n">com</span><span class="o">/</span><span class="n">PreferredAI</span><span class="o">/</span><span class="n">cornac</span><span class="o">/</span><span class="n">archive</span><span class="o">/</span><span class="n">master</span><span class="o">.</span><span class="n">zip</span>
</pre></div>
</div>
<blockquote>
<div><ul class="simple">
<li>You will need to install the Torch dependency first. Please follow the instructions <a class="reference external" href="https://pytorch.org/">here</a> to install PyTorch on MacOS using conda. Then run the following command.</li>
</ul>
</div></blockquote>
</li>
</ul>
<blockquote>
<div><div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">pip</span> <span class="n">install</span> <span class="n">https</span><span class="p">:</span><span class="o">//</span><span class="n">github</span><span class="o">.</span><span class="n">com</span><span class="o">/</span><span class="n">PreferredAI</span><span class="o">/</span><span class="n">cornac</span><span class="o">/</span><span class="n">archive</span><span class="o">/</span><span class="n">master</span><span class="o">.</span><span class="n">zip</span>
</pre></div>
</div>
</div></blockquote>
</div>


Expand Down
2 changes: 1 addition & 1 deletion docs/build/html/searchindex.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit a05ef2d

Please sign in to comment.