diff --git a/README.md b/README.md index 23e2382..77b7cf1 100644 --- a/README.md +++ b/README.md @@ -112,10 +112,10 @@ CUDA UpRGBモデル 好みに合わせて変換設定を変更することが出来ます。 -##入出力設定 +## 入出力設定 ファイルの入出力に関する設定項目群です。 -###「入力パス」 +### 「入力パス」 変換したいファイルのパスを指定します。 フォルダを指定した場合は、サブフォルダ内も含めた「フォルダ内の変換する拡張子」が付くファイルを変換対象とします。 複数のファイル、フォルダをドラッグで指定することが出来ます。 @@ -123,22 +123,22 @@ CUDA UpRGBモデル （入力パス欄には「(Multi Files)」と表示されます。出力フォルダ名はマウスで掴んでいたファイル、フォルダ名から生成されます） 参照ボタンを押してファイルを選択する場合、単体のファイル、フォルダか、複数のファイルが選択できます。 -###「出力パス」 +### 「出力パス」 変換後の画像を保存するパスを指定します。 「入力パス」で フォルダを指定した場合は、指定したフォルダの中に変換したファイルを(フォルダ構造をそのままで)保存します。指定したフォルダがない場合は自動で作成します。 -###「フォルダ内の変換する拡張子」 +### 「フォルダ内の変換する拡張子」 「入力パス」がフォルダの場合の、フォルダ内の変換する画像の拡張子を指定します。 デフォルト値は`png:jpg:jpeg:tif:tiff:bmp:tga`です。 また、区切り文字は`:`です。 大文字小文字は区別しません。 例. png:jpg:jpeg:tif:tiff:bmp:tga -###「出力拡張子」 +### 「出力拡張子」 変換後の画像の形式を指定します。 「出力画質設定」と「出力深度ビット数」に設定できる値はここで指定する形式により異なります。 -###「出力画質設定」 +### 「出力画質設定」 変換後の画像の画質を指定します。 設定できる値は整数です。 指定できる値の範囲と意味は「出力拡張子」で設定した形式により異なります。 @@ -147,24 +147,24 @@ CUDA UpRGBモデル * .webp : 値の範囲(1～100) 数字が高いほど高画質 100だと可逆圧縮 * .tga : 値の範囲(0～1) 0なら圧縮なし、1ならRLE圧縮 -###「出力深度ビット数」 +### 「出力深度ビット数」 変換後の画像の1チャンネルあたりのビット数を指定します。 指定できる値は「出力拡張子」で設定した形式により異なります。 -##変換画質・処理設定 +## 変換画質・処理設定 ファイル変換の処理方法、画質に関する設定項目群です。 -###「変換モード」 +### 「変換モード」 変換モードを指定します。 * ノイズ除去と拡大 : ノイズ除去と拡大を行います * 拡大 : 拡大を行います * ノイズ除去 : ノイズ除去を行います * ノイズ除去(自動判別)と拡大 : 拡大を行います。入力がJPEG画像の場合のみノイズ除去も行います -###「JPEGノイズ除去レベル」 +### 「JPEGノイズ除去レベル」 ノイズ除去レベルを指定します。レベルの高いほうがより強力にノイズを除去しますが、のっぺりとした絵になる可能性もあります。 -###「拡大サイズ」 +### 「拡大サイズ」 拡大後のサイズの設定を行います。 * 拡大率で指定 : 画像を指定の拡大率で拡大します * 変換後の横幅で指定 : 画像の縦横比を維持したまま、指定された横幅になるように拡大します(単位はピクセル) @@ -172,7 +172,7 @@ CUDA UpRGBモデル * 変換後の縦横幅で指定 : 指定された縦横幅になるように拡大します。「1920x1080」のように指定します(単位はピクセル) 2倍を超える拡大率の場合、(ノイズを除去する場合は最初の1回だけ行い)指定された拡大率を超えるまで2倍ずつ拡大し、2の累乗倍でない拡大率の場合は最後に縮小するという処理を行います。そのため変換結果がのっぺりとした絵になる可能性があります。 -###「モデル」 +### 「モデル」 使用するモデルを指定します。 変換対象の画像によって最適なモデルは異なるので、様々なモデルを試してみることをおすすめします。 * 2次元イラスト(RGBモデル) : 画像のRGBすべてを変換する2次元イラスト用モデル @@ -181,14 +181,14 @@ CUDA UpRGBモデル * 写真・アニメ(UpPhotoモデル) : 写真・アニメ(Photoモデル)より高速かつ同等以上の画質で変換するモデル。ただしPhotoモデルより消費するメモリ(VRAM)の量が多いので、変換中に強制終了する場合は分割サイズを調節すること * 2次元イラスト(Yモデル) : 画像の輝度のみを変換する2次元イラスト用モデル -###「TTAモードを使う」 +### 「TTAモードを使う」 TTA(Test-Time Augmentation)モードを使うかどうかを指定します。 TTAモードを使うと変換が8倍遅くなる代わりに、PSNR(画像の評価指数の一つ)が0.15くらい上がるそうです。 -##処理速度設定 +## 処理速度設定 画像変換の処理速度に影響する設定項目群です。 -###「分割サイズ」 +### 「分割サイズ」 内部で分割して処理を行う際の幅（ピクセル単位）を指定します。 最適な(処理が最速で終わる)数値の決め方は「分割サイズ」の項で説明します。 「-------」で区切られている上の方は入力された画像の縦横サイズの約数、 @@ -196,47 +196,47 @@ CUDA UpRGBモデル 分割サイズが大きすぎる場合、要求されるメモリの量(GPUを使う場合はVRAMの量)がPCで使用できるメモリを超えてソフトが強制終了するので気をつけてください。 処理速度にそれなりに影響するので、同じ画像サイズの画像をフォルダ指定で大量に変換するときは、最適な分割サイズを調べてから変換することをおすすめします。 -##動作設定 +## 動作設定 あまり変更する機会がないと思われる動作設定をまとめた設定群です。 -###「ファイル入力時自動変換開始設定」 +### 「ファイル入力時自動変換開始設定」 参照ボタンやドラッグアンドドロップで入力ファイルを指定した際に自動で変換を開始するのか設定を行います。 exeに入力ファイルを引数で与えた場合ではこの項目の設定内容は影響しません。 * 自動で開始しない : ファイルを入力しても自動で変換を開始しません * ファイルを1つでも入力したら開始 : ファイルを1つでも入力したら自動で変換を開始します * フォルダあるいは複数ファイルを入力したら開始 : フォルダ、複数ファイルを入力したら自動で変換を開始します。単体の画像ファイルを変換するのは変換設定の調節を行うときだけだ、という時にどうぞ -###「使用プロセッサー」 +### 「使用プロセッサー」 変換を行うプロセッサーを指定します。 * CUDA(使えたらcuDNN) : CUDA(GPU)を使って変換を行います(cuDNNが使える場合はcuDNNが使われます) * CPU : CPUのみを使って変換を行います -###「出力ファイルを上書きしない」 +### 「出力ファイルを上書きしない」 この設定がONの場合、画像の書き込み先に同名のファイルが存在する場合は変換を行いません。 -###「引数付き起動時設定」 +### 「引数付き起動時設定」 exeに入力ファイルを引数で与えた場合での動作を設定します。 * 起動時に変換する : 起動時に自動で変換を開始します * 成功時に終了する : 変換終了時に失敗していなければ自動で終了します -###「使用GPU No」 +### 「使用GPU No」 GPUが複数枚ある場合に使用するデバイス番号を指定できます。CPUモード時や無効なデバイス番号を指定した場合は無視されます。 -###「入力参照時固定フォルダ」 +### 「入力参照時固定フォルダ」 入力の参照ボタンを押した際に最初に表示されるフォルダをここで設定したフォルダに固定します。 -###「出力参照時固定フォルダ」 +### 「出力参照時固定フォルダ」 変換した画像の出力先フォルダをここで設定したフォルダに固定します。 また、出力の参照ボタンを押した際に最初に表示されるフォルダをここで設定したフォルダに固定します。 -##その他 +## その他 その他の設定項目群です。 -###「UIの言語」 +### 「UIの言語」 UIの言語を設定します。 初回起動時はPCの言語設定と同じ言語が選ばれます。(存在しない場合は英語になります) -###「cuDNNチェック」 +### 「cuDNNチェック」 「cuDNNチェック」ボタンを押すとcuDNNが使えるか調べることが出来ます。 cuDNNが使えない場合は理由が表示されます。 @@ -276,62 +276,62 @@ waifu2x-caffe-cui.exe -i mywaifu.png -m noise_scale --scale_ratio 1.6 --noise_le GUI版では入力ファイル以外のコマンドラインオプションを指定して起動した場合、現在オプションのファイル保存を行いません。 また、GUI版では指定されなかったオプションは前回終了時のオプションが使用されます。 -###-l <文字列>, --input_extention_list <文字列> +### -l <文字列>, --input_extention_list <文字列> input_fileがフォルダの場合の、フォルダ内の変換する画像の拡張子を指定します。 デフォルト値は`png:jpg:jpeg:tif:tiff:bmp:tga`です。 また、区切り文字は`:`です。 例. png:jpg:jpeg:tif:tiff:bmp:tga -###-e <文字列>, --output_extention <文字列> +### -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倍以外も指定できます。 scale_widthかscale_heightが指定された場合、そちらが優先されます。 2.0以外の数値を指定すると、次のような処理を行います。 * まず、指定された倍率を必要十分にカバーするように、2倍拡大を繰り返し行います。 * 2の累乗以外の数値が指定されている場合は、指定倍率になるように拡大した画像を線形フィルタで縮小します。 -###-w <整数>, --scale_width <整数> +### -w <整数>, --scale_width <整数> 画像の縦横比を維持したまま、指定された横幅になるように拡大します(単位はピクセル)。 scale_heightと同時に指定すると、指定された縦横幅になるように画像を拡大します。 -###-h <整数>, --scale_height <整数> +### -h <整数>, --scale_height <整数> 画像の縦横比を維持したまま、指定された縦幅になるように拡大します(単位はピクセル)。 scale_widthと同時に指定すると、指定された縦横幅になるように画像を拡大します。 -###-n <0|1|2|3>, --noise_level <0|1|2|3> +### -n <0|1|2|3>, --noise_level <0|1|2|3> ノイズ除去レベルを指定します。ノイズ除去用のモデルはレベル0～3のみ用意されているので、 0 か 1 か 2 か 3 を指定して下さい。 デフォルト値は`0`です。 -###-p , --process +### -p , --process 処理に使うプロセッサーを指定します。デフォルト値は`gpu`です。 * cpu : CPUを使って変換を行います。 * gpu : CUDA(GPU)を使って変換を行います。Windows版でのみ、cuDNNが使えるならcuDNNを使います。 * cudnn : cuDNNを使って変換を行います。 -###-c <整数>, --crop_size <整数> +### -c <整数>, --crop_size <整数> 分割サイズを指定します。デフォルト値は`128`です。 -###-q <整数>, --output_quality <整数> +### -q <整数>, --output_quality <整数> 変換後の画像の画質を設定します。デフォルト値は`-1`です 指定できる値と意味は「出力拡張子」で設定した形式により異なります。 -1の場合は、各画像形式のデフォルト値が使われます。 -###-d <整数>, --output_depth <整数> +### -d <整数>, --output_depth <整数> 変換後の画像の1チャンネルあたりのビット数を指定します。デフォルト値は`8`です。 指定できる値は「出力拡張子」で設定した形式により異なります。 -###-b <整数>, --batch_size <整数> +### -b <整数>, --batch_size <整数> mini-batchサイズを指定します。デフォルト値は`1`です。 mini-batchサイズは画像を「分割サイズ」で分割したブロックを同時に処理する数のことです。例えば`2`を指定した場合、2ブロックずつ変換していきます。 mini-batchサイズを大きくすると分割サイズを大きくするとの同様にGPUの使用率が高くなりますが、計測した感じだと分割サイズを大きくした方が効果が高いです。 @@ -343,10 +343,10 @@ GUI版では入力ファイル以外のコマンドラインオプションを 処理にGPUを使わない場合は無視されます。 また、存在しないGPUデバイス番号を指定した場合はデフォルトのGPUで実行されます。 -###-t <0|1>, --tta <0|1> +### -t <0|1>, --tta <0|1> `1`を指定するとTTAモードを使用します。デフォルト値は`0`です。 -###--, --ignore_rest +### --, --ignore_rest このオプションが指定された後の全てのオプションを無視します。 スクリプト・バッチファイル用です。 @@ -357,22 +357,22 @@ GUI版では入力ファイル以外のコマンドラインオプションを GUI版ではオプション指定に当てはまらなかった引数は入力ファイルとして認識されます。 入力ファイルはファイル、フォルダ、複数、ファイルとフォルダ同時に指定できます。 -###-o , --output_folder +### -o , --output_folder 変換された画像を保存するフォルダへのパスを設定します。 指定されたフォルダの中に変換後のファイルを保存します。 変換後のファイルの命名規則はGUIで入力ファイルを設定した時に自動で決定される出力ファイル名と同じです。 指定されなかった場合、ひとつ目の入力ファイルと同じフォルダに保存されます。 -###--auto_start <0|1> +### --auto_start <0|1> `1`を指定すると起動時に自動で変換を開始します。 -###--auto_exit <0|1> +### --auto_exit <0|1> `1`を指定すると、起動時に自動で変換した場合に変換が成功すると自動で終了します。 -###--no_overwrite <0|1> +### --no_overwrite <0|1> `1`を指定すると、画像の書き込み先に同名のファイルが存在する場合は変換を行いません。 -###-y , --model_type +### -y , --model_type 使用するモデルを指定します。 GUIでの設定項目「モデル」と以下のように対応しています。 * upconv_7_anime_style_art_rgb : 2次元イラスト(UpRGBモデル) @@ -385,18 +385,18 @@ GUI版ではオプション指定に当てはまらなかった引数は入力 コマンドラインオプション(CUI版) -------- -###--version +### --version バージョン情報を出力し、終了します。 -###-?, --help +### -?, --help 使い方を表示し、終了します。 手軽に使い方を確認したい時などにどうぞ。 -###-i <文字列>, --input_file <文字列> +### -i <文字列>, --input_file <文字列> (必須) 変換する画像へのパス フォルダを指定した場合、そのフォルダ以下の画像ファイルを全て変換してoutput_fileで指定したフォルダへ出力します。 -###-o , --output_file +### -o , --output_file 変換された画像を保存するファイルへのパス (input_fileがフォルダの場合)変換された画像を保存するフォルダへのパス (input_fileが画像ファイルの場合)拡張子(最後の.pngなど)は必ず入力するようにして下さい。 @@ -406,7 +406,7 @@ GUI版ではオプション指定に当てはまらなかった引数は入力 のようになっています。 保存される場所は、基本的には入力画像と同じディレクトリになります。 -###--model_dir <文字列> +### --model_dir <文字列> モデルが格納されているディレクトリへのパスを指定します。デフォルト値は`models/upconv_7_anime_style_art_rgb`です。 標準では以下のモデルが付属しています。 * `models/anime_style_art_rgb` : RGBすべてを変換する2次元画像用モデル @@ -417,11 +417,11 @@ GUI版ではオプション指定に当てはまらなかった引数は入力 * `models/ukbench` : 旧式の写真用モデル(拡大するモデルのみ付属しています。ノイズ除去は出来ません) 基本的には指定しなくても大丈夫です。デフォルト以外のモデルや自作のモデルを使用する時などに指定して下さい。 -###--crop_w <整数> +### --crop_w <整数> 分割サイズ(横幅)を指定します。設定しなかった場合はcrop_sizeの値が使用されます。 入力する画像の横幅の約数を指定するとより高速に変換できる可能性があります。 -###--crop_h <整数> +### --crop_h <整数> 分割サイズ(縦幅)を指定します。設定しなかった場合はcrop_sizeの値が使用されます。 入力する画像の縦幅の約数を指定するとより高速に変換できま可能性があります。