Skip to content
This repository was archived by the owner on Jan 2, 2021. It is now read-only.

Commit 29bfe58

Browse files
committed
Merged documentation changes.
1 parent 9a228c1 commit 29bfe58

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

README.rst

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -37,14 +37,14 @@ The default is to use ``--device=cpu``, if you have NVIDIA card setup with CUDA
3737

3838
.. code:: bash
3939
40-
# Run the super-resolution script for one image.
41-
python3 enhance.py example.png
40+
# Run the super-resolution script for one image, factor 1:1.
41+
python3 enhance.py --zoom=1 example.png
4242
43-
# Also process multiple files with a single run.
44-
python3 enhance.py file1.jpg file2.jpg
43+
# Also process multiple files with a single run, factor 2:1.
44+
python3 enhance.py --zoom=2 file1.jpg file2.jpg
4545
46-
# Display output images that were given `_ne4x.png` suffix.
47-
open *_ne4x.png
46+
# Display output images that were given `_ne?x.png` suffix.
47+
open *_ne?x.png
4848
4949
5050
1.b) Training Super-Resolution
@@ -89,19 +89,19 @@ The easiest way to get up-and-running is to `install Docker <https://www.docker.
8989
.. code:: bash
9090
9191
# Setup the alias. Put this in your .bashrc or .zshrc file so it's available at startup.
92-
alias enhance='function ne() { docker run -v $(PWD)/`dirname $1`:/ne/input -it alexjc/neural-enhance input/`basename $1`; }; ne'
92+
alias enhance='function ne() { docker run --rm -v "$(pwd)/`dirname ${@:$#}`":/ne/input -it alexjc/neural-enhance ${@:1:-1} "input/`basename ${@:$#}`"; }; ne'
9393
9494
# Now run any of the examples above using this alias, without the `.py` extension.
95-
enhance images/example.jpg
95+
enhance --zoom=1 --model=small images/example.jpg
9696
9797
**Multiple Images** — To enhance multiple images in a row (faster) from a folder or widlcard specification, make sure to quote the argument to the alias command:
9898

9999
.. code:: bash
100100
101101
# Process multiple images, make sure to quote the argument!
102-
enhance "images/*.jpg"
102+
enhance --zoom=2 --model=small "images/*.jpg"
103103
104-
If you want to run on your NVIDIA GPU, you can instead use the image ``alexjc/neural-enhance:gpu`` which comes with CUDA and CUDNN pre-installed in the image. Then run it within `nvidia-docker <https://github.com/NVIDIA/nvidia-docker>`_ and it should use your physical hardware!
104+
If you want to run on your NVIDIA GPU, you can instead change the alias to use the image ``alexjc/neural-enhance:gpu`` which comes with CUDA and CUDNN pre-installed. Then run it within `nvidia-docker <https://github.com/NVIDIA/nvidia-docker>`_ and it should use your physical hardware!
105105

106106

107107
2.b) Manual Installation [developers]

0 commit comments

Comments
 (0)