[sample.py]

・内容： 2次元データを2クラスに分類する認識器を学習し，その過程を可視化する．

・実行コマンド例
  python sample.py -g=0 -e=50 -b=100 -v=5

・実行コマンド例（Google Colaboratoryのセルで実行する場合）
  %run sample.py -g=0 -e=50 -b=100 -v=5

・オプション
  -g: GPU ID．指定しなかった場合 -1 となり，CPUモードで動作する．
  -e: 総エポック数（学習データを各1回ずつ用いてパラメータを更新する過程を1エポックとして，それを何回繰り返すか）．
      指定しなかった場合，デフォルト値として 50 が設定される．
  -b: ミニバッチあたりの学習データ数．指定しなかった場合，デフォルト値として 100 が設定される．
  -v: 何エポックに1回の割合で識別境界を可視化するか．
      指定しなかった場合，デフォルト値として 5 が設定される．

・備考： ソースコード中の USING_DMY が False なら性別・身長・体重データが，True なら人工的に作成したデータが対象となる．


[mnist_train.py]

・内容： MNISTデータセットを対象に画像認識器を学習する．
         ネットワーク構造は cnn.py の myCNN クラスで定義されており，
         これをソースコード中で「from cnn import myCNN」とすることにより読み込んでいる．

・実行コマンド例
  python mnist_train.py -g=0 -e=10 -b=100 -m=mnist_model.pth

・実行コマンド例（Google Colaboratoryのセルで実行する場合）
  %run mnist_train.py -g=0 -e=10 -b=100 -m=mnist_model.pth

・オプション
  -g: sample.py と同じ．
  -e: sample.py と同じ（ただしデフォルト値は 10 となっている）．
  -b: sample.py と同じ．
  -m: ここで指定したパスのファイルに学習後のモデルが上書き保存される（存在しない場合は自動作成される）．
      指定しなかった場合，デフォルト値として mnist_model.pth が設定される．


[mnist_predict.py]

・内容： mnist_train.py で学習した認識器を用いて実際に認識処理を行う．
         ネットワーク構造は cnn.py の myCNN クラスで定義されており，
         これをソースコード中で「from cnn import myCNN」とすることにより読み込んでいる．

・実行コマンド例
  python mnist_predict.py -g=0 -i=dataset/MNIST/test_data/00000.png -m=mnist_model.pth
  python mnist_predict.py -g=0 -b=100 -m=mnist_model.pth

・実行コマンド例（Google Colaboratoryのセルで実行する場合）
  %run mnist_predict.py -g=0 -i=dataset/MNIST/test_data/00000.png -m=mnist_model.pth
  %run mnist_predict.py -g=0 -b=100 -m=mnist_model.pth

・オプション
  -g: sample.py と同じ．
  -i: 入力画像のファイルパス．
      指定しなかった場合，ソースコード中に記載された評価用データセットに対する認識精度を求めるモードになる．
  -b: -iオプションが指定されなかった場合のみ有効．機能は sample.py と同じ．
  -m: モデルファイルのパス．ここで指定されたモデルファイルをロードして処理を実行する．
      指定しなかった場合，デフォルト値として mnist_model.pth が設定される．


[cifar10_train.py]

・内容： CIFAR10データセットを対象に画像認識器を学習する．
         ネットワーク構造は cnn.py の myCNN2 クラスで定義されており，
         これをソースコード中で「from cnn import myCNN2」とすることにより読み込んでいる．

・実行コマンド例
  python cifar10_train.py -g=0 -e=10 -b=100 -m=cifar10_model.pth

・実行コマンド例（Google Colaboratoryのセルで実行する場合）
  %run cifar10_train.py -g=0 -e=10 -b=100 -m=cifar10_model.pth

・オプション
  -g: sample.py と同じ．
  -e: sample.py と同じ（ただしデフォルト値は 10 となっている）．
  -b: sample.py と同じ．
  -m: mnist_train.py と同じ（ただしデフォルト値は cifar10_model.pth となっている）．


