Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
mattclifford1 committed Oct 9, 2023
1 parent f24467e commit 9c03919
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 2 deletions.
1 change: 1 addition & 0 deletions IQM_Vis/examples/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,5 @@
from .simple import run
from .dataset import run
from .all import run
from .kodak import run
import IQM_Vis.examples.images
12 changes: 10 additions & 2 deletions docs/getting_started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,15 @@ You can make a new environment by using anaconda (conda):
conda create -n IQM_Vis python=3.9 -y
conda activate IQM_Vis
Then install IQM-Vis from the PyPi index:
If you have a GPU and would like to use CUDA then at this point head over to the pytorch website and download the relevent packages e.g.

If you don't have a GPU then you can skip this step.

.. code-block:: bash
conda install pytorch==1.13.1 torchvision==0.14.1 torchaudio==0.13.1 pytorch-cuda=11.7 -c pytorch -c nvidia
Now we can install IQM-Vis from the PyPi index:

.. code-block:: bash
Expand All @@ -26,7 +34,7 @@ Run a demonstration example by running the python code:
.. code-block:: python
import IQM_Vis
IQM_Vis.examples.dataset.run()
IQM_Vis.make_UI()
Common Issues
Expand Down

0 comments on commit 9c03919

Please sign in to comment.