mmagic.models.editors.pix2pix.pix2pix

Module Contents

Classes

Pix2Pix

Pix2Pix model for paired image-to-image translation.

class mmagic.models.editors.pix2pix.pix2pix.Pix2Pix(*args, **kwargs)

Bases: mmagic.models.base_models.BaseTranslationModel

Pix2Pix model for paired image-to-image translation.

Ref:

Image-to-Image Translation with Conditional Adversarial Networks

forward_test(img, target_domain, **kwargs)

Forward function for testing.

Parameters

• img (tensor) – Input image tensor.

• target_domain (str) – Target domain of output image.

• kwargs (dict) – Other arguments.

Returns

Forward results.

Return type

dict

_get_disc_loss(outputs)

Get the loss of discriminator.

Parameters

outputs (dict) – A dict of output.

Returns

Loss and a dict of log of loss terms.

Return type

Tuple

_get_gen_loss(outputs)

Get the loss of generator.

Parameters

outputs (dict) – A dict of output.

Returns

Loss and a dict of log of loss terms.

Return type

Tuple

train_step(data, optim_wrapper=None)

Training step function.

Parameters

• data_batch (dict) – Dict of the input data batch.

• optimizer (dict[torch.optim.Optimizer]) – Dict of optimizers for the generator and discriminator.

• ddp_reducer (Reducer | None, optional) – Reducer from ddp. It is used to prepare for backward() in ddp. Defaults to None.

• running_status (dict | None, optional) – Contains necessary basic information for training, e.g., iteration number. Defaults to None.

Returns

Dict of loss, information for logger, the number of samples and results for visualization.

Return type

dict

test_step(data: dict) → mmagic.utils.typing.SampleList

Gets the generated image of given data. Same as val_step().

Parameters

data (dict) – Data sampled from metric specific sampler. More details in Metrics and Evaluator.

Returns

Generated image or image dict.

Return type

List[DataSample]

val_step(data: dict) → mmagic.utils.typing.SampleList

Gets the generated image of given data. Same as val_step().

Parameters

data (dict) – Data sampled from metric specific sampler. More details in Metrics and Evaluator.

Returns

Generated image or image dict.

Return type

List[DataSample]