Welcome to BasicSR’s documentation!

API

• basicsr API
  • basicsr.archs
    • basicsr.archs.__init__
    • basicsr.archs.arch_util
      • DCNv2Pack
      • ResidualBlockNoBN
      • Upsample
      • default_init_weights()
      • flow_warp()
      • make_layer()
      • pixel_unshuffle()
      • resize_flow()
      • to_1tuple()
      • to_2tuple()
      • to_3tuple()
      • to_4tuple()
      • to_ntuple()
      • trunc_normal_()
    • basicsr.archs.basicvsr_arch
      • BasicVSR
      • ConvResidualBlocks
      • EDVRFeatureExtractor
      • IconVSR
    • basicsr.archs.basicvsrpp_arch
      • BasicVSRPlusPlus
      • SecondOrderDeformableAlignment
    • basicsr.archs.dfdnet_arch
      • DFDNet
      • SFTUpBlock
    • basicsr.archs.dfdnet_util
      • AttentionBlock()
      • Blur
      • BlurFunction
      • BlurFunctionBackward
      • MSDilationBlock
      • UpResBlock
      • adaptive_instance_normalization()
      • calc_mean_std()
      • conv_block()
    • basicsr.archs.discriminator_arch
      • UNetDiscriminatorSN
      • VGGStyleDiscriminator
    • basicsr.archs.duf_arch
      • DUF
      • DenseBlocks
      • DenseBlocksTemporalReduce
      • DynamicUpsamplingFilter
    • basicsr.archs.ecbsr_arch
      • ECB
      • ECBSR
      • SeqConv3x3
    • basicsr.archs.edsr_arch
      • EDSR
    • basicsr.archs.edvr_arch
      • EDVR
      • PCDAlignment
      • PredeblurModule
      • TSAFusion
    • basicsr.archs.hifacegan_arch
      • HiFaceGAN
      • HiFaceGANDiscriminator
      • NLayerDiscriminator
      • SPADEGenerator
    • basicsr.archs.hifacegan_util
      • BaseNetwork
      • LIPEncoder
      • SPADE
      • SPADEResnetBlock
      • SimplifiedLIP
      • SoftGate
      • get_nonspade_norm_layer()
      • lip2d()
    • basicsr.archs.inception
      • FIDInceptionA
      • FIDInceptionC
      • FIDInceptionE_1
      • FIDInceptionE_2
      • InceptionV3
      • fid_inception_v3()
    • basicsr.archs.rcan_arch
      • ChannelAttention
      • RCAB
      • RCAN
      • ResidualGroup
    • basicsr.archs.ridnet_arch
      • ChannelAttention
      • EAM
      • EResidualBlockNoBN
      • MeanShift
      • MergeRun
      • RIDNet
    • basicsr.archs.rrdbnet_arch
      • RRDB
      • RRDBNet
      • ResidualDenseBlock
    • basicsr.archs.spynet_arch
      • BasicModule
      • SpyNet
    • basicsr.archs.srresnet_arch
      • MSRResNet
    • basicsr.archs.srvgg_arch
      • SRVGGNetCompact
    • basicsr.archs.stylegan2_arch
      • ConstantInput
      • ConvLayer
      • EqualConv2d
      • EqualLinear
      • ModulatedConv2d
      • NormStyleCode
      • ResBlock
      • ScaledLeakyReLU
      • StyleConv
      • StyleGAN2Discriminator
      • StyleGAN2Generator
      • ToRGB
      • UpFirDnDownsample
      • UpFirDnSmooth
      • UpFirDnUpsample
      • make_resample_kernel()
    • basicsr.archs.stylegan2_bilinear_arch
      • ConstantInput
      • ConvLayer
      • EqualConv2d
      • EqualLinear
      • ModulatedConv2d
      • NormStyleCode
      • ResBlock
      • ScaledLeakyReLU
      • StyleConv
      • StyleGAN2GeneratorBilinear
      • ToRGB
    • basicsr.archs.swinir_arch
      • BasicLayer
      • DropPath
      • Mlp
      • PatchEmbed
      • PatchMerging
      • PatchUnEmbed
      • RSTB
      • SwinIR
      • SwinTransformerBlock
      • Upsample
      • UpsampleOneStep
      • WindowAttention
      • drop_path()
      • window_partition()
      • window_reverse()
    • basicsr.archs.tof_arch
      • BasicModule
      • SPyNetTOF
      • TOFlow
    • basicsr.archs.vgg_arch
      • VGGFeatureExtractor
      • insert_bn()
  • basicsr.data
    • basicsr.data.__init__
      • build_dataloader()
      • build_dataset()
    • basicsr.data.data_sampler
      • EnlargedSampler
    • basicsr.data.data_util
      • duf_downsample()
      • generate_frame_indices()
      • generate_gaussian_kernel()
      • paired_paths_from_folder()
      • paired_paths_from_lmdb()
      • paired_paths_from_meta_info_file()
      • paths_from_folder()
      • paths_from_lmdb()
      • read_img_seq()
    • basicsr.data.degradations
      • add_gaussian_noise()
      • add_gaussian_noise_pt()
      • add_jpg_compression()
      • add_poisson_noise()
      • add_poisson_noise_pt()
      • bivariate_Gaussian()
      • bivariate_generalized_Gaussian()
      • bivariate_plateau()
      • cdf2()
      • circular_lowpass_kernel()
      • generate_gaussian_noise()
      • generate_gaussian_noise_pt()
      • generate_poisson_noise()
      • generate_poisson_noise_pt()
      • mesh_grid()
      • pdf2()
      • random_add_gaussian_noise()
      • random_add_gaussian_noise_pt()
      • random_add_jpg_compression()
      • random_add_poisson_noise()
      • random_add_poisson_noise_pt()
      • random_bivariate_Gaussian()
      • random_bivariate_generalized_Gaussian()
      • random_bivariate_plateau()
      • random_generate_gaussian_noise()
      • random_generate_gaussian_noise_pt()
      • random_generate_poisson_noise()
      • random_generate_poisson_noise_pt()
      • random_mixed_kernels()
      • sigma_matrix2()
    • basicsr.data.ffhq_dataset
      • FFHQDataset
    • basicsr.data.paired_image_dataset
      • PairedImageDataset
    • basicsr.data.prefetch_dataloader
      • CPUPrefetcher
      • CUDAPrefetcher
      • PrefetchDataLoader
      • PrefetchGenerator
    • basicsr.data.realesrgan_dataset
      • RealESRGANDataset
    • basicsr.data.realesrgan_paired_dataset
      • RealESRGANPairedDataset
    • basicsr.data.reds_dataset
      • REDSDataset
      • REDSRecurrentDataset
    • basicsr.data.single_image_dataset
      • SingleImageDataset
    • basicsr.data.transforms
      • augment()
      • img_rotate()
      • mod_crop()
      • paired_random_crop()
    • basicsr.data.video_test_dataset
      • VideoRecurrentTestDataset
      • VideoTestDUFDataset
      • VideoTestDataset
      • VideoTestVimeo90KDataset
    • basicsr.data.vimeo90k_dataset
      • Vimeo90KDataset
      • Vimeo90KRecurrentDataset
  • basicsr.losses
    • basicsr.losses.__init__
      • build_loss()
      • g_path_regularize()
      • gradient_penalty_loss()
      • r1_penalty()
    • basicsr.losses.basic_loss
      • CharbonnierLoss
      • L1Loss
      • MSELoss
      • PerceptualLoss
      • WeightedTVLoss
      • charbonnier_loss()
      • l1_loss()
      • mse_loss()
    • basicsr.losses.gan_loss
      • GANLoss
      • MultiScaleGANLoss
      • g_path_regularize()
      • gradient_penalty_loss()
      • r1_penalty()
    • basicsr.losses.loss_util
      • get_local_weights()
      • get_refined_artifact_map()
      • reduce_loss()
      • weight_reduce_loss()
      • weighted_loss()
  • basicsr.metrics
    • basicsr.metrics.__init__
      • calculate_niqe()
      • calculate_psnr()
      • calculate_ssim()
    • basicsr.metrics.fid
      • calculate_fid()
      • extract_inception_features()
      • load_patched_inception_v3()
    • basicsr.metrics.metric_util
      • reorder_image()
      • to_y_channel()
    • basicsr.metrics.niqe
      • calculate_niqe()
      • compute_feature()
      • estimate_aggd_param()
      • niqe()
    • basicsr.metrics.psnr_ssim
      • calculate_psnr()
      • calculate_psnr_pt()
      • calculate_ssim()
      • calculate_ssim_pt()
    • basicsr.metrics.test_metrics.test_psnr_ssim
      • test()
  • basicsr.models
    • basicsr.models.__init__
      • build_model()
    • basicsr.models.base_model
      • BaseModel
    • basicsr.models.edvr_model
      • EDVRModel
    • basicsr.models.esrgan_model
      • ESRGANModel
    • basicsr.models.hifacegan_model
      • HiFaceGANModel
    • basicsr.models.lr_scheduler
      • CosineAnnealingRestartLR
      • MultiStepRestartLR
      • get_position_from_periods()
    • basicsr.models.realesrgan_model
      • RealESRGANModel
    • basicsr.models.realesrnet_model
      • RealESRNetModel
    • basicsr.models.sr_model
      • SRModel
    • basicsr.models.srgan_model
      • SRGANModel
    • basicsr.models.stylegan2_model
      • StyleGAN2Model
    • basicsr.models.swinir_model
      • SwinIRModel
    • basicsr.models.video_base_model
      • VideoBaseModel
    • basicsr.models.video_gan_model
      • VideoGANModel
    • basicsr.models.video_recurrent_gan_model
      • VideoRecurrentGANModel
    • basicsr.models.video_recurrent_model
      • VideoRecurrentModel
  • basicsr.ops
    • basicsr.ops.__init__
    • basicsr.ops.dcn.__init__
      • DeformConv
      • DeformConvPack
      • ModulatedDeformConv
      • ModulatedDeformConvPack
      • deform_conv()
      • modulated_deform_conv()
    • basicsr.ops.dcn.deform_conv
      • DeformConv
      • DeformConvFunction
      • DeformConvPack
      • ModulatedDeformConv
      • ModulatedDeformConvFunction
      • ModulatedDeformConvPack
    • basicsr.ops.fused_act.__init__
      • FusedLeakyReLU
      • fused_leaky_relu()
    • basicsr.ops.fused_act.fused_act
      • FusedLeakyReLU
      • FusedLeakyReLUFunction
      • FusedLeakyReLUFunctionBackward
      • fused_leaky_relu()
    • basicsr.ops.upfirdn2d.__init__
      • upfirdn2d()
    • basicsr.ops.upfirdn2d.upfirdn2d
      • UpFirDn2d
      • UpFirDn2dBackward
      • upfirdn2d()
      • upfirdn2d_native()
  • basicsr.test
    • basicsr.test
      • test_pipeline()
  • basicsr.train
    • basicsr.train
      • create_train_val_dataloader()
      • init_tb_loggers()
      • load_resume_state()
      • train_pipeline()
  • basicsr.utils
    • basicsr.utils.__init__
      • AvgTimer
      • DiffJPEG
      • FileClient
      • MessageLogger
      • USMSharp
      • bgr2ycbcr()
      • check_resume()
      • crop_border()
      • get_env_info()
      • get_root_logger()
      • get_time_str()
      • imfrombytes()
      • img2tensor()
      • imwrite()
      • init_tb_logger()
      • init_wandb_logger()
      • make_exp_dirs()
      • mkdir_and_rename()
      • rgb2ycbcr()
      • rgb2ycbcr_pt()
      • scandir()
      • set_random_seed()
      • sizeof_fmt()
      • tensor2img()
      • usm_sharp()
      • yaml_load()
      • ycbcr2bgr()
      • ycbcr2rgb()
    • basicsr.utils.color_util
      • bgr2ycbcr()
      • rgb2ycbcr()
      • rgb2ycbcr_pt()
      • ycbcr2bgr()
      • ycbcr2rgb()
    • basicsr.utils.diffjpeg
      • BlockMerging
      • BlockSplitting
      • CDequantize
      • CQuantize
      • ChromaSubsampling
      • ChromaUpsampling
      • CompressJpeg
      • DCT8x8
      • DeCompressJpeg
      • DiffJPEG
      • RGB2YCbCrJpeg
      • YCbCr2RGBJpeg
      • YDequantize
      • YQuantize
      • diff_round()
      • iDCT8x8
      • quality_to_factor()
    • basicsr.utils.dist_util
      • get_dist_info()
      • init_dist()
      • master_only()
    • basicsr.utils.download_util
      • download_file_from_google_drive()
      • get_confirm_token()
      • load_file_from_url()
      • save_response_content()
    • basicsr.utils.file_client
      • BaseStorageBackend
      • FileClient
      • HardDiskBackend
      • LmdbBackend
      • MemcachedBackend
    • basicsr.utils.flow_util
      • dequantize()
      • dequantize_flow()
      • flowread()
      • flowwrite()
      • quantize()
      • quantize_flow()
    • basicsr.utils.img_process_util
      • USMSharp
      • filter2D()
      • usm_sharp()
    • basicsr.utils.img_util
      • crop_border()
      • imfrombytes()
      • img2tensor()
      • imwrite()
      • tensor2img()
      • tensor2img_fast()
    • basicsr.utils.lmdb_util
      • LmdbMaker
      • make_lmdb_from_imgs()
      • read_img_worker()
    • basicsr.utils.logger
      • AvgTimer
      • MessageLogger
      • get_env_info()
      • get_root_logger()
      • init_tb_logger()
      • init_wandb_logger()
    • basicsr.utils.matlab_functions
      • calculate_weights_indices()
      • cubic()
      • imresize()
    • basicsr.utils.misc
      • check_resume()
      • get_time_str()
      • make_exp_dirs()
      • mkdir_and_rename()
      • scandir()
      • set_random_seed()
      • sizeof_fmt()
    • basicsr.utils.options
      • copy_opt_file()
      • dict2str()
      • ordered_yaml()
      • parse_options()
      • yaml_load()
    • basicsr.utils.plot_util
      • read_data_from_tensorboard()
      • read_data_from_txt_1v()
      • read_data_from_txt_2v()
      • smooth_data()
    • basicsr.utils.registry
      • Registry
