Skip to content

Public API ​

This page documents the main top-level imports exposed by foreblocks.

python
from foreblocks import (
    ForecastingModel,
    Trainer,
    ModelEvaluator,
    TimeSeriesHandler,
    TimeSeriesDataset,
    create_dataloaders,
    ModelConfig,
    TrainingConfig,
    LSTMEncoder,
    LSTMDecoder,
    GRUEncoder,
    GRUDecoder,
    TransformerEncoder,
    TransformerDecoder,
    AttentionLayer,
    GraphForecastingModel,
    TransformerTuner,
)

foreblocks/__init__.py lazy-loads (__getattr__ + TYPE_CHECKING) this stable, deliberately small __all__. Anything not in it is an internal import path and can move without a deprecation cycle; anything in it moving is a breaking change.

Resolution targets ​

Where each export actually lives — useful when the name alone doesn't tell you the subpackage:

ExportResolves to
AttentionLayerforeblocks.nn.attention.layer
ForecastingModel, GraphForecastingModelforeblocks.models
Trainerforeblocks.training
ModelEvaluatorforeblocks.evaluation
TimeSeriesHandlerforeblocks.processing
TimeSeriesDataset, create_dataloadersforeblocks.data
ModelConfig, TrainingConfigforeblocks.config
LSTMEncoder, LSTMDecoder, GRUEncoder, GRUDecoderforeblocks.nn.blocks.recurrent
TransformerEncoderforeblocks.nn.transformer.encoder
TransformerDecoderforeblocks.nn.transformer.decoder
TransformerTunerforeblocks.tuning.transformer

MIT License