HypersphereUniformSampler

Basic sampler sampling from a uniform distribution on the hypersphere in the Autoencoder’s latent space.

Available models:

SVAE

\(\mathcal{S}\)-VAE model.
class pythae.samplers.HypersphereUniformSampler(model, sampler_config=None)[source]

Sampling from uniform distribution on hypersphere.

Parameters

  • model (BaseAE) – The vae model to sample from.

  • sampler_config (BaseSamplerConfig) – An instance of BaseSamplerConfig in which any sampler’s parameters is made available. If None a default configuration is used. Default: None

sample(num_samples=1, batch_size=500, output_dir=None, return_gen=True, save_sampler_config=False)[source]

Main sampling function of the sampler.

Parameters

  • num_samples (int) – The number of samples to generate

  • batch_size (int) – The batch size to use during sampling

  • output_dir (str) – The directory where the images will be saved. If does not exist the folder is created. If None: the images are not saved. Defaults: None.

  • return_gen (bool) – Whether the sampler should directly return a tensor of generated data. Default: True.

  • save_sampler_config (bool) – Whether to save the sampler config. It is saved in output_dir.

Returns

The generated images

Return type

Tensor