Merge pull request #149 from faceshiftlabs/feat/autobackup-options

Feat/autobackup options

CHANGELOG.md

@@ -4,6 +4,13 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [1.7.1] - 2021-06-15
+### Added
+- New autobackup options:
+  - Session name
+  - ISO Timestamps (instead of numbered)
+  - Max number of backups to keep (use "0" for unlimited)
+
 ## [1.7.0] - 2021-06-15
 ### Updated
 - Merged in latest changes from upstream, including new AMP model
@@ -96,6 +103,7 @@ This should help with rough areas directly next to the mask
 - Reset stale master branch to [seranus/DeepFaceLab](https://github.com/seranus/DeepFaceLab), 
   21 commits ahead of [iperov/DeepFaceLab](https://github.com/iperov/DeepFaceLab) ([compare](https://github.com/iperov/DeepFaceLab/compare/4818183...seranus:3f5ae05))
 
+[1.7.1]: https://github.com/faceshiftlabs/DeepFaceLab/compare/v1.7.0...v1.7.1
 [1.7.0]: https://github.com/faceshiftlabs/DeepFaceLab/compare/v1.6.2...v1.7.0
 [1.6.2]: https://github.com/faceshiftlabs/DeepFaceLab/compare/v1.6.1...v1.6.2
 [1.6.1]: https://github.com/faceshiftlabs/DeepFaceLab/compare/v1.6.0...v1.6.1

models/ModelBase.py

@@ -8,6 +8,7 @@ import pickle
 import shutil
 import tempfile
 import time
+import datetime
 from pathlib import Path
 
 import cv2
@@ -180,8 +181,9 @@ class ModelBase(object):
         if self.is_first_run():
             # save as default options only for first run model initialize
             self.default_options_path.write_bytes( pickle.dumps (self.options) )
-
+        self.session_name = self.options.get('session_name', "")
         self.autobackup_hour = self.options.get('autobackup_hour', 0)
+        self.maximum_n_backups = self.options.get('maximum_n_backups', 24)
         self.write_preview_history = self.options.get('write_preview_history', False)
         self.target_iter = self.options.get('target_iter',0)
         self.random_flip = self.options.get('random_flip',True)
@@ -278,13 +280,21 @@ class ModelBase(object):
     def ask_override(self):
         return self.is_training and self.iter != 0 and io.input_in_time ("Press enter in 2 seconds to override model settings.", 5 if io.is_colab() else 2 )
 
+    def ask_session_name(self, default_value=""):
+        default_session_name = self.options['session_name'] = self.load_or_def_option('session_name', default_value)
+        self.options['session_name'] = io.input_str("Session name", default_session_name, help_message="String to refer back to in summary.txt and in autobackup foldername")
+
     def ask_autobackup_hour(self, default_value=0):
         default_autobackup_hour = self.options['autobackup_hour'] = self.load_or_def_option('autobackup_hour', default_value)
-        self.options['autobackup_hour'] = io.input_int(f"Autobackup every N hour", default_autobackup_hour, add_info="0..24", help_message="Autobackup model files with preview every N hour. Latest backup located in model/<>_autobackups/01")
+        self.options['autobackup_hour'] = io.input_int(f"Autobackup every N hour", default_autobackup_hour, add_info="0..24", help_message="Autobackup model files with preview every N hour. Latest backup is the last folder when sorted by name ascending located in model/<>_autobackups")
+
+    def ask_maximum_n_backups(self, default_value=24):
+        default_maximum_n_backups = self.options['maximum_n_backups'] = self.load_or_def_option('maximum_n_backups', default_value)
+        self.options['maximum_n_backups'] = io.input_int(f"Maximum N backups", default_maximum_n_backups, help_message="Maximum amount of backups that are located in model/<>_autobackups. Inputting 0 here would allow it to autobackup as many times as it occurs.")
 
     def ask_write_preview_history(self, default_value=False):
         default_write_preview_history = self.load_or_def_option('write_preview_history', default_value)
-        self.options['write_preview_history'] = io.input_bool(f"Write preview history", default_write_preview_history, help_message="Preview history will be writed to <ModelName>_history folder.")
+        self.options['write_preview_history'] = io.input_bool(f"Write preview history", default_write_preview_history, help_message="Preview history will be written to <ModelName>_history folder.")
 
         if self.options['write_preview_history']:
             if io.is_support_windows():
@@ -415,33 +425,32 @@ class ModelBase(object):
         bckp_filename_list = [ self.get_strpath_storage_for_file(filename) for _, filename in self.get_model_filename_list() ]
         bckp_filename_list += [ str(self.get_summary_path()), str(self.model_data_path) ]
 
-        for i in range(24,0,-1):
+        # Create new backup
-            idx_str = '%.2d' % i
+        session_suffix = f'_{self.session_name}' if self.session_name else ''
-            next_idx_str = '%.2d' % (i+1)
+        idx_str = datetime.datetime.now().strftime('%Y%m%dT%H%M%S') + session_suffix
+        idx_backup_path = self.autobackups_path / idx_str
+        idx_backup_path.mkdir()
+        for filename in bckp_filename_list:
+            shutil.copy(str(filename), str(idx_backup_path / Path(filename).name))\
 
-            idx_backup_path = self.autobackups_path / idx_str
+        previews = self.get_previews()
-            next_idx_packup_path = self.autobackups_path / next_idx_str
 
-            if idx_backup_path.exists():
+        # Generate previews and save in new backup
-                if i == 24:
+        plist = []
-                    pathex.delete_all_files(idx_backup_path)
+        for i in range(len(previews)):
-                else:
+            name, bgr = previews[i]
-                    next_idx_packup_path.mkdir(exist_ok=True)
+            plist += [ (bgr, idx_backup_path / ( ('preview_%s.jpg') % (name))  )  ]
-                    pathex.move_all_files (idx_backup_path, next_idx_packup_path)
 
-            if i == 1:
+        if len(plist) != 0:
-                idx_backup_path.mkdir(exist_ok=True)
+            self.get_preview_history_writer().post(plist, self.loss_history, self.iter)
-                for filename in bckp_filename_list:
-                    shutil.copy ( str(filename), str(idx_backup_path / Path(filename).name) )
 
-                previews = self.get_previews()
+        # Check if we've exceeded the max number of backups
-                plist = []
+        if self.maximum_n_backups != 0:
-                for i in range(len(previews)):
+            all_backups = sorted([x for x in self.autobackups_path.iterdir() if x.is_dir()])
-                    name, bgr = previews[i]
+            while len(all_backups) > self.maximum_n_backups:
-                    plist += [ (bgr, idx_backup_path / ( ('preview_%s.jpg') % (name))  )  ]
+                oldest_backup = all_backups.pop(0)
-
+                pathex.delete_all_files(oldest_backup)
-                if len(plist) != 0:
+                oldest_backup.rmdir()
-                    self.get_preview_history_writer().post(plist, self.loss_history, self.iter)
 
     def debug_one_iter(self):
         images = []

models/Model_SAEHD/Model.py

@@ -67,7 +67,9 @@ class SAEHDModel(ModelBase):
 
         ask_override = self.ask_override()
         if self.is_first_run() or ask_override:
+            self.ask_session_name()
             self.ask_autobackup_hour()
+            self.ask_maximum_n_backups()
             self.ask_write_preview_history()
             self.ask_target_iter()
             self.ask_random_src_flip()