[cifar10_predict.py]

・内容： cifar10_train.py で学習した認識器を用いて実際に認識処理を行う．
         ネットワーク構造は cnn.py の myCNN2 クラスで定義されており，
         これをソースコード中で「from cnn import myCNN2」とすることにより読み込んでいる．

・実行コマンド例
  python cifar10_predict.py -g=0 -i=dataset/MNIST/test_data/00000.png -m=cifar10_model.pth
  python cifar10_predict.py -g=0 -b=100 -m=cifar10_model.pth

・実行コマンド例（Google Colaboratoryのセルで実行する場合）
  %run cifar10_predict.py -g=0 -i=dataset/MNIST/test_data/00000.png -m=mnist_model.pth
  %run cifar10_predict.py -g=0 -b=100 -m=mnist_model.pth

・オプション
  -g: sample.py と同じ．
  -i: 入力画像のファイルパス．
      指定しなかった場合，ソースコード中に記載された評価用データセットに対する認識精度を求めるモードになる．
  -b: -iオプションが指定されなかった場合のみ有効．機能は sample.py と同じ．
  -m: mnist_predict.py と同じ（ただしデフォルト値は cifar10_model.pth となっている）．


[compress_train.py]

・内容： MNISTデータセットを対象にオートエンコーダ（AE）を学習する．
         ネットワーク構造は autoencoders.py の myAutoEncoder クラスで定義されており，
         これをソースコード中で「from autoencoders import myAutoEncoder」とすることにより読み込んでいる．

・実行コマンド例
  python compress_train.py -g=0 -e=10 -b=100 -f=32 -m=compress_model.pth

・実行コマンド例（Google Colaboratoryのセルで実行する場合）
  %run compress_train.py -g=0 -e=10 -b=100 -f=32 -m=compress_model.pth

・オプション
  -g: sample.py と同じ．
  -e: sample.py と同じ（ただしデフォルト値は 10 となっている）．
  -b: sample.py と同じ．
  -f: 画像圧縮後のベクトルの次元数（圧縮表現に対応する中間層のユニット数）．
      指定しなかった場合，デフォルト値として 32 が設定される．
  -m: mnist_train.py と同じ（ただしデフォルト値は compress_model.pth となっている）．


[compress_exec.py]

・内容： compress_train.py で学習した AE を用いて画像圧縮／復元処理を行う．
         ネットワーク構造は autoencoders.py の myAutoEncoder クラスで定義されており，
         これをソースコード中で「from autoencoders import myAutoEncoder」とすることにより読み込んでいる．

・実行コマンド例
  python compress_exec.py -c -g=0 -f=32 -i=dataset/MNIST/test_data/00000.png -o=compress_result.csv -m=compress_model.pth
  python compress_exec.py -d -g=0 -f=32 -i=compress_result.csv -o=decompress_result.png -m=compress_model.pth

・実行コマンド例（Google Colaboratoryのセルで実行する場合）
  %run compress_exec.py -c -g=0 -f=32 -i=dataset/MNIST/test_data/00000.png -o=compress_result.csv -m=compress_model.pth
  %run compress_exec.py -d -g=0 -f=32 -i=compress_result.csv -o=decompress_result.png -m=compress_model.pth

・オプション
  -c: 指定すると圧縮処理が実行される．
  -d: 指定すると復元処理が実行される．
      -cオプションと同時に指定された場合は-dオプションが優先され，復元処理が実行される．
      -cと-dの何れもが指定されなかった場合は圧縮処理が実行される．
  -g: sample.py と同じ．
  -f: compress_train.py と同じ．
      ただし，compress_train.py の実行時と異なる値が指定された場合はエラーになる．
  -i: 入力ファイルパス（圧縮時は画像ファイル，復元時は.csvファイル）
      必須項目であり，指定しなかった場合はエラー終了する．
  -o: 出力ファイルパス（圧縮時は.csvファイル，復元時は画像ファイル）
      必須項目であり，指定しなかった場合はエラー終了する．
  -m: mnist_predict.py と同じ（ただしデフォルト値は compress_model.pth となっている）．


