From 6ac091fbe2aa4008a0562afa8045c6911c172b51 Mon Sep 17 00:00:00 2001 From: lltcggie Date: Sun, 27 Dec 2015 08:37:04 +0900 Subject: [PATCH] Update README.md --- README.md | 107 ++++++++++++++++++++++++++++++++++++++++++++++-------- 1 file changed, 91 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index 2d44936..2e4e84d 100644 --- a/README.md +++ b/README.md @@ -7,6 +7,8 @@ waifu2x-caffe (for Windows) [Caffe](http://caffe.berkeleyvision.org/)を用いて書き直し、Windows向けにビルドしたソフトです。 CPUで変換することも出来ますが、CUDA(あるいはcuDNN)を使うとCPUより高速に変換することが出来ます。 +GUI supports English and Japanese. + 要求環境 ---------- @@ -39,7 +41,7 @@ cuDNNを使わなくてもCUDAで変換出来ますが、cuDNNを使うと以下 このような利点があるcuDNNですが、ライセンスの関係上動作に必要なファイルを配布することが出来ません。 なので、cuDNNを使いたい人は[こちらのページ](https://developer.nvidia.com/cuDNN)でWindows向けバイナリ(v3以降)をダウンロードし、 -「cudnn64_70.dll」をwaifu2x-caffeのフォルダに入れて下さい。 +「cudnn64_4.dll」をwaifu2x-caffeのフォルダに入れて下さい。 なお、ソフトを起動している最中にdllを入れた場合はソフトを起動しなおしてください。 (cuDNNをダウンロードするにはNVIDIA Developerへの登録とCUDA Registered Developersへの登録が必要です。 CUDA Registered Developersはおそらく(簡単な)審査があるっぽいので登録してもすぐにcuDNNをダウンロード出来るわけではありません。) @@ -81,6 +83,42 @@ cuDNN 好みに合わせて変換設定を変更することが出来ます。 +##入出力設定 + ファイルの入出力に関する設定項目群です。 + +###「入力パス」 + 変換したいファイルのパスを指定します。 + フォルダを指定した場合は、サブフォルダ内も含めた「フォルダ内の変換する拡張子」が付くファイルを変換対象とします。 + +###「出力パス」 + 変換後の画像を保存するパスを指定します。 + 「入力パス」で フォルダを指定した場合は、指定したフォルダの中に変換したファイルを(フォルダ構造をそのままで)保存します。指定したフォルダがない場合は自動で作成します。 + +###「フォルダ内の変換する拡張子」 + 「入力パス」がフォルダの場合の、フォルダ内の変換する画像の拡張子を指定します。 + デフォルト値は`png:jpg:jpeg:tif:tiff:bmp:tga`です。 + また、区切り文字は`:`です。 + 大文字小文字は区別しません。 + 例. png:jpg:jpeg:tif:tiff:bmp:tga + +###「出力拡張子」 + 変換後の画像の形式を指定します。 + 「出力画質設定」と「出力深度ビット数」に設定できる値はここで指定する形式により異なります。 + +###「出力画質設定」 + 変換後の画像の画質を指定します。 + 指定できる値の範囲と意味は「出力拡張子」で設定した形式により異なります。 + + * .jpg : 値の範囲(0～100) 数字が高いほど高画質 + * .webp : 値の範囲(1～100) 数字が高いほど高画質 100だと可逆圧縮 + +###「出力深度ビット数」 + 変換後の画像の1チャンネルあたりのビット数を指定します + 指定できる値は「出力拡張子」で設定した形式により異なります。 + +##変換画質・処理設定 + ファイル変換の処理方法、画質に関する設定項目群です。 + ###「変換モード」 変換モードを指定します。 * ノイズ除去と拡大 : ノイズ除去と拡大を行います @@ -94,33 +132,43 @@ cuDNN ###「拡大率」 拡大率を指定します。 -###「出力拡張子」 - 出力拡張子を指定します。 - -###「プロセッサー」 - 変換を行うプロセッサーを指定します。 - * CUDA(使えたらcuDNN) : CUDA(GPU)を使って変換を行います(cuDNNが使えるならcuDNNが使われます) - * CPU : CPUのみを使って変換を行います - ###「モデル」 使用するモデルを指定します。 + 変換対象の画像によって最適なモデルは異なるので、様々なモデルを試してみることをおすすめします。 * 2次元イラスト(RGBモデル) : 画像のRGBすべてを変換する2次元イラスト用モデル * 写真・アニメ(Photoモデル) : 写真・アニメ用のモデル * 2次元イラスト(Yモデル) : 画像の輝度のみを変換する2次元イラスト用モデル +###「TTAモードを使う」 + TTA(Test-Time Augmentation)モードを使うかどうかを指定します。 + TTAモードを使うと変換が8倍遅くなる代わりに、PSNR(画像の評価指数の一つ)が0.15くらい上がるそうです。 + +##処理速度設定 + 画像変換の処理速度に影響する設定項目群です。 + +###「プロセッサー」 + 変換を行うプロセッサーを指定します。 + * CUDA(使えたらcuDNN) : CUDA(GPU)を使って変換を行います(cuDNNが使えるならcuDNNが使われます) + * CPU : CPUのみを使って変換を行います + ###「分割サイズ」 内部で分割して処理を行う際の幅（ピクセル単位）を指定します。 最適な(処理が最速で終わる)数値の決め方は「分割サイズ」の項で説明します。 「-------」で区切られている上の方は入力された画像の縦横サイズの約数、 下の方は「crop_size_list.txt」から読み出した汎用的な分割サイズです。 - 同じ画像サイズの画像をフォルダ指定で大量に変換するときは、最適な分割サイズを調べてから変換することをおすすめします。 + 分割サイズが大きすぎる場合、要求されるメモリの量(GPUを使う場合はVRAMの量)がPCで使用できるメモリを超えてソフトが強制終了するので気をつけてください。 + 処理速度にそれなりに影響するので、同じ画像サイズの画像をフォルダ指定で大量に変換するときは、最適な分割サイズを調べてから変換することをおすすめします。 -###「TTAモードを使う」 - TTA(Test-Time Augmentation)モードを使うかどうかを指定します。 - TTAモードを使うと変換が8倍遅くなる代わりに、PSNR(画像の評価指数の一つ)が0.15くらい上がるそうです。 +##その他 + 画像変換の処理速度に影響する設定項目群です。 -「cuDNNチェック」ボタンを押すとcuDNNが使えるか調べることが出来ます。 -cuDNNが使えない場合は理由が表示されます。 +###「UIの言語」 + UIの言語を設定します。 + 初回起動時はPCの言語設定と同じ言語が選ばれます。(存在しない場合は英語になります) + +###「cuDNNチェック」 + 「cuDNNチェック」ボタンを押すとcuDNNが使えるか調べることが出来ます。 + cuDNNが使えない場合は理由が表示されます。 「実行」ボタンを押すと変換が始まります。 途中でキャンセルしたい場合は「キャンセル」ボタンを押します。 @@ -207,6 +255,15 @@ waifu2x-caffe-cui.exe -i mywaifu.png -m noise_scale --scale_ratio 1.6 --noise_le ###-c <整数>, --crop_size <整数> 分割サイズを指定します。デフォルト値は`128`です。 +###-q <整数>, --output_quality <整数> + 変換後の画像の画質を設定します。デフォルト値は`-1`です + 指定できる値と意味は「出力拡張子」で設定した形式により異なります。 + -1の場合は、各画像形式のデフォルト値が使われます。 + +###-d <整数>, --output_depth <整数> + 変換後の画像の1チャンネルあたりのビット数を指定します。デフォルト値は`8`です。 + 指定できる値は「出力拡張子」で設定した形式により異なります。 + ###-b <整数>, --batch_size <整数> mini-batchサイズを指定します。デフォルト値は`1`です。 mini-batchサイズは画像を「分割サイズ」で分割したブロックを同時に処理する数のことです。例えば`2`を指定した場合、2ブロックずつ変換していきます。 @@ -252,6 +309,25 @@ CUDAで変換中でもGPUを使い切れていない（GPUの使用率が100%近 しかし、アルファチャンネルを単体で拡大する処理になっているため、アルファチャンネル付き画像の拡大は無い場合と比べておよそ2倍の時間がかかるので注意してください。 + The format of language files +-------- + +Language files format is JSON. +If you create new language file, add language setting to 'lang/LangList.txt'. +'lang/LangList.txt' format is TSV(Tab-Separated Values). + + * LangName : Language name + * LangID : Primary language [See MSDN](https://msdn.microsoft.com/en-us/library/windows/desktop/dd318693.aspx) + * SubLangID : Sublanguage [See MSDN](https://msdn.microsoft.com/en-us/library/windows/desktop/dd318693.aspx) + * FileName : Language file name + +ex. + + * Japanese LangID : 0x11(LANG_JAPANESE), SubLangID : 0x01(SUBLANG_JAPANESE_JAPAN) + * English(US) LangID : 0x09(LANG_ENGLISH), SubLangID : 0x01(SUBLANG_ENGLISH_US) + * English(UK) LangID : 0x09(LANG_ENGLISH), SubLangID : 0x02(SUBLANG_ENGLISH_UK) + + おことわり ------------ @@ -265,4 +341,3 @@ CUDAで変換中でもGPUを使い切れていない（GPUの使用率が100%近 オリジナルの[waifu2x](https://github.com/nagadomi/waifu2x)、及びモデルの制作を行い、MITライセンスの下で公開して下さった [ultraist](https://twitter.com/ultraistter)さん、 オリジナルのwaifu2xを元に[waifu2x-converter](https://github.com/WL-Amigo/waifu2x-converter-cpp)を作成して下さった [アミーゴ](https://twitter.com/WL_Amigo)さん(READMEやLICENSE.txtの書き方、OpenCVの使い方等かなり参考にさせていただきました) に、感謝します。 -