Inheritance diagram for fastreid.engine.hooks.CallbackHook:
Public Member Functions | |
| __init__ (self, *before_train=None, after_train=None, before_step=None, after_step=None) | |
| before_train (self) | |
| after_train (self) | |
| before_step (self) | |
| after_step (self) | |
Public Attributes | |
| trainer | |
Protected Attributes | |
| _before_train | |
| _before_step | |
| _after_step | |
| _after_train | |
Detailed Description
Create a hook using callback functions provided by the user.
Constructor & Destructor Documentation
◆ __init__()
| fastreid.engine.hooks.CallbackHook.__init__ | ( | self, | |
| * | before_train = None, | ||
| after_train = None, | |||
| before_step = None, | |||
| after_step = None ) |
Each argument is a function that takes one argument: the trainer.
Definition at line 48 of file hooks.py.
48 def __init__(self, *, before_train=None, after_train=None, before_step=None, after_step=None):
49 """
50 Each argument is a function that takes one argument: the trainer.
51 """
52 self._before_train = before_train
53 self._before_step = before_step
54 self._after_step = after_step
55 self._after_train = after_train
56
Member Function Documentation
◆ after_step()
| fastreid.engine.hooks.CallbackHook.after_step | ( | self | ) |
Called after each iteration.
Reimplemented from fastreid.engine.train_loop.HookBase.
Definition at line 73 of file hooks.py.
73 def after_step(self):
74 if self._after_step:
75 self._after_step(self.trainer)
76
77
◆ after_train()
| fastreid.engine.hooks.CallbackHook.after_train | ( | self | ) |
Called after the last iteration.
Reimplemented from fastreid.engine.train_loop.HookBase.
Definition at line 61 of file hooks.py.
61 def after_train(self):
62 if self._after_train:
63 self._after_train(self.trainer)
64 # The functions may be closures that hold reference to the trainer
65 # Therefore, delete them to avoid circular reference.
66 del self._before_train, self._after_train
67 del self._before_step, self._after_step
68
◆ before_step()
| fastreid.engine.hooks.CallbackHook.before_step | ( | self | ) |
Called before each iteration.
Reimplemented from fastreid.engine.train_loop.HookBase.
Definition at line 69 of file hooks.py.
69 def before_step(self):
70 if self._before_step:
71 self._before_step(self.trainer)
72
◆ before_train()
| fastreid.engine.hooks.CallbackHook.before_train | ( | self | ) |
Called before the first iteration.
Reimplemented from fastreid.engine.train_loop.HookBase.
Definition at line 57 of file hooks.py.
57 def before_train(self):
58 if self._before_train:
59 self._before_train(self.trainer)
60
Member Data Documentation
◆ _after_step
◆ _after_train
◆ _before_step
◆ _before_train
◆ trainer
The documentation for this class was generated from the following file:
- smreid/fastreid/engine/hooks.py
