use alloc::format;
use crate as burn;
use crate::config::Config;
use crate::module::Content;
use crate::module::DisplaySettings;
use crate::module::Module;
use crate::module::ModuleDisplay;
use crate::module::Param;
use crate::nn::conv::checks;
use crate::nn::Initializer;
use crate::tensor::backend::Backend;
use crate::tensor::module::conv_transpose2d;
use crate::tensor::ops::ConvTransposeOptions;
use crate::tensor::Tensor;
#[derive(Config, Debug)]
pub struct ConvTranspose2dConfig {
pub channels: [usize; 2],
pub kernel_size: [usize; 2],
#[config(default = "[1, 1]")]
pub stride: [usize; 2],
#[config(default = "[1, 1]")]
pub dilation: [usize; 2],
#[config(default = "1")]
pub groups: usize,
#[config(default = "[0, 0]")]
pub padding: [usize; 2],
#[config(default = "[0, 0]")]
pub padding_out: [usize; 2],
#[config(default = true)]
pub bias: bool,
#[config(
default = "Initializer::KaimingUniform{gain:1.0/num_traits::Float::sqrt(3.0),fan_out_only:false}"
)]
pub initializer: Initializer,
}
#[derive(Module, Debug)]
#[module(custom_display)]
pub struct ConvTranspose2d<B: Backend> {
pub weight: Param<Tensor<B, 4>>,
pub bias: Option<Param<Tensor<B, 1>>>,
pub stride: [usize; 2],
pub kernel_size: [usize; 2],
pub dilation: [usize; 2],
pub groups: usize,
pub padding: [usize; 2],
pub padding_out: [usize; 2],
pub channels: [usize; 2],
}
impl<B: Backend> ModuleDisplay for ConvTranspose2d<B> {
fn custom_settings(&self) -> Option<DisplaySettings> {
DisplaySettings::new()
.with_new_line_after_attribute(false)
.optional()
}
fn custom_content(&self, content: Content) -> Option<Content> {
content
.add("channels", &format!("{:?}", &self.channels))
.add("stride", &format!("{:?}", &self.stride))
.add("kernel_size", &format!("{:?}", &self.kernel_size))
.add("dilation", &format!("{:?}", &self.dilation))
.add("groups", &self.groups)
.add("padding", &format!("{:?}", &self.padding))
.add("padding_out", &format!("{:?}", &self.padding_out))
.optional()
}
}
impl ConvTranspose2dConfig {
pub fn init<B: Backend>(&self, device: &B::Device) -> ConvTranspose2d<B> {
checks::checks_channels_div_groups(self.channels[0], self.channels[1], self.groups);
let shape = [
self.channels[0],
self.channels[1] / self.groups,
self.kernel_size[0],
self.kernel_size[1],
];
let fan_in = self.channels[1] / self.groups * self.kernel_size.iter().product::<usize>();
let weight = self
.initializer
.init_with(shape, Some(fan_in), None, device);
let mut bias = None;
if self.bias {
bias = Some(
self.initializer
.init_with([self.channels[1]], Some(fan_in), None, device),
);
}
ConvTranspose2d {
weight,
bias,
stride: self.stride,
kernel_size: self.kernel_size,
dilation: self.dilation,
groups: self.groups,
padding: self.padding,
padding_out: self.padding_out,
channels: self.channels,
}
}
}
impl<B: Backend> ConvTranspose2d<B> {
pub fn forward(&self, input: Tensor<B, 4>) -> Tensor<B, 4> {
conv_transpose2d(
input,
self.weight.val(),
self.bias.as_ref().map(|bias| bias.val()),
ConvTransposeOptions::new(
self.stride,
self.padding,
self.padding_out,
self.dilation,
self.groups,
),
)
}
}
#[cfg(test)]
mod tests {
use super::*;
use crate::tensor::TensorData;
use crate::TestBackend;
#[test]
fn initializer_default() {
TestBackend::seed(0);
let config = ConvTranspose2dConfig::new([5, 1], [5, 5]);
let k = (config.channels[1] * config.kernel_size[0] * config.kernel_size[1]) as f64;
let k = (config.groups as f64 / k).sqrt() as f32;
let conv = config.init::<TestBackend>(&Default::default());
conv.weight.to_data().assert_within_range(-k..k);
}
#[test]
fn initializer_zeros() {
TestBackend::seed(0);
let config =
ConvTranspose2dConfig::new([5, 2], [5, 5]).with_initializer(Initializer::Zeros);
let conv = config.init::<TestBackend>(&Default::default());
assert_eq!(config.initializer, Initializer::Zeros);
conv.weight
.to_data()
.assert_approx_eq(&TensorData::zeros::<f32, _>(conv.weight.shape()), 3);
}
#[test]
fn display() {
let config = ConvTranspose2dConfig::new([5, 2], [5, 5]);
let conv = config.init::<TestBackend>(&Default::default());
assert_eq!(
format!("{}", conv),
"ConvTranspose2d {channels: [5, 2], stride: [1, 1], kernel_size: [5, 5], dilation: [1, 1], groups: 1, padding: [0, 0], padding_out: [0, 0], params: 252}"
);
}
}