trinity.trainer.trainer module

trinity.trainer.trainer module#

Trainer Class

class trinity.trainer.trainer.Trainer(config: Config)[source]#

Bases: object

Consume the experience and train the model.

__init__(config: Config) → None[source]#

async prepare() → None[source]#: Prepare the trainer.

async train() → str[source]#: Train the model.

async train_step(exps: List[Experience]) → Dict[source]#

Train one step.

Returns:: Whether to continue training. Dict: Metrics of the training step.
Return type:: bool

async need_sync() → bool[source]#: Whether to sync the model weight.

need_save() → bool[source]#: Whether to save the checkpoint.

async sync_weight() → Dict[source]#: Sync the model weight.

save_checkpoint(block_until_saved: bool = False, save_as_hf: bool = False) → Dict[source]#

async shutdown() → None[source]#

property train_step_num: int#: Get the current training step number.

async is_alive() → bool[source]#: Check if the trainer is alive.

classmethod get_actor(config: Config)[source]#: Get a Ray actor for the trainer.

class trinity.trainer.trainer.TrainEngineWrapper[source]#

Bases: ABC

A wrapper class to wrap various training engines.

abstractmethod async prepare() → None[source]#: Do some preparation before training started.

abstract property train_step_num: int#: Get the current training step number.

abstractmethod async train_step(batch_exps: List[Experience]) → Dict[source]#

Training one step.

Parameters:: batch_exps (List[Experience]) – A batch of experiences to train.
Returns:: Metrics of the training step.
Return type:: Dict

abstractmethod save_checkpoint(block_until_saved: bool = False, save_as_hf: bool = False) → None[source]#: Save the checkpoint.

abstractmethod sync_weight() → None[source]#: Sync the model weight.

abstractmethod upload_state_dict() → None[source]#: Upload the state dict to Synchronizer.

abstractmethod save_state_dict() → None[source]#: Only save the model state dict for Synchronizer.

trinity.trainer.trainer.get_trainer_wrapper(config: Config) → TrainEngineWrapper[source]#: Get a trainer wrapper.