Skip to content

Shared Imports Reference ​

Common import patterns used throughout the foreBlocks documentation. Each block uses VitePress ::: code-group tabbed syntax.

Core foreblocks ​

python
from foreblocks import (
    ForecastingModel,
    Trainer,
    ModelEvaluator,
    TimeSeriesHandler,
    TimeSeriesDataset,
    create_dataloaders,
    ModelConfig,
    TrainingConfig,
)
python
from foreblocks import TransformerEncoder, TransformerDecoder
python
from foreblocks.training.config import TrainingConfig
from foreblocks.models.config import ModelConfig

See Public API for the full import surface.

Transformer internals ​

python
from foreblocks.nn.routing.mod import (
    LayerDropoutSchedule,
    MoDBudgetScheduler,
)
python
from foreblocks.nn.moe.feedforward import FeedForwardBlock
python
from foreblocks.nn.transformer.config import TransformerConfig
from foreblocks.nn.attention.config import (
    AttentionConfig,
    AttentionShapeConfig,
    AttentionPositionConfig,
    AttentionVariantConfig,
)

Uncertainty / Conformal ​

python
from foreblocks.training.conformal import ConformalPredictionEngine

Wavelet & frequency attention ​

Select via attention= on the transformer — no separate import needed:

python
from foreblocks import TransformerEncoder

# Wavelet-domain (Haar DWT) attention
enc = TransformerEncoder(input_size=8, d_model=64, num_layers=2, attention="dwt")

# Frequency-domain (FEDformer-style) attention
enc = TransformerEncoder(input_size=8, d_model=64, num_layers=2, attention="frequency")

DARTS (separate package) ​

DARTS is imported as a standalone package, not under foreblocks:

python
from darts import DARTSTrainer
python
from darts import DARTSTrainConfig

foretools ​

python
from foretools.bohb import BOHB, PruningConfig, TPEConf
from foretools.bohb.plotter import OptimizationPlotter
from foretools.bohb.trial import TrialPruned
python
from foretools.tsgen import TimeSeriesGenerator
python
import numpy as np
from foretools.decomposition.emd import FastVMD
python
import torch
from foretools.tsaug import AutoDATimeseries, AutoDATrainer
python
from foretools.fengineer import FeatureEngineer
from foretools.fengineer.transformers import FeatureConfig

Install extras quick ref ​

bash
pip install foreblocks
bash
pip install "foreblocks[darts]"
bash
pip install "foreblocks[vmd]"
bash
pip install "foreblocks[all]"

See Getting Started for the full install map and extras table.

MIT License