Skip to main content
Ctrl+K

lightning-template 1.5.5 documentation

Get Started

  • Installation
  • Usage
  • Contribution
  • Changelog

Core

  • LightningModule
  • LightningDataModule
  • Optimizer Config
  • Trainer

Configuration

  • Deep Update
  • Recommend Config File Structure
  • Argument Parsers
    • Json File Argument Parser
    • Yaml with merge Argument Parser

Tools

  • Command Line Interface

API References

  • lightning_template
    • lightning_template.datasets
      • lightning_template.datasets.base
    • lightning_template.models
      • lightning_template.models.base
    • lightning_template.tools
      • lightning_template.tools.model
        • lightning_template.tools.model.batch_size_finder
        • lightning_template.tools.model.lr_finder
        • lightning_template.tools.model.model_statistics
      • lightning_template.tools.cli
    • lightning_template.utils
      • lightning_template.utils.callbacks
        • lightning_template.utils.callbacks.custom_repr
        • lightning_template.utils.callbacks.model_checkpoint
        • lightning_template.utils.callbacks.save_and_log_config_callback
        • lightning_template.utils.callbacks.set_precision_and_cudnn_callback
        • lightning_template.utils.callbacks.set_sharing_strategy_callback
        • lightning_template.utils.callbacks.set_wandb_logger_callback
      • lightning_template.utils.cli
        • lightning_template.utils.cli.argument_parsers
        • lightning_template.utils.cli.cli
        • lightning_template.utils.cli.instantiate_class
        • lightning_template.utils.cli.trainer
      • lightning_template.utils.loggers
        • lightning_template.utils.loggers.wandb
      • lightning_template.utils.loop
        • lightning_template.utils.loop.kfold
      • lightning_template.utils.mixin
        • lightning_template.utils.mixin.split_name_mixin
      • lightning_template.utils.optim
        • lightning_template.utils.optim.configure_optimizers
        • lightning_template.utils.optim.keep_and_linearly_decay_lr_scheduler
        • lightning_template.utils.optim.warmup_lr_scheduler
      • lightning_template.utils.progress
        • lightning_template.utils.progress.rich_progress
      • lightning_template.utils.timer
        • lightning_template.utils.timer.timer
    • lightning_template.version
  • .rst

lightning_template.utils.mixin

Contents

  • Submodules
  • Package Contents
    • Classes
      • SplitNameMixin
        • SplitNameMixin.TrainSplit
        • SplitNameMixin.ValidateSplit
        • SplitNameMixin.TestSplit
        • SplitNameMixin.PredictSplit
        • SplitNameMixin.SplitNameMap
        • SplitNameMixin._get_split_names()
        • SplitNameMixin.setup()
        • SplitNameMixin.substitute_split_name()
        • SplitNameMixin.get_split_config()

lightning_template.utils.mixin#

Submodules#

  • lightning_template.utils.mixin.split_name_mixin

Package Contents#

Classes#

SplitNameMixin

class lightning_template.utils.mixin.SplitNameMixin#
TrainSplit = 'fit'#
ValidateSplit = 'val'#
TestSplit = 'test'#
PredictSplit = 'predict'#
SplitNameMap#
_get_split_names(stage=None)#
setup(stage=None)#
static substitute_split_name(cur_cfg, split_prefix, split_attr, split_attr_split_str, split_name_map, split_name, *args, **kwargs)#
get_split_config(config)#

previous

lightning_template.utils.loop.kfold

next

lightning_template.utils.mixin.split_name_mixin

Contents
  • Submodules
  • Package Contents
    • Classes
      • SplitNameMixin
        • SplitNameMixin.TrainSplit
        • SplitNameMixin.ValidateSplit
        • SplitNameMixin.TestSplit
        • SplitNameMixin.PredictSplit
        • SplitNameMixin.SplitNameMap
        • SplitNameMixin._get_split_names()
        • SplitNameMixin.setup()
        • SplitNameMixin.substitute_split_name()
        • SplitNameMixin.get_split_config()

By shenmishajing

© Copyright 2023, shenmishajing.