hy2dl.utils

hy2dl.utils.get_distribution(distribution: str) → BaseDistribution

Get distribution object, depending on the run configuration.

Parameters:

cfg (Config) – The run configuration.

Returns:

A new distribution instance of the type specified in the config.

Return type:

distribution.BaseDistribution

• Configuration object
  • Config
    • Config.ar_teacher_forcing
    • Config.batch_size_evaluation
    • Config.batch_size_training
    • Config.conceptual_model
    • Config.custom_scaler
    • Config.custom_seq_processing
    • Config.custom_seq_processing_flag
    • Config.dataset
    • Config.dataset_in_ram
    • Config.device
    • Config.distribution
    • Config.dropout_rate
    • Config.dump()
    • Config.dynamic_embedding
    • Config.dynamic_input
    • Config.dynamic_input_conceptual_model
    • Config.dynamic_parameterization_conceptual_model
    • Config.epochs
    • Config.experiment_name
    • Config.forcings
    • Config.forecast_counter
    • Config.forecast_dataset_in_ram
    • Config.forecast_input
    • Config.hidden_size
    • Config.init_experiment()
    • Config.initial_forget_bias
    • Config.lagged_features
    • Config.learning_rate
    • Config.loss
    • Config.max_updates_per_epoch
    • Config.model
    • Config.nan_handling_method
    • Config.nan_probabilistic_masking
    • Config.nan_probability
    • Config.noise_level
    • Config.num_conceptual_models
    • Config.num_mixture_components
    • Config.num_workers
    • Config.optimizer
    • Config.output_features
    • Config.path_additional_features
    • Config.path_data
    • Config.path_dataset_testing
    • Config.path_dataset_training
    • Config.path_dataset_validation
    • Config.path_entities
    • Config.path_entities_testing
    • Config.path_entities_training
    • Config.path_entities_validation
    • Config.path_forecast_dataset
    • Config.path_save_folder
    • Config.path_save_zarr
    • Config.path_valid_samples_testing
    • Config.path_valid_samples_training
    • Config.path_valid_samples_validation
    • Config.predict_last_n
    • Config.pseudo_forecast_ar_input
    • Config.pseudo_forecast_input
    • Config.ram_safety_factor
    • Config.random_seed
    • Config.routing_model
    • Config.seq_length
    • Config.seq_length_forecast
    • Config.seq_length_hindcast
    • Config.static_embedding
    • Config.static_input
    • Config.steplr_gamma
    • Config.steplr_step_size
    • Config.target
    • Config.target_weights
    • Config.teacher_forcing_scheduler
    • Config.testing_metrics
    • Config.testing_period
    • Config.training_period
    • Config.unique_prediction_blocks
    • Config.validate_every
    • Config.validation_metric
    • Config.validation_period
• Probabilistic distributions
  • AsymmetricLaplaceMixture
    • AsymmetricLaplaceMixture.backtransform_parameters()
    • AsymmetricLaplaceMixture.calc_cdf()
    • AsymmetricLaplaceMixture.calc_logpdf()
    • AsymmetricLaplaceMixture.map_parameters()
    • AsymmetricLaplaceMixture.mean()
    • AsymmetricLaplaceMixture.parameters
    • AsymmetricLaplaceMixture.sample()
  • BaseDistribution
    • BaseDistribution.backtransform_parameters()
    • BaseDistribution.calc_cdf()
    • BaseDistribution.calc_logpdf()
    • BaseDistribution.map_parameters()
    • BaseDistribution.mean()
    • BaseDistribution.parameters
    • BaseDistribution.pit()
    • BaseDistribution.quantile()
    • BaseDistribution.sample()
  • GaussianMixture
    • GaussianMixture.backtransform_parameters()
    • GaussianMixture.calc_cdf()
    • GaussianMixture.calc_logpdf()
    • GaussianMixture.map_parameters()
    • GaussianMixture.mean()
    • GaussianMixture.parameters
    • GaussianMixture.sample()
• Logger
  • TqdmHandler
    • TqdmHandler.emit()
  • get_logger()
• Sampler
  • GaugeBatchSampler
• Utilities
  • set_random_seed()
  • upload_to_device()