NeuralHydrology API

• nh.datasetzoo
  • get_dataset()
  • BaseDataset
    • BaseDataset
      • BaseDataset.collate_fn()
      • BaseDataset.get_period_start()
    • validate_samples()
  • CamelsAUS
    • CamelsAUS
    • load_camels_aus_attributes()
    • load_camels_aus_timeseries()
    • preprocess_camels_aus_dataset()
  • CamelsBR
    • CamelsBR
    • load_camels_br_attributes()
    • load_camels_br_timeseries()
    • preprocess_camels_br_dataset()
  • CamelsCL
    • CamelsCL
    • load_camels_cl_attributes()
    • load_camels_cl_timeseries()
    • preprocess_camels_cl_dataset()
  • CamelsGB
    • CamelsGB
    • load_camels_gb_attributes()
    • load_camels_gb_timeseries()
  • CamelsUS
    • CamelsUS
    • load_camels_us_attributes()
    • load_camels_us_discharge()
    • load_camels_us_forcings()
  • Caravan
    • Caravan
    • load_caravan_attributes()
    • load_caravan_timeseries()
  • GenericDataset
    • GenericDataset
    • load_attributes()
    • load_timeseries()
  • HourlyCamelsUS
    • HourlyCamelsUS
      • HourlyCamelsUS.load_hourly_data()
    • load_hourly_us_discharge()
    • load_hourly_us_forcings()
    • load_hourly_us_netcdf()
    • load_hourly_us_stage()
  • LamaH
    • LamaH
    • load_lamah_attributes()
    • load_lamah_discharge()
    • load_lamah_forcing()
  • TemplateDataset
    • TemplateDataset
• nh.datautils
  • climateindices
    • calculate_camels_us_dyn_climate_indices()
    • calculate_dyn_climate_indices()
  • pet
    • get_priestley_taylor_pet()
  • utils
    • attributes_sanity_check()
    • compare_frequencies()
    • get_frequency_factor()
    • infer_datetime_coord()
    • infer_frequency()
    • load_basin_file()
    • load_hydroatlas_attributes()
    • load_scaler()
    • sort_frequencies()
• nh.evaluation
  • get_tester()
  • evaluate
    • start_evaluation()
  • metrics
    • alpha_nse()
    • beta_kge()
    • beta_nse()
    • calculate_all_metrics()
    • calculate_metrics()
    • fdc_fhv()
    • fdc_flv()
    • fdc_fms()
    • get_available_metrics()
    • kge()
    • mean_absolute_percentage_peak_error()
    • mean_peak_timing()
    • missed_peaks()
    • mse()
    • nse()
    • pearsonr()
    • rmse()
  • plots
    • percentile_plot()
    • regression_plot()
    • uncertainty_plot()
  • signatures
    • baseflow_index()
    • calculate_all_signatures()
    • calculate_signatures()
    • get_available_signatures()
    • hfd_mean()
    • high_q_dur()
    • high_q_freq()
    • low_q_dur()
    • low_q_freq()
    • q5()
    • q95()
    • q_mean()
    • runoff_ratio()
    • slope_fdc()
    • stream_elas()
    • zero_q_freq()
  • Tester
    • BaseTester
      • BaseTester.evaluate()
    • RegressionTester
    • UncertaintyTester
• nh.modelzoo
  • get_model()
  • ARLSTM
    • ARLSTM
      • ARLSTM.forward()
  • BaseModel
    • BaseModel
      • BaseModel.forward()
      • BaseModel.module_parts
      • BaseModel.pre_model_hook()
      • BaseModel.sample()
  • CudaLSTM
    • CudaLSTM
      • CudaLSTM.forward()
      • CudaLSTM.module_parts
  • CustomLSTM
    • CustomLSTM
      • CustomLSTM.copy_weights()
      • CustomLSTM.forward()
  • EALSTM
    • EALSTM
      • EALSTM.forward()
      • EALSTM.module_parts
  • EmbCudaLSTM
    • EmbCudaLSTM
      • EmbCudaLSTM.forward()
      • EmbCudaLSTM.module_parts
  • FC
    • FC
      • FC.forward()
  • GRU
    • GRU
      • GRU.forward()
      • GRU.module_parts
  • HandoffForecastLSTM
    • HandoffForecastLSTM
      • HandoffForecastLSTM.forward()
      • HandoffForecastLSTM.module_parts
  • head
    • CMAL
      • CMAL.forward()
    • GMM
      • GMM.forward()
    • Regression
      • Regression.forward()
    • UMAL
      • UMAL.forward()
    • get_head()
  • InputLayer
    • InputLayer
      • InputLayer.forward()
  • Mamba
    • Mamba
      • Mamba.forward()
      • Mamba.module_parts
  • MC-LSTM
    • MCLSTM
      • MCLSTM.forward()
      • MCLSTM.module_parts
  • MultiheadForecastLSTM
    • MultiHeadForecastLSTM
      • MultiHeadForecastLSTM.forward()
      • MultiHeadForecastLSTM.module_parts
  • MTSLSTM
    • MTSLSTM
      • MTSLSTM.forward()
      • MTSLSTM.module_parts
  • ODELSTM
    • ODELSTM
      • ODELSTM.forward()
      • ODELSTM.module_parts
  • SequentialForecastLSTM
    • SequentialForecastLSTM
      • SequentialForecastLSTM.forward()
      • SequentialForecastLSTM.module_parts
  • StackedForecastLSTM
    • StackedForecastLSTM
      • StackedForecastLSTM.forward()
      • StackedForecastLSTM.module_parts
  • TemplateModel
    • TemplateModel
      • TemplateModel.forward()
      • TemplateModel.module_parts
  • Transformer
    • Transformer
      • Transformer.forward()
      • Transformer.module_parts
