RTnn API Reference

• rtnn package
  • Subpackages
    • rtnn.models package
      • Submodules
      • rtnn.models.rnn module
      • rtnn.models.fcn module
      • rtnn.models.transformer module
      • rtnn.models.mlp module
      • rtnn.models.pinn module
  • Submodules
  • rtnn.dataset module
    • DataPreprocessor
      • DataPreprocessor.logger
      • DataPreprocessor.stime
      • DataPreprocessor.tstep
      • DataPreprocessor.tbatch
      • DataPreprocessor.norm_mapping
      • DataPreprocessor.normalization_type
      • DataPreprocessor.sbatch
      • DataPreprocessor.years
      • DataPreprocessor.etime
      • DataPreprocessor.dfs
      • DataPreprocessor.time_blocks
      • DataPreprocessor.min_dims
      • DataPreprocessor.cosz
      • DataPreprocessor.lai
      • DataPreprocessor.ssa
      • DataPreprocessor.rs
      • DataPreprocessor.ov
      • DataPreprocessor.__init__()
      • DataPreprocessor.normalize()
  • rtnn.diagnostics module
    • Key visualization types
    • stats()
    • subplots()
    • plot_flux_and_abs_lines()
    • plot_flux_and_abs()
    • plot_all_diagnostics()
    • plot_metric_histories()
    • plot_loss_histories()
    • plot_spatial_temporal_density()
  • rtnn.evaluater module
    • NMSELoss
      • NMSELoss.__init__()
      • NMSELoss.forward()
    • NMAELoss
      • NMAELoss.__init__()
      • NMAELoss.forward()
    • physics_loss()
    • MetricTracker
      • MetricTracker.value
      • MetricTracker.count
      • MetricTracker.value_sq
      • MetricTracker.__init__()
      • MetricTracker.reset()
      • MetricTracker.update()
      • MetricTracker.getmean()
      • MetricTracker.getstd()
      • MetricTracker.getsqrtmean()
    • get_loss_function()
    • mse_all()
    • mbe_all()
    • mae_all()
    • r2_all()
    • nmae_all()
    • nmse_all()
    • mare_all()
    • gmrae_all()
    • unnorm_mpas()
    • conservation_residual()
    • calc_abs()
    • heating_rate()
    • run_validation()
  • rtnn.logger module
    • Logger
      • Logger.__init__()
      • Logger.clear_logs()
      • Logger.show_header()
      • Logger.start_task()
      • Logger.log_metrics()
      • Logger.info()
      • Logger.warning()
      • Logger.success()
      • Logger.step()
      • Logger.exception()
      • Logger.error()
  • rtnn.main module
    • Module Overview
    • Key Features
    • Data Flow
    • print_version()
    • parse_years()
    • parse_args()
    • setup_directories_and_logging()
    • log_configuration()
    • setup_device_and_seed()
    • get_data_files()
    • create_normalization_mapping()
    • create_datasets_and_loaders()
    • initialize_model()
    • load_checkpoint_if_requested()
    • train_epoch()
    • main()
  • rtnn.model_loader module
    • Module Overview
    • Supported Model Architectures
    • Architecture Details
    • Data Flow
    • load_model()
  • rtnn.model_utils module
    • Features
    • Dependencies
    • ModelUtils
      • ModelUtils.__init__()
      • ModelUtils.get_parameter_number()
      • ModelUtils.print_model_layers()
      • ModelUtils.save_checkpoint()
      • ModelUtils.load_checkpoint()
      • ModelUtils.load_training_checkpoint()
      • ModelUtils.count_parameters_by_layer()
      • ModelUtils.log_model_summary()
      • ModelUtils.save_training_checkpoint()
      • ModelUtils.save_emergency_checkpoint()
  • rtnn.utils module
    • Features
    • Dependencies
    • EasyDict
    • FileUtils
      • FileUtils.__init__()
      • FileUtils.makedir()
      • FileUtils.makefile()
  • rtnn.version module
    • get_version()