[colorize_train.py]

・内容： VGGFace2データセットを対象にカラー化処理用の AE を学習する．
         ネットワーク構造は autoencoders.py の myColorizationAE クラスで定義されており，
         これをソースコード中で「from autoencoders import myColorizationAE」とすることにより読み込んでいる．

・実行コマンド例
  python colorize_train.py -g=0 -e=10 -b=100 -m=colorize_model.pth

・実行コマンド例（Google Colaboratoryのセルで実行する場合）
  %run colorize_train.py -g=0 -e=10 -b=100 -m=colorize_model.pth

・オプション
  -g: sample.py と同じ．
  -e: sample.py と同じ（ただしデフォルト値は 10 となっている）．
  -b: sample.py と同じ．
  -m: mnist_train.py と同じ（ただしデフォルト値は colorize_model.pth となっている）．


[colorize_exec.py]

・内容： colorize_train.py で学習した AE を用いて実際にカラー化処理を行う．
         ネットワーク構造は autoencoders.py の myColorizationAE クラスで定義されており，
         これをソースコード中で「from autoencoders import myColorizationAE」とすることにより読み込んでいる．

・実行コマンド例
  python colorize_exec.py -g=0 -i=dataset/VGGFace2/test_data/00000.png -o=colorize_result.png -m=colorize_model.pth

・実行コマンド例（Google Colaboratoryのセルで実行する場合）
  %run colorize_exec.py -g=0 -i=dataset/VGGFace2/test_data/00000.png -o=colorize_result.png -m=colorize_model.pth

・オプション
  -g: sample.py と同じ．
  -i: 入力画像のファイルパス．カラー画像が指定されても自動的にグレースケール化して読み込まれる．
      必須項目であり，指定しなかった場合はエラー終了する．
  -o: 出力画像（カラー化結果）のファイルパス．
      必須項目であり，指定しなかった場合はエラー終了する．
  -m: mnist_predict.py と同じ（ただしデフォルト値は colorize_model.pth となっている）．


[upsampling_train.py]

・内容： VGGFace2データセットを対象にアップサンプリング用の AE を学習する．
         ネットワーク構造は autoencoders.py の myUpSamplingAE クラスで定義されており，
         これをソースコード中で「from autoencoders import myUpSamplingAE」とすることにより読み込んでいる．

・実行コマンド例
  python upsampling_train.py -g=0 -e=10 -b=100 -m=upsampling_model.pth

・実行コマンド例（Google Colaboratoryのセルで実行する場合）
  %run upsampling_train.py -g=0 -e=10 -b=100 -m=upsampling_model.pth

・オプション
  -g: sample.py と同じ．
  -e: sample.py と同じ（ただしデフォルト値は 10 となっている）．
  -b: sample.py と同じ．
  -m: mnist_train.py と同じ（ただしデフォルト値は upsampling_model.pth となっている）．


[upsampling_exec.py]

・内容： upsampling_train.py で学習した AE を用いて実際にアップサンプリングを行う．
         ネットワーク構造は autoencoders.py の myUpSamplingAE クラスで定義されており，
         これをソースコード中で「from autoencoders import myUpSamplingAE」とすることにより読み込んでいる．

・実行コマンド例
  python upsampling_exec.py -g=0 -i=dataset/VGGFace2/test_data/00000.png -o=upsampling_result.png -m=upsampling_model.pth

・実行コマンド例（Google Colaboratoryのセルで実行する場合）
  %run upsampling_exec.py -g=0 -i=dataset/VGGFace2/test_data/00000.png -o=upsampling_result.png -m=upsampling_model.pth

