From 48c4d4a1e453cfb928f1888b90c071769c4159c0 Mon Sep 17 00:00:00 2001 From: lltcggie Date: Sat, 7 May 2016 17:14:07 +0900 Subject: [PATCH] Update README.md --- README.md | 133 +++++++++++++++++++++++++++++++++++++++--------------- 1 file changed, 97 insertions(+), 36 deletions(-) diff --git a/README.md b/README.md index 0d5f390..1375934 100644 --- a/README.md +++ b/README.md @@ -77,9 +77,11 @@ cuDNN 「waifu2x-caffe.exe」はGUIソフトです。ダブルクリックで起動します。 またはエクスプローラで「waifu2x-caffe.exe」にファイルやフォルダをドラッグ&ドロップで放り込むと、前回起動時の設定で変換を行います。 -その場合、変換に成功したら自動でダイアログが閉じられます。 +その場合、設定によっては変換に成功したら自動でダイアログが閉じられます。 +また、GUIでもコマンドラインによるオプション設定を行うことが出来ます。 +詳しくはコマンドラインオプション(共通)とコマンドラインオプション(GUI版)の項をお読みください。 -「入力パス」欄に画像かフォルダをドラッグ&ドロップで放り込むと「出力パス」欄が自動で設定されます。 +起動後、「入力パス」欄に画像かフォルダをドラッグ&ドロップで放り込むと「出力パス」欄が自動で設定されます。 出力先を変えたい場合は「出力パス」欄を変更して下さい。 好みに合わせて変換設定を変更することが出来ます。 @@ -124,12 +126,6 @@ cuDNN 変換後の画像の1チャンネルあたりのビット数を指定します。 指定できる値は「出力拡張子」で設定した形式により異なります。 -###「自動変換開始設定」 - ファイルを入力した際に自動で変換を開始するのか設定を行います。 - * 自動で開始しない : ファイルを入力しても自動で変換を開始しません - * ファイルを1つでも入力したら開始 : ファイルを1つでも入力したら自動で変換を開始します - * フォルダあるいは複数ファイルを入力したら開始 : フォルダ、複数ファイルを入力したら自動で変換を開始します。単体の画像ファイルを変換するのは変換設定の調節を行うときだけだ、という時にどうぞ - ##変換画質・処理設定 ファイル変換の処理方法、画質に関する設定項目群です。 @@ -164,11 +160,6 @@ cuDNN ##処理速度設定 画像変換の処理速度に影響する設定項目群です。 -###「プロセッサー」 - 変換を行うプロセッサーを指定します。 - * CUDA(使えたらcuDNN) : CUDA(GPU)を使って変換を行います(cuDNNが使えるならcuDNNが使われます) - * CPU : CPUのみを使って変換を行います - ###「分割サイズ」 内部で分割して処理を行う際の幅（ピクセル単位）を指定します。 最適な(処理が最速で終わる)数値の決め方は「分割サイズ」の項で説明します。 @@ -177,6 +168,36 @@ cuDNN 分割サイズが大きすぎる場合、要求されるメモリの量(GPUを使う場合はVRAMの量)がPCで使用できるメモリを超えてソフトが強制終了するので気をつけてください。 処理速度にそれなりに影響するので、同じ画像サイズの画像をフォルダ指定で大量に変換するときは、最適な分割サイズを調べてから変換することをおすすめします。 +##動作設定 + あまり変更する機会がないと思われる動作設定をまとめた設定群です。 + +###「ファイル入力時自動変換開始設定」 + 参照ボタンやドラッグアンドドロップで入力ファイルを指定した際に自動で変換を開始するのか設定を行います。 + exeに入力ファイルを引数で与えた場合ではこの項目の設定内容は影響しません。 + * 自動で開始しない : ファイルを入力しても自動で変換を開始しません + * ファイルを1つでも入力したら開始 : ファイルを1つでも入力したら自動で変換を開始します + * フォルダあるいは複数ファイルを入力したら開始 : フォルダ、複数ファイルを入力したら自動で変換を開始します。単体の画像ファイルを変換するのは変換設定の調節を行うときだけだ、という時にどうぞ + +###「使用プロセッサー」 + 変換を行うプロセッサーを指定します。 + * CUDA(使えたらcuDNN) : CUDA(GPU)を使って変換を行います(cuDNNが使えるならcuDNNが使われます) + * CPU : CPUのみを使って変換を行います + +###「出力ファイルを上書きしない」 + この設定がONの場合、画像の書き込み先に同名のファイルが存在する場合は変換を行いません。 + +###「引数付き起動時設定」 + exeに入力ファイルを引数で与えた場合での動作を設定します。 + * 起動時に変換する : 起動時に自動で変換を開始します + * 成功時に終了する : 変換終了時に失敗していなければ自動で終了します + +###「入力参照時固定フォルダ」 + 入力の参照ボタンを押した際に最初に表示されるフォルダをここで設定したフォルダに固定します。 + +###「出力参照時固定フォルダ」 + 変換した画像の出力先フォルダをここで設定したフォルダに固定します。 + また、出力の参照ボタンを押した際に最初に表示されるフォルダをここで設定したフォルダに固定します。 + ##その他 その他の設定項目群です。 @@ -192,7 +213,8 @@ cuDNN 途中でキャンセルしたい場合は「キャンセル」ボタンを押します。 ただし、実際に停止するまでタイムラグがあります。 プログレスバーは複数枚の画像を変更した際の進行度合いを示しています。 -ログに残り予想時間が表示されますが、これは同じ縦幅、横幅の複数ファイルを処理したときの予想なので、処理する画像が1枚の時やファイルの大きさがバラバラな場合は役に立ちません。 +ログに残り予想時間が表示されますが、これは同じ縦幅、横幅の複数ファイルを処理したときの予想です。 +なので、ファイルの大きさがバラバラな場合は役に立ちませんし、処理する画像が2枚以下の時は「不明」としか表示されません。 使い方(CUI版) @@ -213,22 +235,15 @@ waifu2x-caffe-cui.exe -i mywaifu.png -m noise_scale --scale_ratio 1.6 --noise_le ``` 以上を実行すると、`mywaifu(noise_scale)(Level2)(x1.600000).png`に変換結果が保存されます。 +コマンドリスト、各コマンドの詳細はコマンドラインオプション(共通)とコマンドラインオプション(CUI版)の項をお読みください。 + + + コマンドラインオプション(共通) +-------- 本ソフトでは、以下のオプションを指定することが出来ます。 - -###-i <文字列>, --input_file <文字列> - (必須) 変換する画像へのパス - フォルダを指定した場合、そのフォルダ以下の画像ファイルを全て変換してoutput_fileで指定したフォルダへ出力します。 - -###-o , --output_file - 変換された画像を保存するファイルへのパス - (input_fileがフォルダの場合)変換された画像を保存するフォルダへのパス - (input_fileが画像ファイルの場合)拡張子(最後の.pngなど)は必ず入力するようにして下さい。 - 指定しなかった場合は自動でファイル名を決定し、そのファイルに保存します。 - ファイル名の決定ルールは、 - `[元の画像ファイル名]``(モード名)``(ノイズ除去レベル(ノイズ除去モードの場合))``(拡大率(拡大モードの場合))``.出力拡張子` - のようになっています。 - 保存される場所は、基本的には入力画像と同じディレクトリになります。 +GUI版では入力ファイル以外のコマンドラインオプションを指定して起動した場合、現在オプションのファイル保存を行いません。 +また、GUI版では指定されなかったオプションは前回終了時のオプションが使用されます。 ###-l <文字列>, --input_extention_list <文字列> input_fileがフォルダの場合の、フォルダ内の変換する画像の拡張子を指定します。 @@ -267,14 +282,6 @@ waifu2x-caffe-cui.exe -i mywaifu.png -m noise_scale --scale_ratio 1.6 --noise_le 1 か 2 か 3 を指定して下さい。 デフォルト値は`1`です。 -###--model_dir <文字列> - モデルが格納されているディレクトリへのパスを指定します。デフォルト値は`models/anime_style_art_rgb`です。 - 標準では以下のモデルが付属しています。 - * `models/anime_style_art_rgb` : RGBすべてを変換する2次元画像用モデル - * `models/anime_style_art` : 輝度のみを変換する2次元画像用モデル - * `models/ukbench` : 写真用モデル(拡大するモデルのみ付属しています。ノイズ除去は出来ません) - 基本的には指定しなくても大丈夫です。デフォルト以外のモデルや自作のモデルを使用する時などに指定して下さい。 - ###-p , --process 処理に使うプロセッサーを指定します。デフォルト値は`gpu`です。 * cpu : CPUを使って変換を行います。 @@ -306,6 +313,39 @@ waifu2x-caffe-cui.exe -i mywaifu.png -m noise_scale --scale_ratio 1.6 --noise_le このオプションが指定された後の全てのオプションを無視します。 スクリプト・バッチファイル用です。 + + コマンドラインオプション(GUI版) +-------- + +GUI版ではオプション指定に当てはまらなかった引数は入力ファイルとして認識されます。 +入力ファイルはファイル、フォルダ、複数、ファイルとフォルダ同時に指定できます。 + +###-o , --output_folder + 変換された画像を保存するフォルダへのパスを設定します。 + 指定されたフォルダの中に変換後のファイルを保存します。 + 変換後のファイルの命名規則はGUIで入力ファイルを設定した時に自動で決定される出力ファイル名と同じです。 + 指定されなかった場合、ひとつ目の入力ファイルと同じフォルダに保存されます。 + +###--auto_start <0|1> + `1`を指定すると起動時に自動で変換を開始します。 + +###--auto_exit <0|1> + `1`を指定すると、起動時に自動で変換した場合に変換が成功すると自動で終了します。 + +###--no_overwrite <0|1> + `1`を指定すると、画像の書き込み先に同名のファイルが存在する場合は変換を行いません。 + +###-y , --model_type + 使用するモデルを指定します。 + GUIでの設定項目「モデル」と以下のように対応しています。 + * anime_style_art_rgb : 2次元イラスト(RGBモデル) + * photo : 写真・アニメ(Photoモデル) + * anime_style_art_y : 2次元イラスト(Yモデル) + + + コマンドラインオプション(CUI版) +-------- + ###--version バージョン情報を出力し、終了します。 @@ -313,6 +353,27 @@ waifu2x-caffe-cui.exe -i mywaifu.png -m noise_scale --scale_ratio 1.6 --noise_le 使い方を表示し、終了します。 手軽に使い方を確認したい時などにどうぞ。 +###-i <文字列>, --input_file <文字列> + (必須) 変換する画像へのパス + フォルダを指定した場合、そのフォルダ以下の画像ファイルを全て変換してoutput_fileで指定したフォルダへ出力します。 + +###-o , --output_file + 変換された画像を保存するファイルへのパス + (input_fileがフォルダの場合)変換された画像を保存するフォルダへのパス + (input_fileが画像ファイルの場合)拡張子(最後の.pngなど)は必ず入力するようにして下さい。 + 指定しなかった場合は自動でファイル名を決定し、そのファイルに保存します。 + ファイル名の決定ルールは、 + `[元の画像ファイル名]``(モード名)``(ノイズ除去レベル(ノイズ除去モードの場合))``(拡大率(拡大モードの場合))``.出力拡張子` + のようになっています。 + 保存される場所は、基本的には入力画像と同じディレクトリになります。 + +###--model_dir <文字列> + モデルが格納されているディレクトリへのパスを指定します。デフォルト値は`models/anime_style_art_rgb`です。 + 標準では以下のモデルが付属しています。 + * `models/anime_style_art_rgb` : RGBすべてを変換する2次元画像用モデル + * `models/anime_style_art` : 輝度のみを変換する2次元画像用モデル + * `models/ukbench` : 写真用モデル(拡大するモデルのみ付属しています。ノイズ除去は出来ません) + 基本的には指定しなくても大丈夫です。デフォルト以外のモデルや自作のモデルを使用する時などに指定して下さい。 分割サイズ --------