• nh.training
  • get_loss_obj()
  • get_optimizer()
  • get_regularization_obj()
  • BaseTrainer
    • BaseTrainer
      • BaseTrainer.initialize_training()
      • BaseTrainer.train_and_validate()
  • Logger
    • Logger
      • Logger.log_figures()
      • Logger.log_step()
      • Logger.start_tb()
      • Logger.stop_tb()
      • Logger.summarise()
      • Logger.tag
      • Logger.train()
      • Logger.valid()
  • loss
    • BaseLoss
      • BaseLoss.forward()
      • BaseLoss.set_regularization_terms()
    • MaskedCMALLoss
    • MaskedGMMLoss
    • MaskedMSELoss
    • MaskedNSELoss
    • MaskedRMSELoss
    • MaskedUMALLoss
  • regularization
    • BaseRegularization
      • BaseRegularization.forward()
    • ForecastOverlapMSERegularization
      • ForecastOverlapMSERegularization.forward()
    • TiedFrequencyMSERegularization
      • TiedFrequencyMSERegularization.forward()
  • train
    • start_training()
• nh.utils
  • config
    • Config
      • Config.additional_feature_files
      • Config.allow_subsequent_nan_losses
      • Config.as_dict()
      • Config.autoregressive_inputs
      • Config.base_run_dir
      • Config.batch_size
      • Config.bidirectional_stacked_forecast_lstm
      • Config.cache_validation_data
      • Config.checkpoint_path
      • Config.clip_gradient_norm
      • Config.clip_targets_to_zero
      • Config.conceptual_model
      • Config.continue_from_epoch
      • Config.custom_normalization
      • Config.data_dir
      • Config.dataset
      • Config.device
      • Config.dump_config()
      • Config.duplicate_features
      • Config.dynamic_conceptual_inputs
      • Config.dynamic_inputs
      • Config.dynamics_embedding
      • Config.epochs
      • Config.evolving_attributes
      • Config.experiment_name
      • Config.finetune_modules
      • Config.forcings
      • Config.forecast_hidden_size
      • Config.forecast_inputs
      • Config.forecast_network
      • Config.forecast_overlap
      • Config.forecast_seq_length
      • Config.head
      • Config.hidden_size
      • Config.hindcast_hidden_size
      • Config.hindcast_inputs
      • Config.hydroatlas_attributes
      • Config.img_log_dir
      • Config.initial_forget_bias
      • Config.is_continue_training
      • Config.is_finetuning
      • Config.lagged_features
      • Config.learning_rate
      • Config.log_interval
      • Config.log_n_figures
      • Config.log_tensorboard
      • Config.loss
      • Config.mamba_d_conv
      • Config.mamba_d_state
      • Config.mamba_expand
      • Config.mass_inputs
      • Config.max_updates_per_epoch
      • Config.mc_dropout
      • Config.metrics
      • Config.model
      • Config.n_distributions
      • Config.n_samples
      • Config.n_taus
      • Config.negative_sample_handling
      • Config.negative_sample_max_retries
      • Config.no_loss_frequencies
      • Config.num_workers
      • Config.number_of_basins
      • Config.ode_method
      • Config.ode_num_unfolds
      • Config.ode_random_freq_lower_bound
      • Config.optimizer
      • Config.output_activation
      • Config.output_dropout
      • Config.per_basin_test_periods_file
      • Config.per_basin_train_periods_file
      • Config.per_basin_validation_periods_file
      • Config.predict_last_n
      • Config.random_holdout_from_dynamic_features
      • Config.rating_curve_file
      • Config.regularization
      • Config.run_dir
      • Config.save_all_output
      • Config.save_git_diff
      • Config.save_train_data
      • Config.save_validation_results
      • Config.save_weights_every
      • Config.seed
      • Config.seq_length
      • Config.shared_mtslstm
      • Config.state_handoff_network
      • Config.static_attributes
      • Config.statics_embedding
      • Config.target_loss_weights
      • Config.target_noise_std
      • Config.target_variables
      • Config.tau_down
      • Config.tau_up
      • Config.test_basin_file
      • Config.test_end_date
      • Config.test_start_date
      • Config.timestep_counter
      • Config.train_basin_file
      • Config.train_data_file
      • Config.train_dir
      • Config.train_end_date
      • Config.train_start_date
      • Config.transfer_mtslstm_states
      • Config.transformer_dim_feedforward
      • Config.transformer_dropout
      • Config.transformer_nheads
      • Config.transformer_nlayers
      • Config.transformer_positional_dropout
      • Config.transformer_positional_encoding_type
      • Config.umal_extend_batch
      • Config.update_config()
      • Config.use_basin_id_encoding
      • Config.use_frequencies
      • Config.validate_every
      • Config.validate_n_random_basins
      • Config.validation_basin_file
      • Config.validation_end_date
      • Config.validation_start_date
      • Config.verbose
      • Config.warmup_period
    • create_random_name()
  • configutils
    • create_config_files()
  • errors
    • AllNaNError
    • NoEvaluationDataError
    • NoTrainDataError
  • samplingutils
    • bernoulli_subseries_sampler()
    • sample_cmal()
    • sample_gmm()
    • sample_mcd()
    • sample_pointpredictions()
    • sample_umal()
    • umal_extend_batch()

Main Entry Points

• nh_run
  • continue_run()
  • eval_run()
  • finetune()
  • start_run()
• nh_run_scheduler
  • schedule_runs()
• nh_results_ensemble module
  • create_results_ensemble()