• scripts API
  • scripts.data_preparation
    • scripts.data_preparation.create_lmdb
      • create_lmdb_for_div2k()
      • create_lmdb_for_reds()
      • create_lmdb_for_vimeo90k()
      • prepare_keys_div2k()
      • prepare_keys_reds()
      • prepare_keys_vimeo90k()
    • scripts.data_preparation.download_datasets
      • download_dataset()
    • scripts.data_preparation.extract_images_from_tfrecords
      • convert_celeba_tfrecords()
      • convert_ffhq_tfrecords()
      • make_ffhq_lmdb_from_imgs()
    • scripts.data_preparation.extract_subimages
      • extract_subimages()
      • main()
      • worker()
    • scripts.data_preparation.generate_meta_info
      • generate_meta_info_div2k()
    • scripts.data_preparation.prepare_hifacegan_dataset
      • DegradationSimulator
      • Mosaic16x
    • scripts.data_preparation.regroup_reds_dataset
      • regroup_reds_dataset()
  • scripts.download_gdrive
    • scripts.download_gdrive
  • scripts.download_pretrained_models
    • scripts.download_pretrained_models
      • download_pretrained_models()
  • scripts.metrics
    • scripts.metrics.calculate_fid_folder
      • calculate_fid_folder()
    • scripts.metrics.calculate_fid_stats_from_datasets
      • calculate_stats_from_dataset()
    • scripts.metrics.calculate_lpips
      • main()
    • scripts.metrics.calculate_niqe
      • main()
    • scripts.metrics.calculate_psnr_ssim
      • main()
    • scripts.metrics.calculate_stylegan2_fid
      • calculate_stylegan2_fid()
  • scripts.model_conversion
    • scripts.model_conversion.convert_dfdnet
      • convert_net()
    • scripts.model_conversion.convert_models
      • convert_duf_model()
      • convert_edsr()
      • convert_edvr()
      • convert_esrgan_model()
      • convert_rcan_model()
    • scripts.model_conversion.convert_ridnet
    • scripts.model_conversion.convert_stylegan
      • convert_net_d()
      • convert_net_g()
  • scripts.plot
    • scripts.plot.model_complexity_cmp_bsrn
      • main()
  • scripts.publish_models
    • scripts.publish_models
      • convert_to_backward_compatible_models()
      • update_sha()

Indices and tables

• Index

• Module Index

• Search Page