Skip to content

Commit

Permalink
UPD: docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@c-hofer
c-hofer committed Mar 4, 2020
1 parent 974aef1 commit 766af10
Show file tree
Hide file tree
Showing 8 changed files with 58 additions and 40 deletions.
Binary file modified docs/._index.html
View file
Binary file not shown.
14 changes: 11 additions & 3 deletions docs/_sources/index.rst.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,12 +22,20 @@ the following publications are most relevant::
booktitle = {ICML},
year = {2019}}

@inproceedings{Hofer19b,
author = {C.~Hofer, R.~Kwitt and M.~Niethammer},
@article{Hofer20a,
author = {C.~Hofer, F.~Graf, B.~Rieck, R.~Kwitt and M.~Niethammer},
title = {Graph Filtration Learning},
booktitle = {arXiv},
journal = {arXiv},
note = {\url{https://arxiv.org/abs/1905.10996}},
year = {2019}}

@article{Hofer20b,
author = {C.~Hofer, F.~Graf, M.~Niethammer and R.~Kwitt},
title = {Topologically Densified Distributions},
journal = {arXiv},
note = {\url{https://arxiv.org/abs/2002.04805}},
year = {2020}}

.. note::
Note that not all of the available functionality is exposed in the
documentation yet.
Expand Down
18 changes: 8 additions & 10 deletions docs/_sources/install/index.rst.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@ Installation
The following setup was tested with the following system configuration:

* Ubuntu 18.04.2 LTS
* CUDA 10 (driver version 410.48)
* Anaconda (Python 3.7)
* PyTorch 1.1
* CUDA 10.1 (driver version 418.87.00)
* Anaconda (Python 3.7.6)
* PyTorch 1.4

In the following, we assume that we work in ``/tmp`` (obviously, you have to
change this to reflect your choice and using ``/tmp`` is, of course, not
Expand All @@ -18,16 +18,16 @@ using
.. code-block:: bash
cd /tmp/
wget https://repo.anaconda.com/archive/Anaconda3-2019.03-Linux-x86_64.sh
bash Anaconda3-2019.03-Linux-x86_64.sh
# specify /tmp/anconda3 as your installation path
wget https://repo.anaconda.com/archive/Anaconda3-2019.10-Linux-x86_64.sh
bash Anaconda3-2019.10-Linux-x86_64.sh
# specify /tmp/anaconda3 as your installation path
source /tmp/anaconda3/bin/activate
Second, we install PyTorch (v1.1) using
Second, we install PyTorch (v1.4) using

.. code-block:: bash
conda install pytorch torchvision cudatoolkit=10.0 -c pytorch
conda install pytorch torchvision cudatoolkit=10.1 -c pytorch
Third, we clone the ``chofer_torchex`` repository from GitHub and make
Expand All @@ -37,8 +37,6 @@ it available within Anaconda.
cd /tmp/
git clone https://github.com/c-hofer/chofer_torchex.git
git fetch --all --tags --prune
git checkout tags/icml2019_code_release -b icml2019_code_release
conda develop /tmp/chofer_torchex
A quick check if everything works can be done with
Expand Down
14 changes: 11 additions & 3 deletions docs/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -202,11 +202,19 @@ <h1>PyTorch extensions for persistent homology<a class="headerlink" href="#pytor
<span class="n">booktitle</span> <span class="o">=</span> <span class="p">{</span><span class="n">ICML</span><span class="p">},</span>
<span class="n">year</span> <span class="o">=</span> <span class="p">{</span><span class="mi">2019</span><span class="p">}}</span>

<span class="nd">@inproceedings</span><span class="p">{</span><span class="n">Hofer19b</span><span class="p">,</span>
<span class="n">author</span> <span class="o">=</span> <span class="p">{</span><span class="n">C</span><span class="o">.~</span><span class="n">Hofer</span><span class="p">,</span> <span class="n">R</span><span class="o">.~</span><span class="n">Kwitt</span> <span class="ow">and</span> <span class="n">M</span><span class="o">.~</span><span class="n">Niethammer</span><span class="p">},</span>
<span class="nd">@article</span><span class="p">{</span><span class="n">Hofer20a</span><span class="p">,</span>
<span class="n">author</span> <span class="o">=</span> <span class="p">{</span><span class="n">C</span><span class="o">.~</span><span class="n">Hofer</span><span class="p">,</span> <span class="n">F</span><span class="o">.~</span><span class="n">Graf</span><span class="p">,</span> <span class="n">B</span><span class="o">.~</span><span class="n">Rieck</span><span class="p">,</span> <span class="n">R</span><span class="o">.~</span><span class="n">Kwitt</span> <span class="ow">and</span> <span class="n">M</span><span class="o">.~</span><span class="n">Niethammer</span><span class="p">},</span>
<span class="n">title</span> <span class="o">=</span> <span class="p">{</span><span class="n">Graph</span> <span class="n">Filtration</span> <span class="n">Learning</span><span class="p">},</span>
<span class="n">booktitle</span> <span class="o">=</span> <span class="p">{</span><span class="n">arXiv</span><span class="p">},</span>
<span class="n">journal</span> <span class="o">=</span> <span class="p">{</span><span class="n">arXiv</span><span class="p">},</span>
<span class="n">note</span> <span class="o">=</span> <span class="p">{</span>\<span class="n">url</span><span class="p">{</span><span class="n">https</span><span class="p">:</span><span class="o">//</span><span class="n">arxiv</span><span class="o">.</span><span class="n">org</span><span class="o">/</span><span class="nb">abs</span><span class="o">/</span><span class="mf">1905.10996</span><span class="p">}},</span>
<span class="n">year</span> <span class="o">=</span> <span class="p">{</span><span class="mi">2019</span><span class="p">}}</span>

<span class="nd">@article</span><span class="p">{</span><span class="n">Hofer20b</span><span class="p">,</span>
<span class="n">author</span> <span class="o">=</span> <span class="p">{</span><span class="n">C</span><span class="o">.~</span><span class="n">Hofer</span><span class="p">,</span> <span class="n">F</span><span class="o">.~</span><span class="n">Graf</span><span class="p">,</span> <span class="n">M</span><span class="o">.~</span><span class="n">Niethammer</span> <span class="ow">and</span> <span class="n">R</span><span class="o">.~</span><span class="n">Kwitt</span><span class="p">},</span>
<span class="n">title</span> <span class="o">=</span> <span class="p">{</span><span class="n">Topologically</span> <span class="n">Densified</span> <span class="n">Distributions</span><span class="p">},</span>
<span class="n">journal</span> <span class="o">=</span> <span class="p">{</span><span class="n">arXiv</span><span class="p">},</span>
<span class="n">note</span> <span class="o">=</span> <span class="p">{</span>\<span class="n">url</span><span class="p">{</span><span class="n">https</span><span class="p">:</span><span class="o">//</span><span class="n">arxiv</span><span class="o">.</span><span class="n">org</span><span class="o">/</span><span class="nb">abs</span><span class="o">/</span><span class="mf">2002.04805</span><span class="p">}},</span>
<span class="n">year</span> <span class="o">=</span> <span class="p">{</span><span class="mi">2020</span><span class="p">}}</span>
</pre></div>
</div>
<div class="admonition note">
Expand Down
18 changes: 8 additions & 10 deletions docs/install/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -191,32 +191,30 @@ <h1>Installation<a class="headerlink" href="#installation" title="Permalink to t
<p>The following setup was tested with the following system configuration:</p>
<ul class="simple">
<li><p>Ubuntu 18.04.2 LTS</p></li>
<li><p>CUDA 10 (driver version 410.48)</p></li>
<li><p>Anaconda (Python 3.7)</p></li>
<li><p>PyTorch 1.1</p></li>
<li><p>CUDA 10.1 (driver version 418.87.00)</p></li>
<li><p>Anaconda (Python 3.7.6)</p></li>
<li><p>PyTorch 1.4</p></li>
</ul>
<p>In the following, we assume that we work in <code class="docutils literal notranslate"><span class="pre">/tmp</span></code> (obviously, you have to
change this to reflect your choice and using <code class="docutils literal notranslate"><span class="pre">/tmp</span></code> is, of course, not
the best choice :).</p>
<p>First, get the Anaconda installer and install Anaconda (in <code class="docutils literal notranslate"><span class="pre">/tmp/anaconda3</span></code>)
using</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="nb">cd</span> /tmp/
wget https://repo.anaconda.com/archive/Anaconda3-2019.03-Linux-x86_64.sh
bash Anaconda3-2019.03-Linux-x86_64.sh
<span class="c1"># specify /tmp/anconda3 as your installation path</span>
wget https://repo.anaconda.com/archive/Anaconda3-2019.10-Linux-x86_64.sh
bash Anaconda3-2019.10-Linux-x86_64.sh
<span class="c1"># specify /tmp/anaconda3 as your installation path</span>
<span class="nb">source</span> /tmp/anaconda3/bin/activate
</pre></div>
</div>
<p>Second, we install PyTorch (v1.1) using</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>conda install pytorch torchvision <span class="nv">cudatoolkit</span><span class="o">=</span><span class="m">10</span>.0 -c pytorch
<p>Second, we install PyTorch (v1.4) using</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>conda install pytorch torchvision <span class="nv">cudatoolkit</span><span class="o">=</span><span class="m">10</span>.1 -c pytorch
</pre></div>
</div>
<p>Third, we clone the <code class="docutils literal notranslate"><span class="pre">chofer_torchex</span></code> repository from GitHub and make
it available within Anaconda.</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="nb">cd</span> /tmp/
git clone https://github.com/c-hofer/chofer_torchex.git
git fetch --all --tags --prune
git checkout tags/icml2019_code_release -b icml2019_code_release
conda develop /tmp/chofer_torchex
</pre></div>
</div>
Expand Down
2 changes: 1 addition & 1 deletion docs/searchindex.js
View file

Large diffs are not rendered by default.

14 changes: 11 additions & 3 deletions docs_src/source/index.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,12 +22,20 @@ the following publications are most relevant::
booktitle = {ICML},
year = {2019}}

@inproceedings{Hofer19b,
author = {C.~Hofer, R.~Kwitt and M.~Niethammer},
@article{Hofer20a,
author = {C.~Hofer, F.~Graf, B.~Rieck, R.~Kwitt and M.~Niethammer},
title = {Graph Filtration Learning},
booktitle = {arXiv},
journal = {arXiv},
note = {\url{https://arxiv.org/abs/1905.10996}},
year = {2019}}

@article{Hofer20b,
author = {C.~Hofer, F.~Graf, M.~Niethammer and R.~Kwitt},
title = {Topologically Densified Distributions},
journal = {arXiv},
note = {\url{https://arxiv.org/abs/2002.04805}},
year = {2020}}

.. note::
Note that not all of the available functionality is exposed in the
documentation yet.
Expand Down
18 changes: 8 additions & 10 deletions docs_src/source/install/index.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@ Installation
The following setup was tested with the following system configuration:

* Ubuntu 18.04.2 LTS
* CUDA 10 (driver version 410.48)
* Anaconda (Python 3.7)
* PyTorch 1.1
* CUDA 10.1 (driver version 418.87.00)
* Anaconda (Python 3.7.6)
* PyTorch 1.4

In the following, we assume that we work in ``/tmp`` (obviously, you have to
change this to reflect your choice and using ``/tmp`` is, of course, not
Expand All @@ -18,16 +18,16 @@ using
.. code-block:: bash
cd /tmp/
wget https://repo.anaconda.com/archive/Anaconda3-2019.03-Linux-x86_64.sh
bash Anaconda3-2019.03-Linux-x86_64.sh
# specify /tmp/anconda3 as your installation path
wget https://repo.anaconda.com/archive/Anaconda3-2019.10-Linux-x86_64.sh
bash Anaconda3-2019.10-Linux-x86_64.sh
# specify /tmp/anaconda3 as your installation path
source /tmp/anaconda3/bin/activate
Second, we install PyTorch (v1.1) using
Second, we install PyTorch (v1.4) using

.. code-block:: bash
conda install pytorch torchvision cudatoolkit=10.0 -c pytorch
conda install pytorch torchvision cudatoolkit=10.1 -c pytorch
Third, we clone the ``chofer_torchex`` repository from GitHub and make
Expand All @@ -37,8 +37,6 @@ it available within Anaconda.
cd /tmp/
git clone https://github.com/c-hofer/chofer_torchex.git
git fetch --all --tags --prune
git checkout tags/icml2019_code_release -b icml2019_code_release
conda develop /tmp/chofer_torchex
A quick check if everything works can be done with
Expand Down

0 comments on commit 766af10

Please sign in to comment.