fastreid.utils.checkpoint.PeriodicCheckpointer Class Reference

Public Member Functions
	__init__ (self, Any checkpointer, int period, int max_iter=None)
	step (self, int iteration, **Any kwargs)
	save (self, str name, **Any kwargs)

Public Attributes
	checkpointer
	period
	max_iter

Detailed Description

Save checkpoints periodically. When `.step(iteration)` is called, it will
execute `checkpointer.save` on the given checkpointer, if iteration is a
multiple of period or if `max_iter` is reached.

Definition at line 251 of file checkpoint.py.

Constructor & Destructor Documentation

__init__()

fastreid.utils.checkpoint.PeriodicCheckpointer.__init__	(		self,
		Any	checkpointer,
		int	period,
		int	max_iter = None )

Args:
    checkpointer (Any): the checkpointer object used to save
    checkpoints.
    period (int): the period to save checkpoint.
    max_iter (int): maximum number of iterations. When it is reached,
        a checkpoint named "model_final" will be saved.

Definition at line 258 of file checkpoint.py.

    def __init__(self, checkpointer: Any, period: int, max_iter: int = None):
        """
        Args:
            checkpointer (Any): the checkpointer object used to save
            checkpoints.
            period (int): the period to save checkpoint.
            max_iter (int): maximum number of iterations. When it is reached,
                a checkpoint named "model_final" will be saved.
        """
        self.checkpointer = checkpointer
        self.period = int(period)
        self.max_iter = max_iter
 

Member Function Documentation

save()

fastreid.utils.checkpoint.PeriodicCheckpointer.save	(		self,
		str	name,
		**Any	kwargs )

Same argument as :meth:`Checkpointer.save`.
Use this method to manually save checkpoints outside the schedule.
Args:
    name (str): file name.
    kwargs (Any): extra data to save, same as in
        :meth:`Checkpointer.save`.

Definition at line 289 of file checkpoint.py.

    def save(self, name: str, **kwargs: Any):
        """
        Same argument as :meth:`Checkpointer.save`.
        Use this method to manually save checkpoints outside the schedule.
        Args:
            name (str): file name.
            kwargs (Any): extra data to save, same as in
                :meth:`Checkpointer.save`.
        """
        self.checkpointer.save(name, **kwargs)
 
 

step()

fastreid.utils.checkpoint.PeriodicCheckpointer.step	(		self,
		int	iteration,
		**Any	kwargs )

Perform the appropriate action at the given iteration.
Args:
    iteration (int): the current iteration, ranged in [0, max_iter-1].
    kwargs (Any): extra data to save, same as in
        :meth:`Checkpointer.save`.

Definition at line 271 of file checkpoint.py.

    def step(self, iteration: int, **kwargs: Any):
        """
        Perform the appropriate action at the given iteration.
        Args:
            iteration (int): the current iteration, ranged in [0, max_iter-1].
            kwargs (Any): extra data to save, same as in
                :meth:`Checkpointer.save`.
        """
        iteration = int(iteration)
        additional_state = {"iteration": iteration}
        additional_state.update(kwargs)
        if self.period > 0 and (iteration + 1) % self.period == 0:
            self.checkpointer.save(
                "model_{:07d}".format(iteration), **additional_state
            )
        if self.period > 0 and iteration >= self.max_iter - 1:
            self.checkpointer.save("model_final", **additional_state)
 

Member Data Documentation

checkpointer

fastreid.utils.checkpoint.PeriodicCheckpointer.checkpointer

Definition at line 267 of file checkpoint.py.

max_iter

fastreid.utils.checkpoint.PeriodicCheckpointer.max_iter

Definition at line 269 of file checkpoint.py.

period

fastreid.utils.checkpoint.PeriodicCheckpointer.period

Definition at line 268 of file checkpoint.py.

---

The documentation for this class was generated from the following file:

• smreid/fastreid/utils/checkpoint.py