Contents Menu Expand Light mode Dark mode Auto light/dark mode
GluonTS documentation
Logo
GluonTS documentation

Getting started

  • Installation
  • Background
  • Concepts
  • Available models

Tutorials

  • Basic Usage
    • Quick Start Tutorial
    • Extended Forecasting Tutorial
    • Hierarchical Model Tutorial
  • Data Manipulation
    • pandas.DataFrame based dataset
    • Splitting datasets into training and test
    • Synthetic data generation
  • Advanced
    • Custom models with PyTorch
    • Tuning models with Optuna
    • Trainer callbacks

API docs

  • API Docs
    • gluonts.core package
      • gluonts.core.serde package
        • gluonts.core.serde.flat module
        • gluonts.core.serde.np module
        • gluonts.core.serde.pd module
      • gluonts.core.component module
      • gluonts.core.settings module
    • gluonts.dataset package
      • gluonts.dataset.arrow package
        • gluonts.dataset.arrow.dec module
        • gluonts.dataset.arrow.enc module
        • gluonts.dataset.arrow.file module
      • gluonts.dataset.artificial package
        • gluonts.dataset.artificial.ar_p module
        • gluonts.dataset.artificial.recipe module
      • gluonts.dataset.repository package
        • gluonts.dataset.repository.datasets module
      • gluonts.dataset.schema package
        • gluonts.dataset.schema.translate module
      • gluonts.dataset.common module
      • gluonts.dataset.field_names module
      • gluonts.dataset.hierarchical module
      • gluonts.dataset.jsonl module
      • gluonts.dataset.loader module
      • gluonts.dataset.multivariate_grouper module
      • gluonts.dataset.pandas module
      • gluonts.dataset.rolling_dataset module
      • gluonts.dataset.split module
      • gluonts.dataset.stat module
      • gluonts.dataset.util module
    • gluonts.evaluation package
      • gluonts.evaluation.backtest module
      • gluonts.evaluation.metrics module
    • gluonts.meta package
      • gluonts.meta.cli module
      • gluonts.meta.colors module
      • gluonts.meta.style module
    • gluonts.model package
      • gluonts.model.canonical package
      • gluonts.model.deep_factor package
      • gluonts.model.deepar package
      • gluonts.model.deepstate package
      • gluonts.model.deepvar package
      • gluonts.model.deepvar_hierarchical package
      • gluonts.model.gp_forecaster package
      • gluonts.model.gpvar package
      • gluonts.model.lstnet package
      • gluonts.model.n_beats package
      • gluonts.model.naive_2 package
      • gluonts.model.npts package
      • gluonts.model.prophet package
      • gluonts.model.r_forecast package
      • gluonts.model.renewal package
      • gluonts.model.rotbaum package
      • gluonts.model.san package
      • gluonts.model.seasonal_naive package
      • gluonts.model.seq2seq package
      • gluonts.model.simple_feedforward package
      • gluonts.model.tft package
      • gluonts.model.tpp package
      • gluonts.model.transformer package
      • gluonts.model.trivial package
        • gluonts.model.trivial.constant module
        • gluonts.model.trivial.identity module
        • gluonts.model.trivial.mean module
      • gluonts.model.wavenet package
      • gluonts.model.common module
      • gluonts.model.estimator module
      • gluonts.model.forecast module
      • gluonts.model.forecast_generator module
      • gluonts.model.predictor module
    • gluonts.mx package
      • gluonts.mx.block package
        • gluonts.mx.block.cnn module
        • gluonts.mx.block.decoder module
        • gluonts.mx.block.dropout module
        • gluonts.mx.block.enc2dec module
        • gluonts.mx.block.encoder module
        • gluonts.mx.block.feature module
        • gluonts.mx.block.mlp module
        • gluonts.mx.block.quantile_output module
        • gluonts.mx.block.regularization module
        • gluonts.mx.block.rnn module
        • gluonts.mx.block.scaler module
        • gluonts.mx.block.sndense module
        • gluonts.mx.block.snmlp module
      • gluonts.mx.distribution package
        • gluonts.mx.distribution.beta module
        • gluonts.mx.distribution.bijection module
        • gluonts.mx.distribution.bijection_output module
        • gluonts.mx.distribution.binned module
        • gluonts.mx.distribution.box_cox_transform module
        • gluonts.mx.distribution.categorical module
        • gluonts.mx.distribution.deterministic module
        • gluonts.mx.distribution.dirichlet module
        • gluonts.mx.distribution.dirichlet_multinomial module
        • gluonts.mx.distribution.distribution module
        • gluonts.mx.distribution.distribution_output module
        • gluonts.mx.distribution.empirical_distribution module
        • gluonts.mx.distribution.gamma module
        • gluonts.mx.distribution.gaussian module
        • gluonts.mx.distribution.genpareto module
        • gluonts.mx.distribution.inflated_beta module
        • gluonts.mx.distribution.iresnet module
        • gluonts.mx.distribution.isqf module
        • gluonts.mx.distribution.laplace module
        • gluonts.mx.distribution.lds module
        • gluonts.mx.distribution.logit_normal module
        • gluonts.mx.distribution.lowrank_gp module
        • gluonts.mx.distribution.lowrank_multivariate_gaussian module
        • gluonts.mx.distribution.mixture module
        • gluonts.mx.distribution.multivariate_gaussian module
        • gluonts.mx.distribution.nan_mixture module
        • gluonts.mx.distribution.neg_binomial module
        • gluonts.mx.distribution.piecewise_linear module
        • gluonts.mx.distribution.poisson module
        • gluonts.mx.distribution.student_t module
        • gluonts.mx.distribution.transformed_distribution module
        • gluonts.mx.distribution.transformed_distribution_output module
        • gluonts.mx.distribution.uniform module
      • gluonts.mx.kernels package
      • gluonts.mx.model package
        • gluonts.mx.model.canonical package
        • gluonts.mx.model.deep_factor package
          • gluonts.mx.model.deep_factor.RNNModel module
        • gluonts.mx.model.deepar package
        • gluonts.mx.model.deepstate package
          • gluonts.mx.model.deepstate.issm module
        • gluonts.mx.model.deepvar package
        • gluonts.mx.model.deepvar_hierarchical package
        • gluonts.mx.model.gp_forecaster package
          • gluonts.mx.model.gp_forecaster.gaussian_process module
        • gluonts.mx.model.gpvar package
        • gluonts.mx.model.lstnet package
        • gluonts.mx.model.n_beats package
        • gluonts.mx.model.renewal package
        • gluonts.mx.model.san package
        • gluonts.mx.model.seq2seq package
        • gluonts.mx.model.simple_feedforward package
        • gluonts.mx.model.tft package
        • gluonts.mx.model.tpp package
          • gluonts.mx.model.tpp.deeptpp package
          • gluonts.mx.model.tpp.distribution package
            • gluonts.mx.model.tpp.distribution.base module
            • gluonts.mx.model.tpp.distribution.loglogistic module
            • gluonts.mx.model.tpp.distribution.weibull module
          • gluonts.mx.model.tpp.forecast module
          • gluonts.mx.model.tpp.predictor module
        • gluonts.mx.model.transformer package
          • gluonts.mx.model.transformer.layers module
          • gluonts.mx.model.transformer.trans_decoder module
          • gluonts.mx.model.transformer.trans_encoder module
        • gluonts.mx.model.wavenet package
        • gluonts.mx.model.estimator module
        • gluonts.mx.model.forecast module
        • gluonts.mx.model.forecast_generator module
        • gluonts.mx.model.predictor module
      • gluonts.mx.representation package
        • gluonts.mx.representation.binning_helpers module
        • gluonts.mx.representation.custom_binning module
        • gluonts.mx.representation.dim_expansion module
        • gluonts.mx.representation.discrete_pit module
        • gluonts.mx.representation.embedding module
        • gluonts.mx.representation.global_relative_binning module
        • gluonts.mx.representation.hybrid_representation module
        • gluonts.mx.representation.local_absolute_binning module
        • gluonts.mx.representation.mean_scaling module
        • gluonts.mx.representation.representation module
        • gluonts.mx.representation.representation_chain module
      • gluonts.mx.trainer package
        • gluonts.mx.trainer.callback module
        • gluonts.mx.trainer.learning_rate_scheduler module
        • gluonts.mx.trainer.model_averaging module
        • gluonts.mx.trainer.model_iteration_averaging module
      • gluonts.mx.activation module
      • gluonts.mx.batchify module
      • gluonts.mx.component module
      • gluonts.mx.context module
      • gluonts.mx.linalg_util module
      • gluonts.mx.prelude module
      • gluonts.mx.serde module
      • gluonts.mx.util module
    • gluonts.nursery package
      • gluonts.nursery.SCott namespace
        • gluonts.nursery.SCott.dataset_tools namespace
          • gluonts.nursery.SCott.dataset_tools.algo_clustering module
          • gluonts.nursery.SCott.dataset_tools.electricity module
          • gluonts.nursery.SCott.dataset_tools.exchange_rate module
          • gluonts.nursery.SCott.dataset_tools.group_raw_data module
          • gluonts.nursery.SCott.dataset_tools.preprocess_data module
          • gluonts.nursery.SCott.dataset_tools.synthetic module
          • gluonts.nursery.SCott.dataset_tools.traffic module
        • gluonts.nursery.SCott.model package
          • gluonts.nursery.SCott.model.ar package
            • gluonts.nursery.SCott.model.ar.ar_estimator module
            • gluonts.nursery.SCott.model.ar.ar_network module
          • gluonts.nursery.SCott.model.lstm package
            • gluonts.nursery.SCott.model.lstm.lstm_estimator module
            • gluonts.nursery.SCott.model.lstm.lstm_network module
        • gluonts.nursery.SCott.trainers package
          • gluonts.nursery.SCott.trainers.Adagrad module
          • gluonts.nursery.SCott.trainers.Adam module
          • gluonts.nursery.SCott.trainers.SAdagrad module
          • gluonts.nursery.SCott.trainers.SAdam module
          • gluonts.nursery.SCott.trainers.SCSG module
          • gluonts.nursery.SCott.trainers.SCott module
          • gluonts.nursery.SCott.trainers.SGD module
          • gluonts.nursery.SCott.trainers.timer module
        • gluonts.nursery.SCott.preprocess_data module
        • gluonts.nursery.SCott.run module
      • gluonts.nursery.anomaly_detection package
        • gluonts.nursery.anomaly_detection.supervised_metrics package
          • gluonts.nursery.anomaly_detection.supervised_metrics.bounded_pr_auc module
          • gluonts.nursery.anomaly_detection.supervised_metrics.utils module
        • gluonts.nursery.anomaly_detection.filters module
      • gluonts.nursery.auto_ode namespace
        • gluonts.nursery.auto_ode.auto_ode module
      • gluonts.nursery.autogluon_tabular package
        • gluonts.nursery.autogluon_tabular.estimator module
        • gluonts.nursery.autogluon_tabular.example module
        • gluonts.nursery.autogluon_tabular.predictor module
        • gluonts.nursery.autogluon_tabular.quantile_example module
      • gluonts.nursery.glide package
        • gluonts.nursery.glide.parallel module
        • gluonts.nursery.glide.pipeline module
        • gluonts.nursery.glide.sequential module
        • gluonts.nursery.glide.util module
      • gluonts.nursery.gmm_tpp namespace
        • gluonts.nursery.gmm_tpp.gmm_base module
        • gluonts.nursery.gmm_tpp.simulation module
      • gluonts.nursery.sagemaker_sdk package
        • gluonts.nursery.sagemaker_sdk.entry_point_scripts namespace
          • gluonts.nursery.sagemaker_sdk.entry_point_scripts.run_entry_point module
          • gluonts.nursery.sagemaker_sdk.entry_point_scripts.train_entry_point module
        • gluonts.nursery.sagemaker_sdk.defaults module
        • gluonts.nursery.sagemaker_sdk.estimator module
        • gluonts.nursery.sagemaker_sdk.model module
        • gluonts.nursery.sagemaker_sdk.utils module
      • gluonts.nursery.spliced_binned_pareto package
        • gluonts.nursery.spliced_binned_pareto.data_functions module
        • gluonts.nursery.spliced_binned_pareto.distr_tcn module
        • gluonts.nursery.spliced_binned_pareto.gaussian_model module
        • gluonts.nursery.spliced_binned_pareto.genpareto module
        • gluonts.nursery.spliced_binned_pareto.spliced_binned_pareto module
        • gluonts.nursery.spliced_binned_pareto.tcn module
        • gluonts.nursery.spliced_binned_pareto.training_functions module
    • gluonts.shell package
      • gluonts.shell.sagemaker package
        • gluonts.shell.sagemaker.dyn module
        • gluonts.shell.sagemaker.nested_params module
        • gluonts.shell.sagemaker.params module
        • gluonts.shell.sagemaker.serve module
        • gluonts.shell.sagemaker.train module
      • gluonts.shell.serve package
        • gluonts.shell.serve.app module
      • gluonts.shell.env module
      • gluonts.shell.exceptions module
      • gluonts.shell.train module
      • gluonts.shell.util module
    • gluonts.testutil package
      • gluonts.testutil.batchify module
      • gluonts.testutil.dummy_datasets module
      • gluonts.testutil.equality module
      • gluonts.testutil.shell module
    • gluonts.time_feature package
      • gluonts.time_feature.holiday module
      • gluonts.time_feature.lag module
      • gluonts.time_feature.seasonality module
    • gluonts.torch package
      • gluonts.torch.distributions package
        • gluonts.torch.distributions.affine_transformed module
        • gluonts.torch.distributions.binned_uniforms module
        • gluonts.torch.distributions.discrete_distribution module
        • gluonts.torch.distributions.distribution_output module
        • gluonts.torch.distributions.generalized_pareto module
        • gluonts.torch.distributions.isqf module
        • gluonts.torch.distributions.mqf2 module
        • gluonts.torch.distributions.piecewise_linear module
        • gluonts.torch.distributions.spliced_binned_pareto module
      • gluonts.torch.model package
        • gluonts.torch.model.deep_npts package
          • gluonts.torch.model.deep_npts.scaling module
        • gluonts.torch.model.deepar package
          • gluonts.torch.model.deepar.estimator module
          • gluonts.torch.model.deepar.lightning_module module
          • gluonts.torch.model.deepar.module module
        • gluonts.torch.model.mqf2 package
          • gluonts.torch.model.mqf2.estimator module
          • gluonts.torch.model.mqf2.icnn_utils module
          • gluonts.torch.model.mqf2.lightning_module module
          • gluonts.torch.model.mqf2.module module
        • gluonts.torch.model.simple_feedforward package
          • gluonts.torch.model.simple_feedforward.estimator module
          • gluonts.torch.model.simple_feedforward.lightning_module module
          • gluonts.torch.model.simple_feedforward.module module
        • gluonts.torch.model.estimator module
        • gluonts.torch.model.forecast module
        • gluonts.torch.model.forecast_generator module
        • gluonts.torch.model.predictor module
      • gluonts.torch.modules package
        • gluonts.torch.modules.feature module
        • gluonts.torch.modules.lambda_layer module
        • gluonts.torch.modules.loss module
        • gluonts.torch.modules.scaler module
      • gluonts.torch.batchify module
      • gluonts.torch.component module
      • gluonts.torch.prelude module
      • gluonts.torch.util module
    • gluonts.transform package
      • gluonts.transform.convert module
      • gluonts.transform.feature module
      • gluonts.transform.field module
      • gluonts.transform.sampler module
      • gluonts.transform.split module
    • gluonts.env module
    • gluonts.exceptions module
    • gluonts.gluonts_tqdm module
    • gluonts.itertools module
    • gluonts.json module
    • gluonts.util module

Developing

  • Contributing Guidelines
  • Development Setup
Back to top

gluonts.env module#

class gluonts.env.Environment(*args, **kwargs)[source]#

Bases: gluonts.core.settings.Settings

max_idle_transforms: int = '100'#
use_tqdm: bool = True#
Next
gluonts.exceptions module
Previous
gluonts.transform.split module
Copyright © 2022, Amazon
Made with Sphinx and @pradyunsg's Furo