・オプション
  -g: sample.py と同じ．
  -i: 入力画像のファイルパス．指定された画像の縦幅・横幅が半分になるように自動的にリサイズされる．
      必須項目であり，指定しなかった場合はエラー終了する．
  -o: 出力画像（アップサンプリング結果）のファイルパス．
      必須項目であり，指定しなかった場合はエラー終了する．
  -m: mnist_predict.py と同じ（ただしデフォルト値は upsampling_model.pth となっている）．


[denoise_train.py]

・内容： CIFAR10データセットを対象にノイズ除去処理用の AE を学習する．
         ネットワーク構造は autoencoders.py の myDenoisingAE クラスで定義されており，
         これをソースコード中で「from autoencoders import myDenoisingAE」とすることにより読み込んでいる．

・実行コマンド例
  python denoise_train.py -g=0 -e=10 -b=100 -m=denoise_model.pth

・実行コマンド例（Google Colaboratoryのセルで実行する場合）
  %run denoise_train.py -g=0 -e=10 -b=100 -m=denoise_model.pth

・オプション
  -g: sample.py と同じ．
  -e: sample.py と同じ（ただしデフォルト値は 10 となっている）．
  -b: sample.py と同じ．
  -m: mnist_train.py と同じ（ただしデフォルト値は denoise_model.pth となっている）．


[denoise_exec.py]

・内容： denoise_train.py で学習した AE を用いて実際にノイズ除去処理を行う．
         ネットワーク構造は autoencoders.py の myDenoisingAE クラスで定義されており，
         これをソースコード中で「from autoencoders import myDenoisingAE」とすることにより読み込んでいる．

・実行コマンド例
  python denoise_exec.py -g=0 -i=dataset/CIFAR10/test_data/00000.png -o=denoise_result.png -m=denoise_model.pth

・実行コマンド例（Google Colaboratoryのセルで実行する場合）
  %run denoise_exec.py -g=0 -i=dataset/CIFAR10/test_data/00000.png -o=denoise_result.png -m=denoise_model.pth

・オプション
  -g: sample.py と同じ．
  -i: 入力画像のファイルパス．
      必須項目であり，指定しなかった場合はエラー終了する．
  -o: 出力画像（ノイズ除去結果）のファイルパス．
      必須項目であり，指定しなかった場合はエラー終了する．
  -m: mnist_predict.py と同じ（ただしデフォルト値は denoise_model.pth となっている）．


[cnn.py]

・内容： 実行用のソースファイルではない．
         sample.py, mnist_train.py, mnist_predict.py, cifar10_train.py, cifar10_predict.py で使用するDNNのネットワーク構造が定義されている．
         myMLP, myCNN, myCNN2 クラスを編集することによりネットワーク構造を変更できる．

・備考： 改善の余地を大きくするため，本プログラム中のネットワークは敢えて「弱く」作成している．


[autoencoders.py]

・内容： 実行用のソースファイルではない．
         compress_train.py ～ denoise_exec.py で使用する AE のネットワーク構造が定義されている．
         それぞれ，次のクラスを編集することによりネットワーク構造を変更できる．
          * compress_train.py, compress_exec.py: myAutoEncoder クラス
          * colorize_train.py, colorize_exec.py: myColorizationAE クラス
          * upsampling_train.py, upsampling_exec.py: myUpSamplingAE クラス
          * denoise_train.py, denoise_exec.py: myDenoisingAE クラス

・備考： 改善の余地を大きくするため，本プログラム中のネットワークは敢えて「弱く」作成している．


[unit_layers.py]

・内容： 実行用のソースファイルではない．
         畳込み層（Conv）やプーリング層（Pool），全結合層（FC）など，
         cnn.py および autoencoders.py で使用しているクラスの実体が定義されている．
         これらの内容と使い方については unit_layers.py 内に記載のコメントを参照のこと．


[func.py]

・内容： 実行用のソースファイルではない．
         学習処理や推論処理の本体に相当する関数が記載されている．