1
0
Fork 0
mirror of https://github.com/deepfakes/faceswap synced 2025-06-08 03:26:47 -04:00
faceswap/lib/multithreading.py
torzdf 7f53911453
Logging (#541)
* Convert prints to logger. Further logging improvements. Tidy  up

* Fix system verbosity. Allow SystemExit

* Fix reload extract bug

* Child Traceback handling

* Safer shutdown procedure

* Add shutdown event to queue manager

* landmarks_as_xy > property. GUI notes + linting. Aligner bugfix

* fix FaceFilter. Enable nFilter when no Filter is supplied

* Fix blurry face filter

* Continue on IO error. Better error handling

* Explicitly print stack trace tocrash log

* Windows Multiprocessing bugfix

* Add git info and conda version to crash log

* Windows/Anaconda mp bugfix

* Logging fixes for training
2018-12-04 13:31:49 +00:00

212 lines
8.5 KiB
Python

#!/usr/bin/env python3
""" Multithreading/processing utils for faceswap """
import logging
import multiprocessing as mp
import queue as Queue
import sys
import threading
from lib.logger import LOG_QUEUE, set_root_logger
logger = logging.getLogger(__name__) # pylint: disable=invalid-name
_launched_processes = set() # pylint: disable=invalid-name
class PoolProcess():
""" Pool multiple processes """
def __init__(self, method, in_queue, out_queue, *args, processes=None, **kwargs):
self._name = method.__qualname__
logger.debug("Initializing %s: (target: '%s', processes: %s)",
self.__class__.__name__, self._name, processes)
self.procs = self.set_procs(processes)
ctx = mp.get_context("spawn")
self.pool = ctx.Pool(processes=self.procs)
self._method = method
self._kwargs = self.build_target_kwargs(in_queue, out_queue, kwargs)
self._args = args
logger.debug("Initialized %s: '%s'", self.__class__.__name__, self._name)
@staticmethod
def build_target_kwargs(in_queue, out_queue, kwargs):
""" Add standard kwargs to passed in kwargs list """
kwargs["log_init"] = set_root_logger
kwargs["log_queue"] = LOG_QUEUE
kwargs["in_queue"] = in_queue
kwargs["out_queue"] = out_queue
return kwargs
def set_procs(self, processes):
""" Set the number of processes to use """
if processes is None:
running_processes = len(mp.active_children())
processes = max(mp.cpu_count() - running_processes, 1)
logger.verbose("Processing '%s' in %s processes", self._name, processes)
return processes
def start(self):
""" Run the processing pool """
logging.debug("Pooling Processes: (target: '%s', args: %s, kwargs: %s)",
self._name, self._args, self._kwargs)
for idx in range(self.procs):
logger.debug("Adding process %s of %s to mp.Pool '%s'",
idx + 1, self.procs, self._name)
self.pool.apply_async(self._method, args=self._args, kwds=self._kwargs)
logging.debug("Pooled Processes: '%s'", self._name)
def join(self):
""" Join the process """
logger.debug("Joining Pooled Process: '%s'", self._name)
self.pool.close()
self.pool.join()
logger.debug("Joined Pooled Process: '%s'", self._name)
class SpawnProcess(mp.context.SpawnProcess):
""" Process in spawnable context
Must be spawnable to share CUDA across processes """
def __init__(self, target, in_queue, out_queue, *args, **kwargs):
name = target.__qualname__
logger.debug("Initializing %s: (target: '%s', args: %s, kwargs: %s)",
self.__class__.__name__, name, args, kwargs)
ctx = mp.get_context("spawn")
self.event = ctx.Event()
kwargs = self.build_target_kwargs(in_queue, out_queue, kwargs)
super().__init__(target=target, name=name, args=args, kwargs=kwargs)
self.daemon = True
logger.debug("Initialized %s: '%s'", self.__class__.__name__, name)
def build_target_kwargs(self, in_queue, out_queue, kwargs):
""" Add standard kwargs to passed in kwargs list """
kwargs["event"] = self.event
kwargs["log_init"] = set_root_logger
kwargs["log_queue"] = LOG_QUEUE
kwargs["in_queue"] = in_queue
kwargs["out_queue"] = out_queue
return kwargs
def start(self):
""" Add logging to start function """
logger.debug("Spawning Process: (name: '%s', args: %s, kwargs: %s, daemon: %s)",
self._name, self._args, self._kwargs, self.daemon)
super().start()
_launched_processes.add(self)
logger.debug("Spawned Process: (name: '%s', PID: %s)", self._name, self.pid)
def join(self, timeout=None):
""" Add logging to join function """
logger.debug("Joining Process: (name: '%s', PID: %s)", self._name, self.pid)
super().join(timeout=timeout)
_launched_processes.remove(self)
logger.debug("Joined Process: (name: '%s', PID: %s)", self._name, self.pid)
class FSThread(threading.Thread):
""" Subclass of thread that passes errors back to parent """
def __init__(self, group=None, target=None, name=None, # pylint: disable=too-many-arguments
args=(), kwargs=None, *, daemon=None):
super().__init__(group=group, target=target, name=name,
args=args, kwargs=kwargs, daemon=daemon)
self.err = None
def run(self):
try:
if self._target:
self._target(*self._args, **self._kwargs)
except Exception: # pylint: disable=broad-except
self.err = sys.exc_info()
finally:
# Avoid a refcycle if the thread is running a function with
# an argument that has a member that points to the thread.
del self._target, self._args, self._kwargs
class MultiThread():
""" Threading for IO heavy ops
Catches errors in thread and rethrows to parent """
def __init__(self, target, *args, thread_count=1, **kwargs):
self._name = target.__name__
logger.debug("Initializing %s: (target: '%s', thread_count: %s)",
self.__class__.__name__, self._name, thread_count)
logger.trace("args: %s, kwargs: %s", args, kwargs)
self.daemon = True
self._thread_count = thread_count
self._threads = list()
self._target = target
self._args = args
self._kwargs = kwargs
logger.debug("Initialized %s: '%s'", self.__class__.__name__, self._name)
def start(self):
""" Start a thread with the given method and args """
logger.debug("Starting thread(s): '%s'", self._name)
for idx in range(self._thread_count):
name = "{}_{}".format(self._name, idx)
logger.debug("Starting thread %s of %s: '%s'",
idx + 1, self._thread_count, name)
thread = FSThread(name=name,
target=self._target,
args=self._args,
kwargs=self._kwargs)
thread.daemon = self.daemon
thread.start()
self._threads.append(thread)
logger.debug("Started all threads '%s': %s", self._name, len(self._threads))
def join(self):
""" Join the running threads, catching and re-raising any errors """
logger.debug("Joining Threads: '%s'", self._name)
for thread in self._threads:
logger.debug("Joining Thread: '%s'", thread._name) # pylint: disable=protected-access
thread.join()
if thread.err:
logger.error("Caught exception in thread: '%s'",
thread._name) # pylint: disable=protected-access
raise thread.err[1].with_traceback(thread.err[2])
logger.debug("Joined all Threads: '%s'", self._name)
class BackgroundGenerator(threading.Thread):
""" Run a queue in the background. From:
https://stackoverflow.com/questions/7323664/ """
# See below why prefetch count is flawed
def __init__(self, generator, prefetch=1):
threading.Thread.__init__(self)
self.queue = Queue.Queue(maxsize=prefetch)
self.generator = generator
self.daemon = True
self.start()
def run(self):
""" Put until queue size is reached.
Note: put blocks only if put is called while queue has already
reached max size => this makes 2 prefetched items! One in the
queue, one waiting for insertion! """
for item in self.generator:
self.queue.put(item)
self.queue.put(None)
def iterator(self):
""" Iterate items out of the queue """
while True:
next_item = self.queue.get()
if next_item is None:
break
yield next_item
def terminate_processes():
""" Join all active processes on unexpected shutdown
If the process is doing long running work, make sure you
have a mechanism in place to terminate this work to avoid
long blocks
"""
logger.debug("Processes to join: %s", [process.name
for process in _launched_processes
if process.is_alive()])
for process in list(_launched_processes):
if process.is_alive():
process.join()