CycleGANResnetGenerator#

class deeplay.models.generators.cyclegan.CycleGANResnetGenerator(*args, **kwargs)#

Bases: ConvolutionalEncoderDecoder2d

CycleGAN generator.

Parameters#

in_channelsint

Number of channels in the input image.

out_channelsint

Number of channels in the output image.

n_residual_blocksint

Number of residual blocks in the generator.

Shorthands#

  • input: .blocks[0]

  • hidden: .blocks[:-1]

  • output: .blocks[-1]

  • layer: .blocks.layer

  • activation: .blocks.activation

Examples#

>>> generator = CycleGANResnetGenerator(in_channels=1, out_channels=3)
>>> generator.build()
>>> x = torch.randn(1, 1, 256, 256)
>>> y = generator(x)
>>> y.shape

Return values#

The forward method returns the processed tensor.

Methods Summary

configure(*args, **kwargs)

Configures the module with specified arguments.

forward(x)

Define the computation performed at every call.

Methods Documentation

configure(*args: Any, **kwargs: Any)#

Configures the module with specified arguments.

This method allows dynamic configuration of the module’s properties and behaviors. It can be used to set or modify the attributes and parameters of the module and, if applicable, its child modules. The method intelligently handles both direct attribute configuration and delegation to child modules’ configure methods.

Parameters#

*argsAny

Positional arguments specifying the configuration settings. When the first argument is a string matching a configurable attribute, the method expects either one or two arguments: the attribute name and, optionally, its value. If the attribute is itself a DeeplayModule, subsequent arguments are passed to its configure method.

**kwargsAny

Keyword arguments for configuration settings. If provided, these are used to update the module’s configuration directly.

Raises#

ValueError

Raised if a configuration key is not recognized as a valid configurable for the module or if the provided arguments do not match the expected pattern for configuration.

Example Usage#

To configure a single attribute: ` module.configure('attribute_name', attribute_value) # or module.configure(attribute_name=attribute_value) `

To configure multiple attributes using keyword arguments: ` module.configure(attribute1=value1, attribute2=value2) `

To configure a child module’s attribute: ` module.configure('child_module_attribute', child_attribute=child_attribute_value) # or module.child_module.configure(child_attribute=child_attribute_value) `

forward(x)#

Define the computation performed at every call.

Should be overridden by all subclasses.

Note

Although the recipe for forward pass needs to be defined within this function, one should call the Module instance afterwards instead of this since the former takes care of running the registered hooks while the latter silently ignores them.