From e6b6a9bc100e088f7f65f3ac7075cc84956709c3 Mon Sep 17 00:00:00 2001 From: lltcggie Date: Mon, 29 Jun 2015 15:54:01 +0900 Subject: [PATCH] Update README.md --- README.md | 38 ++++++++++++++++++++++---------------- 1 file changed, 22 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index 1c3e68a..e8ddfa4 100644 --- a/README.md +++ b/README.md @@ -95,10 +95,16 @@ cuDNN 出力拡張子を指定します。 ###「プロセッサー」 - 変換を行うプロセッサーを指定します + 変換を行うプロセッサーを指定します。 * CPU : CPUのみを使って変換を行います * CUDA(使えたらcuDNN) : CUDA(GPU)を使って変換を行います(cuDNNが使えるならcuDNNが使われます) +###「モデル」 + 使用するモデルを指定します。 + * RGB : RGBすべてを変換する2次元画像用モデル + * Y(輝度のみ) : 輝度のみを変換する2次元画像用モデル + * 写真 : 写真用モデル(拡大するモデルのみ付属しています。ノイズ除去は出来ません) + ###「分割サイズ」 内部で分割して処理を行う際の幅（ピクセル単位）を指定します。 最適な(処理が最速で終わる)数値の決め方は「分割サイズ」の項で説明します。 @@ -135,49 +141,49 @@ waifu2x-caffe-cui.exe -i mywaifu.png -m noise_scale --scale_ratio 1.6 --noise_le 本ソフトでは、以下のオプションを指定することが出来ます。 - -i <文字列>, --input_file <文字列> +###-i <文字列>, --input_file <文字列> (必須) 変換する画像へのパス フォルダを指定した場合、そのフォルダ以下の画像ファイルを全て変換してoutput_fileで指定したフォルダへ出力します。 - -o , --output_file +###-o , --output_file 変換された画像を保存するファイルへのパス (input_fileがフォルダの場合)変換された画像を保存するフォルダへのパス (input_fileが画像ファイルの場合)拡張子(最後の.pngなど)は必ず入力するようにして下さい。 指定しなかった場合は自動でファイル名を決定し、そのファイルに保存します。 ファイル名の決定ルールは、 - `[元の画像ファイル名]``(モード名)``(ノイズ除去レベル(ノイズ除去モードの場合))``(拡大率(拡大モードの場合))``.png` + `[元の画像ファイル名]``(モード名)``(ノイズ除去レベル(ノイズ除去モードの場合))``(拡大率(拡大モードの場合))``.出力拡張子` のようになっています。 保存される場所は、基本的には入力画像と同じディレクトリになります。 - -l <文字列>, --input_extention_list <文字列> +###-l <文字列>, --input_extention_list <文字列> input_fileがフォルダの場合の、フォルダ内の変換する画像の拡張子を指定します。 デフォルト値は`png:jpg:bmp`です。 また、区切り文字は`:`です。 例. png:jpg:bmp - -l <文字列>, --input_extention_list <文字列> +###-e <文字列>, --output_extention <文字列> input_fileがフォルダの場合の、出力画像の拡張子を指定します。 デフォルト値は`png`です。 - -m , --mode +###-m , --mode 変換モードを指定します。指定しなかった場合は`noise_scale`が選択されます。 * noise : ノイズ除去を行います (正確には、ノイズ除去用のモデルを用いて画像変換を行います) * scale : 拡大を行います (正確には、既存アルゴリズムで拡大した後に、拡大画像補完用のモデルを用いて画像変換を行います) * noise_scale : ノイズ除去と拡大を行います (ノイズ除去を行った後に、引き続き拡大処理を行います) * auto_scale : 拡大を行います。入力がJPEG画像の場合のみノイズ除去も行います - -s <小数点付き数値>, --scale_ratio <小数点付き数値> +###-s <小数点付き数値>, --scale_ratio <小数点付き数値> 何倍に拡大するかを指定します。デフォルト値は`2.0`ですが、2.0倍以外も指定できます。 2.0以外の数値を指定すると、次のような処理を行います。 * まず、指定された倍率を必要十分にカバーするように、2倍拡大を繰り返し行います。 * 2の累乗以外の数値がしてされている場合は、指定倍率になるように拡大した画像を線形フィルタで縮小します。 - -n <1|2>, --noise_level <1|2> +###-n <1|2>, --noise_level <1|2> ノイズ除去レベルを指定します。ノイズ除去用のモデルはレベル1とレベル2のみ用意されているので、 1 もしくは 2 を指定して下さい。 デフォルト値は`1`です。 - --model_dir <文字列> +###--model_dir <文字列> モデルが格納されているディレクトリへのパスを指定します。デフォルト値は`models/anime_style_art_rgb`です。 標準では以下のモデルが付属しています。 * `models/anime_style_art_rgb` : RGBすべてを変換する2次元画像用モデル @@ -185,29 +191,29 @@ waifu2x-caffe-cui.exe -i mywaifu.png -m noise_scale --scale_ratio 1.6 --noise_le * `models/ukbench` : 写真用モデル(拡大するモデルのみ付属しています。ノイズ除去は出来ません) 基本的には指定しなくても大丈夫です。デフォルト以外のモデルや自作のモデルを使用する時などに指定して下さい。 - -p , --process +###-p , --process 処理に使うプロセッサーを指定します。デフォルト値は`gpu`です。 * cpu : CPUを使って変換を行います。 * gpu : CUDA(GPU)を使って変換を行います。Windows版でのみ、cuDNNが使えるならcuDNNを使います。 * cudnn : cuDNNを使って変換を行います。 - -c <整数>, --crop_size <整数> +###-c <整数>, --crop_size <整数> 分割サイズを指定します。デフォルト値は`128`です。 - -b <整数>, --batch_size <整数> +###-b <整数>, --batch_size <整数> mini-batchサイズを指定します。デフォルト値は`1`です。 mini-batchサイズは画像を「分割サイズ」で分割したブロックを同時に処理する数のことです。例えば`2`を指定した場合、2ブロックずつ変換していきます。 mini-batchサイズを大きくすると分割サイズを大きくするとの同様にGPUの使用率が高くなりますが、計測した感じだと分割サイズを大きくした方が効果が高いです。 (例えば分割サイズを`64`、mini-batchサイズを`4`にするより、分割サイズを`128`、mini-batchサイズを`1`にした方が処理が速く終わる) - --, --ignore_rest +###--, --ignore_rest このオプションが指定された後の全てのオプションを無視します。 スクリプト・バッチファイル用です。 - --version +###--version バージョン情報を出力し、終了します。 - -h, --help +###-h, --help 使い方を表示し、終了します。 手軽に使い方を確認したい時などにどうぞ。