flatiron
0.26.0

Getting Started

  • Introduction
  • Installation for Developers
  • Installation for Production
  • Quickstart Guide
  • Development CLI
  • Production CLI

Python API

  • core
  • tf
  • torch

Development CLI

  • cli
flatiron
  • <no title>
  • View page source
  • core
    • config
      • BaseConfig
        • BaseConfig._abc_impl
        • BaseConfig.model_config
      • CallbacksConfig
        • CallbacksConfig.project
        • CallbacksConfig.root
        • CallbacksConfig.monitor
        • CallbacksConfig.verbose
        • CallbacksConfig.save_best_only
        • CallbacksConfig.mode
        • CallbacksConfig.save_weights_only
        • CallbacksConfig.save_freq
        • CallbacksConfig.initial_value_threshold
        • CallbacksConfig._abc_impl
        • CallbacksConfig.initial_value_threshold
        • CallbacksConfig.mode
        • CallbacksConfig.model_config
        • CallbacksConfig.monitor
        • CallbacksConfig.project
        • CallbacksConfig.root
        • CallbacksConfig.save_best_only
        • CallbacksConfig.save_freq
        • CallbacksConfig.save_weights_only
        • CallbacksConfig.verbose
      • DatasetConfig
        • DatasetConfig.source
        • DatasetConfig.ext_regex
        • DatasetConfig.labels
        • DatasetConfig.label_axis
        • DatasetConfig.test_size
        • DatasetConfig.limit
        • DatasetConfig.reshape
        • DatasetConfig.shuffle
        • DatasetConfig.seed
        • DatasetConfig._abc_impl
        • DatasetConfig.ext_regex
        • DatasetConfig.label_axis
        • DatasetConfig.labels
        • DatasetConfig.limit
        • DatasetConfig.model_config
        • DatasetConfig.reshape
        • DatasetConfig.seed
        • DatasetConfig.shuffle
        • DatasetConfig.source
        • DatasetConfig.test_size
      • FrameworkConfig
        • FrameworkConfig._abc_impl
        • FrameworkConfig.device
        • FrameworkConfig.model_config
        • FrameworkConfig.name
      • LoggerConfig
        • LoggerConfig.slack_channel
        • LoggerConfig.slack_url
        • LoggerConfig.slack_methods
        • LoggerConfig.timezone
        • LoggerConfig.level
        • LoggerConfig._abc_impl
        • LoggerConfig._validate_slack_methods()
        • LoggerConfig.level
        • LoggerConfig.model_config
        • LoggerConfig.slack_channel
        • LoggerConfig.slack_methods
        • LoggerConfig.slack_url
        • LoggerConfig.timezone
      • LossConfig
        • LossConfig.name
        • LossConfig._abc_impl
        • LossConfig.model_config
        • LossConfig.name
      • OptimizerConfig
        • OptimizerConfig.name
        • OptimizerConfig._abc_impl
        • OptimizerConfig.model_config
        • OptimizerConfig.name
      • PipelineConfig
        • PipelineConfig.framework
        • PipelineConfig.dataset
        • PipelineConfig.optimizer
        • PipelineConfig.loss
        • PipelineConfig.metrics
        • PipelineConfig.compile
        • PipelineConfig.callbacks
        • PipelineConfig.logger
        • PipelineConfig.train
        • PipelineConfig._abc_impl
        • PipelineConfig._validate_metrics()
        • PipelineConfig.callbacks
        • PipelineConfig.dataset
        • PipelineConfig.framework
        • PipelineConfig.logger
        • PipelineConfig.loss
        • PipelineConfig.metrics
        • PipelineConfig.model_config
        • PipelineConfig.optimizer
        • PipelineConfig.train
      • TrainConfig
        • TrainConfig.batch_size
        • TrainConfig.epochs
        • TrainConfig.verbose
        • TrainConfig.validation_split
        • TrainConfig.seed
        • TrainConfig.shuffle
        • TrainConfig.initial_epoch
        • TrainConfig.validation_freq
        • TrainConfig._abc_impl
        • TrainConfig.batch_size
        • TrainConfig.epochs
        • TrainConfig.initial_epoch
        • TrainConfig.model_config
        • TrainConfig.seed
        • TrainConfig.shuffle
        • TrainConfig.validation_freq
        • TrainConfig.validation_split
        • TrainConfig.verbose
    • dataset
      • Dataset
        • Dataset.__getitem()
        • Dataset.__init__()
        • Dataset._get_stats()
        • Dataset._read_file()
        • Dataset._read_file_as_array()
        • Dataset._resolve_limit()
        • Dataset.asset_name
        • Dataset.asset_path
        • Dataset.filepaths
        • Dataset.get_arrays()
        • Dataset.get_filepath()
        • Dataset.info
        • Dataset.load()
        • Dataset.read_csv()
        • Dataset.read_directory()
        • Dataset.stats
        • Dataset.train_test_split()
        • Dataset.unload()
        • Dataset.xy_split()
    • logging
      • SlackLogger
        • SlackLogger.__init__()
    • multidataset
      • MultiDataset
        • MultiDataset.__init__()
        • MultiDataset.get_arrays()
        • MultiDataset.get_filepaths()
        • MultiDataset.info
        • MultiDataset.load()
        • MultiDataset.train_test_split()
        • MultiDataset.unload()
        • MultiDataset.xy_split()
    • pipeline
      • PipelineBase
        • PipelineBase.__init__()
        • PipelineBase._abc_impl
        • PipelineBase._engine
        • PipelineBase._logger()
        • PipelineBase.build()
        • PipelineBase.compile()
        • PipelineBase.from_string()
        • PipelineBase.generate_config()
        • PipelineBase.load()
        • PipelineBase.model_config()
        • PipelineBase.model_func()
        • PipelineBase.read_yaml()
        • PipelineBase.run()
        • PipelineBase.train()
        • PipelineBase.train_test_split()
        • PipelineBase.unload()
    • resolve
      • _generate_config()
      • _resolve_field()
      • _resolve_model()
      • _resolve_pipeline()
      • _resolve_subconfig()
      • resolve_config()
    • tools
      • enforce_callbacks()
      • enforce_getter()
      • get_module()
      • get_module_class()
      • get_module_function()
      • get_tensorboard_project()
      • is_custom_definition()
      • pad_layer_name()
      • resolve_kwargs()
      • resolve_module_config()
      • slack_it()
      • train_test_split()
      • unindent()
    • validators
      • is_base_two()
      • is_callback_mode()
      • is_engine()
      • is_even()
      • is_odd()
      • is_padding()
      • is_pipeline_method()
  • tf
    • models
      • dummy
        • DummyConfig
        • DummyPipeline
        • get_dummy_model()
      • unet
        • UNetConfig
        • UNetPipeline
        • attention_gate_2d()
        • conv_2d_block()
        • get_unet_model()
        • unet_width_and_layers_are_valid()
    • config
      • TFAxis
        • TFAxis._abc_impl
        • TFAxis.axis
        • TFAxis.model_config
      • TFBaseConfig
        • TFBaseConfig._abc_impl
        • TFBaseConfig.model_config
        • TFBaseConfig.name
      • TFBeta
        • TFBeta._abc_impl
        • TFBeta.beta_1
        • TFBeta.beta_2
        • TFBeta.model_config
      • TFClsId
        • TFClsId._abc_impl
        • TFClsId.class_id
        • TFClsId.model_config
      • TFEpsilon
        • TFEpsilon._abc_impl
        • TFEpsilon.epsilon
        • TFEpsilon.model_config
      • TFFramework
        • TFFramework.name
        • TFFramework.device
        • TFFramework.loss_weights
        • TFFramework.weighted_metrics
        • TFFramework.run_eagerly
        • TFFramework.steps_per_execution
        • TFFramework.jit_compile
        • TFFramework.auto_scale_loss
        • TFFramework._abc_impl
        • TFFramework.auto_scale_loss
        • TFFramework.device
        • TFFramework.jit_compile
        • TFFramework.loss_weights
        • TFFramework.model_config
        • TFFramework.name
        • TFFramework.run_eagerly
        • TFFramework.steps_per_execution
        • TFFramework.weighted_metrics
      • TFIgnoreClass
        • TFIgnoreClass._abc_impl
        • TFIgnoreClass.ignore_class
        • TFIgnoreClass.model_config
      • TFLogits
        • TFLogits._abc_impl
        • TFLogits.from_logits
        • TFLogits.model_config
      • TFLossBaseConfig
        • TFLossBaseConfig._abc_impl
        • TFLossBaseConfig.dtype
        • TFLossBaseConfig.model_config
        • TFLossBaseConfig.reduction
      • TFLossBinaryCrossentropy
        • TFLossBinaryCrossentropy._abc_impl
        • TFLossBinaryCrossentropy.label_smoothing
        • TFLossBinaryCrossentropy.model_config
      • TFLossBinaryFocalCrossentropy
        • TFLossBinaryFocalCrossentropy._abc_impl
        • TFLossBinaryFocalCrossentropy.alpha
        • TFLossBinaryFocalCrossentropy.apply_class_balancing
        • TFLossBinaryFocalCrossentropy.gamma
        • TFLossBinaryFocalCrossentropy.label_smoothing
        • TFLossBinaryFocalCrossentropy.model_config
      • TFLossCategoricalCrossentropy
        • TFLossCategoricalCrossentropy._abc_impl
        • TFLossCategoricalCrossentropy.label_smoothing
        • TFLossCategoricalCrossentropy.model_config
      • TFLossCategoricalFocalCrossentropy
        • TFLossCategoricalFocalCrossentropy._abc_impl
        • TFLossCategoricalFocalCrossentropy.alpha
        • TFLossCategoricalFocalCrossentropy.gamma
        • TFLossCategoricalFocalCrossentropy.label_smoothing
        • TFLossCategoricalFocalCrossentropy.model_config
      • TFLossCircle
        • TFLossCircle._abc_impl
        • TFLossCircle.gamma
        • TFLossCircle.margin
        • TFLossCircle.model_config
        • TFLossCircle.remove_diagonal
      • TFLossCosineSimilarity
        • TFLossCosineSimilarity._abc_impl
        • TFLossCosineSimilarity.model_config
      • TFLossDice
        • TFLossDice._abc_impl
        • TFLossDice.model_config
      • TFLossHuber
        • TFLossHuber._abc_impl
        • TFLossHuber.delta
        • TFLossHuber.model_config
      • TFLossSparseCategoricalCrossentropy
        • TFLossSparseCategoricalCrossentropy._abc_impl
        • TFLossSparseCategoricalCrossentropy.model_config
      • TFLossTversky
        • TFLossTversky._abc_impl
        • TFLossTversky.alpha
        • TFLossTversky.beta
        • TFLossTversky.model_config
      • TFMetricAUC
        • TFMetricAUC._abc_impl
        • TFMetricAUC.curve
        • TFMetricAUC.label_weights
        • TFMetricAUC.model_config
        • TFMetricAUC.multi_label
        • TFMetricAUC.num_labels
        • TFMetricAUC.summation_method
      • TFMetricAccuracy
        • TFMetricAccuracy._abc_impl
        • TFMetricAccuracy.model_config
      • TFMetricBaseConfig
        • TFMetricBaseConfig._abc_impl
        • TFMetricBaseConfig.dtype
        • TFMetricBaseConfig.model_config
      • TFMetricBinaryAccuracy
        • TFMetricBinaryAccuracy._abc_impl
        • TFMetricBinaryAccuracy.model_config
        • TFMetricBinaryAccuracy.threshold
      • TFMetricBinaryCrossentropy
        • TFMetricBinaryCrossentropy._abc_impl
        • TFMetricBinaryCrossentropy.label_smoothing
        • TFMetricBinaryCrossentropy.model_config
      • TFMetricBinaryIoU
        • TFMetricBinaryIoU._abc_impl
        • TFMetricBinaryIoU.model_config
        • TFMetricBinaryIoU.target_class_ids
        • TFMetricBinaryIoU.threshold
      • TFMetricCategoricalAccuracy
        • TFMetricCategoricalAccuracy._abc_impl
        • TFMetricCategoricalAccuracy.model_config
      • TFMetricCategoricalCrossentropy
        • TFMetricCategoricalCrossentropy._abc_impl
        • TFMetricCategoricalCrossentropy.label_smoothing
        • TFMetricCategoricalCrossentropy.model_config
      • TFMetricCategoricalHinge
        • TFMetricCategoricalHinge._abc_impl
        • TFMetricCategoricalHinge.model_config
      • TFMetricConcordanceCorrelation
        • TFMetricConcordanceCorrelation._abc_impl
        • TFMetricConcordanceCorrelation.model_config
      • TFMetricCosineSimilarity
        • TFMetricCosineSimilarity._abc_impl
        • TFMetricCosineSimilarity.model_config
      • TFMetricF1Score
        • TFMetricF1Score._abc_impl
        • TFMetricF1Score.average
        • TFMetricF1Score.model_config
        • TFMetricF1Score.threshold
      • TFMetricFBetaScore
        • TFMetricFBetaScore._abc_impl
        • TFMetricFBetaScore.average
        • TFMetricFBetaScore.beta
        • TFMetricFBetaScore.model_config
        • TFMetricFBetaScore.threshold
      • TFMetricFalseNegatives
        • TFMetricFalseNegatives._abc_impl
        • TFMetricFalseNegatives.model_config
      • TFMetricFalsePositives
        • TFMetricFalsePositives._abc_impl
        • TFMetricFalsePositives.model_config
      • TFMetricHinge
        • TFMetricHinge._abc_impl
        • TFMetricHinge.model_config
      • TFMetricIoU
        • TFMetricIoU._abc_impl
        • TFMetricIoU.model_config
        • TFMetricIoU.sparse_y_pred
        • TFMetricIoU.sparse_y_true
        • TFMetricIoU.target_class_ids
      • TFMetricKLDivergence
        • TFMetricKLDivergence._abc_impl
        • TFMetricKLDivergence.model_config
      • TFMetricLogCoshError
        • TFMetricLogCoshError._abc_impl
        • TFMetricLogCoshError.model_config
      • TFMetricMean
        • TFMetricMean._abc_impl
        • TFMetricMean.model_config
      • TFMetricMeanAbsoluteError
        • TFMetricMeanAbsoluteError._abc_impl
        • TFMetricMeanAbsoluteError.model_config
      • TFMetricMeanAbsolutePercentageError
        • TFMetricMeanAbsolutePercentageError._abc_impl
        • TFMetricMeanAbsolutePercentageError.model_config
      • TFMetricMeanIoU
        • TFMetricMeanIoU._abc_impl
        • TFMetricMeanIoU.model_config
        • TFMetricMeanIoU.sparse_y_pred
        • TFMetricMeanIoU.sparse_y_true
      • TFMetricMeanSquaredError
        • TFMetricMeanSquaredError._abc_impl
        • TFMetricMeanSquaredError.model_config
      • TFMetricMeanSquaredLogarithmicError
        • TFMetricMeanSquaredLogarithmicError._abc_impl
        • TFMetricMeanSquaredLogarithmicError.model_config
      • TFMetricMetric
        • TFMetricMetric._abc_impl
        • TFMetricMetric.model_config
      • TFMetricOneHotIoU
        • TFMetricOneHotIoU._abc_impl
        • TFMetricOneHotIoU.model_config
        • TFMetricOneHotIoU.sparse_y_pred
        • TFMetricOneHotIoU.target_class_ids
      • TFMetricOneHotMeanIoU
        • TFMetricOneHotMeanIoU._abc_impl
        • TFMetricOneHotMeanIoU.model_config
        • TFMetricOneHotMeanIoU.sparse_y_pred
      • TFMetricPearsonCorrelation
        • TFMetricPearsonCorrelation._abc_impl
        • TFMetricPearsonCorrelation.model_config
      • TFMetricPoisson
        • TFMetricPoisson._abc_impl
        • TFMetricPoisson.model_config
      • TFMetricPrecision
        • TFMetricPrecision._abc_impl
        • TFMetricPrecision.model_config
        • TFMetricPrecision.top_k
      • TFMetricPrecisionAtRecall
        • TFMetricPrecisionAtRecall._abc_impl
        • TFMetricPrecisionAtRecall.model_config
        • TFMetricPrecisionAtRecall.recall
      • TFMetricR2Score
        • TFMetricR2Score._abc_impl
        • TFMetricR2Score.class_aggregation
        • TFMetricR2Score.model_config
        • TFMetricR2Score.num_regressors
      • TFMetricRecall
        • TFMetricRecall._abc_impl
        • TFMetricRecall.model_config
        • TFMetricRecall.top_k
      • TFMetricRecallAtPrecision
        • TFMetricRecallAtPrecision._abc_impl
        • TFMetricRecallAtPrecision.model_config
        • TFMetricRecallAtPrecision.precision
      • TFMetricRootMeanSquaredError
        • TFMetricRootMeanSquaredError._abc_impl
        • TFMetricRootMeanSquaredError.model_config
      • TFMetricSensitivityAtSpecificity
        • TFMetricSensitivityAtSpecificity._abc_impl
        • TFMetricSensitivityAtSpecificity.model_config
        • TFMetricSensitivityAtSpecificity.specificity
      • TFMetricSparseCategoricalAccuracy
        • TFMetricSparseCategoricalAccuracy._abc_impl
        • TFMetricSparseCategoricalAccuracy.model_config
      • TFMetricSparseCategoricalCrossentropy
        • TFMetricSparseCategoricalCrossentropy._abc_impl
        • TFMetricSparseCategoricalCrossentropy.model_config
      • TFMetricSparseTopKCategoricalAccuracy
        • TFMetricSparseTopKCategoricalAccuracy._abc_impl
        • TFMetricSparseTopKCategoricalAccuracy.from_sorted_ids
        • TFMetricSparseTopKCategoricalAccuracy.k
        • TFMetricSparseTopKCategoricalAccuracy.model_config
      • TFMetricSpecificityAtSensitivity
        • TFMetricSpecificityAtSensitivity._abc_impl
        • TFMetricSpecificityAtSensitivity.model_config
        • TFMetricSpecificityAtSensitivity.sensitivity
      • TFMetricSquaredHinge
        • TFMetricSquaredHinge._abc_impl
        • TFMetricSquaredHinge.model_config
      • TFMetricSum
        • TFMetricSum._abc_impl
        • TFMetricSum.model_config
      • TFMetricTopKCategoricalAccuracy
        • TFMetricTopKCategoricalAccuracy._abc_impl
        • TFMetricTopKCategoricalAccuracy.k
        • TFMetricTopKCategoricalAccuracy.model_config
      • TFMetricTrueNegatives
        • TFMetricTrueNegatives._abc_impl
        • TFMetricTrueNegatives.model_config
      • TFMetricTruePositives
        • TFMetricTruePositives._abc_impl
        • TFMetricTruePositives.model_config
      • TFNumClasses
        • TFNumClasses._abc_impl
        • TFNumClasses.model_config
        • TFNumClasses.num_classes
      • TFNumThresh
        • TFNumThresh._abc_impl
        • TFNumThresh.model_config
        • TFNumThresh.num_thresholds
      • TFOptAdadelta
        • TFOptAdadelta._abc_impl
        • TFOptAdadelta.model_config
        • TFOptAdadelta.rho
      • TFOptAdafactor
        • TFOptAdafactor._abc_impl
        • TFOptAdafactor.beta_2_decay
        • TFOptAdafactor.clip_threshold
        • TFOptAdafactor.epsilon_1
        • TFOptAdafactor.epsilon_2
        • TFOptAdafactor.model_config
        • TFOptAdafactor.relative_step
      • TFOptAdagrad
        • TFOptAdagrad._abc_impl
        • TFOptAdagrad.initial_accumulator_value
        • TFOptAdagrad.model_config
      • TFOptAdam
        • TFOptAdam._abc_impl
        • TFOptAdam.amsgrad
        • TFOptAdam.model_config
      • TFOptAdamW
        • TFOptAdamW._abc_impl
        • TFOptAdamW.amsgrad
        • TFOptAdamW.model_config
        • TFOptAdamW.weight_decay
      • TFOptAdamax
        • TFOptAdamax._abc_impl
        • TFOptAdamax.model_config
      • TFOptBaseConfig
        • TFOptBaseConfig._abc_impl
        • TFOptBaseConfig.clipnorm
        • TFOptBaseConfig.clipvalue
        • TFOptBaseConfig.ema_momentum
        • TFOptBaseConfig.ema_overwrite_frequency
        • TFOptBaseConfig.global_clipnorm
        • TFOptBaseConfig.gradient_accumulation_steps
        • TFOptBaseConfig.learning_rate
        • TFOptBaseConfig.loss_scale_factor
        • TFOptBaseConfig.model_config
        • TFOptBaseConfig.use_ema
      • TFOptFtrl
        • TFOptFtrl._abc_impl
        • TFOptFtrl.beta
        • TFOptFtrl.initial_accumulator_value
        • TFOptFtrl.l1_regularization_strength
        • TFOptFtrl.l2_regularization_strength
        • TFOptFtrl.l2_shrinkage_regularization_strength
        • TFOptFtrl.learning_rate_power
        • TFOptFtrl.model_config
      • TFOptLamb
        • TFOptLamb._abc_impl
        • TFOptLamb.model_config
      • TFOptLion
        • TFOptLion._abc_impl
        • TFOptLion.model_config
      • TFOptNadam
        • TFOptNadam._abc_impl
        • TFOptNadam.model_config
      • TFOptRMSprop
        • TFOptRMSprop._abc_impl
        • TFOptRMSprop.centered
        • TFOptRMSprop.model_config
        • TFOptRMSprop.momentum
        • TFOptRMSprop.rho
      • TFOptSGD
        • TFOptSGD._abc_impl
        • TFOptSGD.model_config
        • TFOptSGD.momentum
        • TFOptSGD.nesterov
      • TFThresh
        • TFThresh._abc_impl
        • TFThresh.model_config
        • TFThresh.thresholds
    • loss
      • dice_loss()
      • get()
      • jaccard_loss()
    • metric
      • dice()
      • get()
      • intersection_over_union()
      • jaccard()
    • optimizer
      • get()
    • tools
      • compile()
      • get()
      • get_callbacks()
      • pre_build()
      • train()
  • torch
    • models
      • dummy
        • DummyConfig
        • DummyModel
        • DummyPipeline
        • get_dummy_model()
      • unet
        • AtttentionGate2DBlock
        • Conv2DBlock
        • UNet
        • UNetConfig
        • UNetPipeline
        • get_unet_model()
    • config
      • TAct
        • TAct._abc_impl
        • TAct.empty_target_action
        • TAct.model_config
      • TBeta
        • TBeta._abc_impl
        • TBeta.beta_1
        • TBeta.beta_2
        • TBeta.model_config
      • TCap
        • TCap._abc_impl
        • TCap.capturable
        • TCap.model_config
      • TCls
        • TCls._abc_impl
        • TCls.model_config
        • TCls.num_classes
      • TDate
        • TDate._abc_impl
        • TDate.data_range
        • TDate.model_config
      • TDecay
        • TDecay._abc_impl
        • TDecay.model_config
        • TDecay.weight_decay
      • TDiff
        • TDiff._abc_impl
        • TDiff.differentiable
        • TDiff.model_config
      • TEps
        • TEps._abc_impl
        • TEps.epsilon
        • TEps.model_config
      • TFor
        • TFor._abc_impl
        • TFor.foreach
        • TFor.model_config
      • TGroup1
        • TGroup1._abc_impl
        • TGroup1.model_config
      • TGroup2
        • TGroup2._abc_impl
        • TGroup2.model_config
      • TGroup3
        • TGroup3._abc_impl
        • TGroup3.model_config
      • TInd
        • TInd._abc_impl
        • TInd.ignore_index
        • TInd.model_config
      • TMReduct
        • TMReduct._abc_impl
        • TMReduct.model_config
        • TMReduct.reduction
      • TMarg
        • TMarg._abc_impl
        • TMarg.margin
        • TMarg.model_config
      • TMax
        • TMax._abc_impl
        • TMax.maximize
        • TMax.model_config
      • TNan
        • TNan._abc_impl
        • TNan.model_config
        • TNan.nan_strategy
      • TNanStrategy
        • TNanStrategy._abc_impl
        • TNanStrategy.model_config
        • TNanStrategy.nan_strategy
      • TOut
        • TOut._abc_impl
        • TOut.model_config
        • TOut.num_outputs
      • TRed
        • TRed._abc_impl
        • TRed.model_config
        • TRed.reduce
      • TReduct
        • TReduct._abc_impl
        • TReduct.model_config
        • TReduct.reduction
      • TSize
        • TSize._abc_impl
        • TSize.model_config
        • TSize.size_average
      • TTopK
        • TTopK._abc_impl
        • TTopK.model_config
        • TTopK.top_k
      • TorchBaseConfig
        • TorchBaseConfig._abc_impl
        • TorchBaseConfig.model_config
        • TorchBaseConfig.name
      • TorchFramework
        • TorchFramework.name
        • TorchFramework.device
        • TorchFramework._abc_impl
        • TorchFramework.device
        • TorchFramework.model_config
        • TorchFramework.name
      • TorchLossBCELoss
        • TorchLossBCELoss._abc_impl
        • TorchLossBCELoss.model_config
      • TorchLossBCEWithLogitsLoss
        • TorchLossBCEWithLogitsLoss._abc_impl
        • TorchLossBCEWithLogitsLoss.model_config
      • TorchLossCTCLoss
        • TorchLossCTCLoss._abc_impl
        • TorchLossCTCLoss.blank
        • TorchLossCTCLoss.model_config
        • TorchLossCTCLoss.zero_infinity
      • TorchLossCosineEmbeddingLoss
        • TorchLossCosineEmbeddingLoss._abc_impl
        • TorchLossCosineEmbeddingLoss.model_config
      • TorchLossCrossEntropyLoss
        • TorchLossCrossEntropyLoss._abc_impl
        • TorchLossCrossEntropyLoss.ignore_index
        • TorchLossCrossEntropyLoss.label_smoothing
        • TorchLossCrossEntropyLoss.model_config
      • TorchLossGaussianNLLLoss
        • TorchLossGaussianNLLLoss._abc_impl
        • TorchLossGaussianNLLLoss.full
        • TorchLossGaussianNLLLoss.model_config
      • TorchLossHingeEmbeddingLoss
        • TorchLossHingeEmbeddingLoss._abc_impl
        • TorchLossHingeEmbeddingLoss.model_config
      • TorchLossHuberLoss
        • TorchLossHuberLoss._abc_impl
        • TorchLossHuberLoss.delta
        • TorchLossHuberLoss.model_config
      • TorchLossKLDivLoss
        • TorchLossKLDivLoss._abc_impl
        • TorchLossKLDivLoss.log_target
        • TorchLossKLDivLoss.model_config
      • TorchLossL1Loss
        • TorchLossL1Loss._abc_impl
        • TorchLossL1Loss.model_config
      • TorchLossMSELoss
        • TorchLossMSELoss._abc_impl
        • TorchLossMSELoss.model_config
      • TorchLossMarginRankingLoss
        • TorchLossMarginRankingLoss._abc_impl
        • TorchLossMarginRankingLoss.model_config
      • TorchLossMultiLabelMarginLoss
        • TorchLossMultiLabelMarginLoss._abc_impl
        • TorchLossMultiLabelMarginLoss.model_config
      • TorchLossMultiLabelSoftMarginLoss
        • TorchLossMultiLabelSoftMarginLoss._abc_impl
        • TorchLossMultiLabelSoftMarginLoss.model_config
      • TorchLossMultiMarginLoss
        • TorchLossMultiMarginLoss._abc_impl
        • TorchLossMultiMarginLoss.exponent
        • TorchLossMultiMarginLoss.model_config
      • TorchLossNLLLoss
        • TorchLossNLLLoss._abc_impl
        • TorchLossNLLLoss.ignore_index
        • TorchLossNLLLoss.model_config
      • TorchLossPairwiseDistance
        • TorchLossPairwiseDistance._abc_impl
        • TorchLossPairwiseDistance.keepdim
        • TorchLossPairwiseDistance.model_config
        • TorchLossPairwiseDistance.norm_degree
      • TorchLossPoissonNLLLoss
        • TorchLossPoissonNLLLoss._abc_impl
        • TorchLossPoissonNLLLoss.full
        • TorchLossPoissonNLLLoss.log_input
        • TorchLossPoissonNLLLoss.model_config
      • TorchLossSmoothL1Loss
        • TorchLossSmoothL1Loss._abc_impl
        • TorchLossSmoothL1Loss.beta
        • TorchLossSmoothL1Loss.model_config
      • TorchLossSoftMarginLoss
        • TorchLossSoftMarginLoss._abc_impl
        • TorchLossSoftMarginLoss.model_config
      • TorchLossTripletMarginLoss
        • TorchLossTripletMarginLoss._abc_impl
        • TorchLossTripletMarginLoss.model_config
        • TorchLossTripletMarginLoss.norm_degree
        • TorchLossTripletMarginLoss.swap
      • TorchLossTripletMarginWithDistanceLoss
        • TorchLossTripletMarginWithDistanceLoss._abc_impl
        • TorchLossTripletMarginWithDistanceLoss.model_config
        • TorchLossTripletMarginWithDistanceLoss.swap
      • TorchMetricBLEUScore
        • TorchMetricBLEUScore._abc_impl
        • TorchMetricBLEUScore.model_config
        • TorchMetricBLEUScore.n_gram
        • TorchMetricBLEUScore.smooth
        • TorchMetricBLEUScore.weights
      • TorchMetricCHRFScore
        • TorchMetricCHRFScore._abc_impl
        • TorchMetricCHRFScore.beta
        • TorchMetricCHRFScore.lowercase
        • TorchMetricCHRFScore.model_config
        • TorchMetricCHRFScore.n_char_order
        • TorchMetricCHRFScore.n_word_order
        • TorchMetricCHRFScore.return_sentence_level_score
        • TorchMetricCHRFScore.whitespace
      • TorchMetricCatMetric
        • TorchMetricCatMetric._abc_impl
        • TorchMetricCatMetric.model_config
      • TorchMetricConcordanceCorrCoef
        • TorchMetricConcordanceCorrCoef._abc_impl
        • TorchMetricConcordanceCorrCoef.model_config
      • TorchMetricCosineSimilarity
        • TorchMetricCosineSimilarity._abc_impl
        • TorchMetricCosineSimilarity.model_config
        • TorchMetricCosineSimilarity.reduction
      • TorchMetricCramersV
        • TorchMetricCramersV._abc_impl
        • TorchMetricCramersV.bias_correction
        • TorchMetricCramersV.model_config
        • TorchMetricCramersV.nan_replace_value
      • TorchMetricCriticalSuccessIndex
        • TorchMetricCriticalSuccessIndex._abc_impl
        • TorchMetricCriticalSuccessIndex.keep_sequence_dim
        • TorchMetricCriticalSuccessIndex.model_config
        • TorchMetricCriticalSuccessIndex.threshold
      • TorchMetricDice
        • TorchMetricDice._abc_impl
        • TorchMetricDice.average
        • TorchMetricDice.mdmc_average
        • TorchMetricDice.model_config
        • TorchMetricDice.multiclass
        • TorchMetricDice.threshold
        • TorchMetricDice.zero_division
      • TorchMetricErrorRelativeGlobalDimensionlessSynthesis
        • TorchMetricErrorRelativeGlobalDimensionlessSynthesis._abc_impl
        • TorchMetricErrorRelativeGlobalDimensionlessSynthesis.model_config
        • TorchMetricErrorRelativeGlobalDimensionlessSynthesis.ratio
      • TorchMetricExplainedVariance
        • TorchMetricExplainedVariance._abc_impl
        • TorchMetricExplainedVariance.model_config
        • TorchMetricExplainedVariance.multioutput
      • TorchMetricExtendedEditDistance
        • TorchMetricExtendedEditDistance._abc_impl
        • TorchMetricExtendedEditDistance.alpha
        • TorchMetricExtendedEditDistance.deletion
        • TorchMetricExtendedEditDistance.insertion
        • TorchMetricExtendedEditDistance.language
        • TorchMetricExtendedEditDistance.model_config
        • TorchMetricExtendedEditDistance.return_sentence_level_score
        • TorchMetricExtendedEditDistance.rho
      • TorchMetricFleissKappa
        • TorchMetricFleissKappa._abc_impl
        • TorchMetricFleissKappa.mode
        • TorchMetricFleissKappa.model_config
      • TorchMetricKLDivergence
        • TorchMetricKLDivergence._abc_impl
        • TorchMetricKLDivergence.log_prob
        • TorchMetricKLDivergence.model_config
        • TorchMetricKLDivergence.reduction
      • TorchMetricKendallRankCorrCoef
        • TorchMetricKendallRankCorrCoef._abc_impl
        • TorchMetricKendallRankCorrCoef.alternative
        • TorchMetricKendallRankCorrCoef.model_config
        • TorchMetricKendallRankCorrCoef.t_test
        • TorchMetricKendallRankCorrCoef.variant
      • TorchMetricLogCoshError
        • TorchMetricLogCoshError._abc_impl
        • TorchMetricLogCoshError.model_config
      • TorchMetricMaxMetric
        • TorchMetricMaxMetric._abc_impl
        • TorchMetricMaxMetric.model_config
      • TorchMetricMeanAbsoluteError
        • TorchMetricMeanAbsoluteError._abc_impl
        • TorchMetricMeanAbsoluteError.model_config
      • TorchMetricMeanMetric
        • TorchMetricMeanMetric._abc_impl
        • TorchMetricMeanMetric.model_config
      • TorchMetricMeanSquaredError
        • TorchMetricMeanSquaredError._abc_impl
        • TorchMetricMeanSquaredError.model_config
        • TorchMetricMeanSquaredError.squared
      • TorchMetricMinMetric
        • TorchMetricMinMetric._abc_impl
        • TorchMetricMinMetric.model_config
      • TorchMetricMinkowskiDistance
        • TorchMetricMinkowskiDistance._abc_impl
        • TorchMetricMinkowskiDistance.model_config
        • TorchMetricMinkowskiDistance.p
      • TorchMetricModifiedPanopticQuality
        • TorchMetricModifiedPanopticQuality._abc_impl
        • TorchMetricModifiedPanopticQuality.allow_unknown_preds_category
        • TorchMetricModifiedPanopticQuality.model_config
        • TorchMetricModifiedPanopticQuality.stuffs
        • TorchMetricModifiedPanopticQuality.things
      • TorchMetricMultiScaleStructuralSimilarityIndexMeasure
        • TorchMetricMultiScaleStructuralSimilarityIndexMeasure._abc_impl
        • TorchMetricMultiScaleStructuralSimilarityIndexMeasure.betas
        • TorchMetricMultiScaleStructuralSimilarityIndexMeasure.gaussian_kernel
        • TorchMetricMultiScaleStructuralSimilarityIndexMeasure.k1
        • TorchMetricMultiScaleStructuralSimilarityIndexMeasure.k2
        • TorchMetricMultiScaleStructuralSimilarityIndexMeasure.kernel_size
        • TorchMetricMultiScaleStructuralSimilarityIndexMeasure.model_config
        • TorchMetricMultiScaleStructuralSimilarityIndexMeasure.normalize
        • TorchMetricMultiScaleStructuralSimilarityIndexMeasure.sigma
      • TorchMetricNormalizedRootMeanSquaredError
        • TorchMetricNormalizedRootMeanSquaredError._abc_impl
        • TorchMetricNormalizedRootMeanSquaredError.model_config
        • TorchMetricNormalizedRootMeanSquaredError.normalization
      • TorchMetricPanopticQuality
        • TorchMetricPanopticQuality._abc_impl
        • TorchMetricPanopticQuality.allow_unknown_preds_category
        • TorchMetricPanopticQuality.model_config
        • TorchMetricPanopticQuality.stuffs
        • TorchMetricPanopticQuality.things
      • TorchMetricPeakSignalNoiseRatio
        • TorchMetricPeakSignalNoiseRatio._abc_impl
        • TorchMetricPeakSignalNoiseRatio.base
        • TorchMetricPeakSignalNoiseRatio.dim
        • TorchMetricPeakSignalNoiseRatio.model_config
      • TorchMetricPearsonCorrCoef
        • TorchMetricPearsonCorrCoef._abc_impl
        • TorchMetricPearsonCorrCoef.model_config
      • TorchMetricPearsonsContingencyCoefficient
        • TorchMetricPearsonsContingencyCoefficient._abc_impl
        • TorchMetricPearsonsContingencyCoefficient.model_config
        • TorchMetricPearsonsContingencyCoefficient.nan_replace_value
        • TorchMetricPearsonsContingencyCoefficient.num_classes
      • TorchMetricPermutationInvariantTraining
        • TorchMetricPermutationInvariantTraining._abc_impl
        • TorchMetricPermutationInvariantTraining.eval_func
        • TorchMetricPermutationInvariantTraining.mode
        • TorchMetricPermutationInvariantTraining.model_config
      • TorchMetricPerplexity
        • TorchMetricPerplexity._abc_impl
        • TorchMetricPerplexity.model_config
      • TorchMetricR2Score
        • TorchMetricR2Score._abc_impl
        • TorchMetricR2Score.adjusted
        • TorchMetricR2Score.model_config
        • TorchMetricR2Score.multioutput
      • TorchMetricRelativeAverageSpectralError
        • TorchMetricRelativeAverageSpectralError._abc_impl
        • TorchMetricRelativeAverageSpectralError.model_config
        • TorchMetricRelativeAverageSpectralError.window_size
      • TorchMetricRelativeSquaredError
        • TorchMetricRelativeSquaredError._abc_impl
        • TorchMetricRelativeSquaredError.model_config
        • TorchMetricRelativeSquaredError.squared
      • TorchMetricRetrievalFallOut
        • TorchMetricRetrievalFallOut._abc_impl
        • TorchMetricRetrievalFallOut.empty_target_action
        • TorchMetricRetrievalFallOut.model_config
      • TorchMetricRetrievalHitRate
        • TorchMetricRetrievalHitRate._abc_impl
        • TorchMetricRetrievalHitRate.model_config
      • TorchMetricRetrievalMAP
        • TorchMetricRetrievalMAP._abc_impl
        • TorchMetricRetrievalMAP.model_config
      • TorchMetricRetrievalMRR
        • TorchMetricRetrievalMRR._abc_impl
        • TorchMetricRetrievalMRR.model_config
      • TorchMetricRetrievalNormalizedDCG
        • TorchMetricRetrievalNormalizedDCG._abc_impl
        • TorchMetricRetrievalNormalizedDCG.model_config
      • TorchMetricRetrievalPrecision
        • TorchMetricRetrievalPrecision._abc_impl
        • TorchMetricRetrievalPrecision.adaptive_k
        • TorchMetricRetrievalPrecision.model_config
      • TorchMetricRetrievalPrecisionRecallCurve
        • TorchMetricRetrievalPrecisionRecallCurve._abc_impl
        • TorchMetricRetrievalPrecisionRecallCurve.adaptive_k
        • TorchMetricRetrievalPrecisionRecallCurve.max_k
        • TorchMetricRetrievalPrecisionRecallCurve.model_config
      • TorchMetricRetrievalRPrecision
        • TorchMetricRetrievalRPrecision._abc_impl
        • TorchMetricRetrievalRPrecision.model_config
      • TorchMetricRetrievalRecall
        • TorchMetricRetrievalRecall._abc_impl
        • TorchMetricRetrievalRecall.model_config
      • TorchMetricRetrievalRecallAtFixedPrecision
        • TorchMetricRetrievalRecallAtFixedPrecision._abc_impl
        • TorchMetricRetrievalRecallAtFixedPrecision.adaptive_k
        • TorchMetricRetrievalRecallAtFixedPrecision.max_k
        • TorchMetricRetrievalRecallAtFixedPrecision.min_precision
        • TorchMetricRetrievalRecallAtFixedPrecision.model_config
      • TorchMetricRootMeanSquaredErrorUsingSlidingWindow
        • TorchMetricRootMeanSquaredErrorUsingSlidingWindow._abc_impl
        • TorchMetricRootMeanSquaredErrorUsingSlidingWindow.model_config
        • TorchMetricRootMeanSquaredErrorUsingSlidingWindow.window_size
      • TorchMetricRunningMean
        • TorchMetricRunningMean._abc_impl
        • TorchMetricRunningMean.model_config
        • TorchMetricRunningMean.window
      • TorchMetricRunningSum
        • TorchMetricRunningSum._abc_impl
        • TorchMetricRunningSum.model_config
        • TorchMetricRunningSum.window
      • TorchMetricSacreBLEUScore
        • TorchMetricSacreBLEUScore._abc_impl
        • TorchMetricSacreBLEUScore.lowercase
        • TorchMetricSacreBLEUScore.model_config
        • TorchMetricSacreBLEUScore.n_gram
        • TorchMetricSacreBLEUScore.smooth
        • TorchMetricSacreBLEUScore.tokenize
        • TorchMetricSacreBLEUScore.weights
      • TorchMetricScaleInvariantSignalDistortionRatio
        • TorchMetricScaleInvariantSignalDistortionRatio._abc_impl
        • TorchMetricScaleInvariantSignalDistortionRatio.model_config
        • TorchMetricScaleInvariantSignalDistortionRatio.zero_mean
      • TorchMetricSignalDistortionRatio
        • TorchMetricSignalDistortionRatio._abc_impl
        • TorchMetricSignalDistortionRatio.filter_length
        • TorchMetricSignalDistortionRatio.load_diag
        • TorchMetricSignalDistortionRatio.model_config
        • TorchMetricSignalDistortionRatio.use_cg_iter
        • TorchMetricSignalDistortionRatio.zero_mean
      • TorchMetricSignalNoiseRatio
        • TorchMetricSignalNoiseRatio._abc_impl
        • TorchMetricSignalNoiseRatio.model_config
        • TorchMetricSignalNoiseRatio.zero_mean
      • TorchMetricSpearmanCorrCoef
        • TorchMetricSpearmanCorrCoef._abc_impl
        • TorchMetricSpearmanCorrCoef.model_config
      • TorchMetricSpectralAngleMapper
        • TorchMetricSpectralAngleMapper._abc_impl
        • TorchMetricSpectralAngleMapper.model_config
      • TorchMetricSpectralDistortionIndex
        • TorchMetricSpectralDistortionIndex._abc_impl
        • TorchMetricSpectralDistortionIndex.model_config
        • TorchMetricSpectralDistortionIndex.p
      • TorchMetricStructuralSimilarityIndexMeasure
        • TorchMetricStructuralSimilarityIndexMeasure._abc_impl
        • TorchMetricStructuralSimilarityIndexMeasure.data_range
        • TorchMetricStructuralSimilarityIndexMeasure.gaussian_kernel
        • TorchMetricStructuralSimilarityIndexMeasure.k1
        • TorchMetricStructuralSimilarityIndexMeasure.k2
        • TorchMetricStructuralSimilarityIndexMeasure.kernel_size
        • TorchMetricStructuralSimilarityIndexMeasure.model_config
        • TorchMetricStructuralSimilarityIndexMeasure.return_contrast_sensitivity
        • TorchMetricStructuralSimilarityIndexMeasure.return_full_image
        • TorchMetricStructuralSimilarityIndexMeasure.sigma
      • TorchMetricSumMetric
        • TorchMetricSumMetric._abc_impl
        • TorchMetricSumMetric.model_config
      • TorchMetricTheilsU
        • TorchMetricTheilsU._abc_impl
        • TorchMetricTheilsU.model_config
        • TorchMetricTheilsU.nan_replace_value
        • TorchMetricTheilsU.num_classes
      • TorchMetricTotalVariation
        • TorchMetricTotalVariation._abc_impl
        • TorchMetricTotalVariation.model_config
        • TorchMetricTotalVariation.reduction
      • TorchMetricTranslationEditRate
        • TorchMetricTranslationEditRate._abc_impl
        • TorchMetricTranslationEditRate.asian_support
        • TorchMetricTranslationEditRate.lowercase
        • TorchMetricTranslationEditRate.model_config
        • TorchMetricTranslationEditRate.no_punctuation
        • TorchMetricTranslationEditRate.normalize
        • TorchMetricTranslationEditRate.return_sentence_level_score
      • TorchMetricTschuprowsT
        • TorchMetricTschuprowsT._abc_impl
        • TorchMetricTschuprowsT.bias_correction
        • TorchMetricTschuprowsT.model_config
        • TorchMetricTschuprowsT.nan_replace_value
        • TorchMetricTschuprowsT.num_classes
      • TorchMetricTweedieDevianceScore
        • TorchMetricTweedieDevianceScore._abc_impl
        • TorchMetricTweedieDevianceScore.model_config
        • TorchMetricTweedieDevianceScore.power
      • TorchMetricUniversalImageQualityIndex
        • TorchMetricUniversalImageQualityIndex._abc_impl
        • TorchMetricUniversalImageQualityIndex.kernel_size
        • TorchMetricUniversalImageQualityIndex.model_config
        • TorchMetricUniversalImageQualityIndex.sigma
      • TorchOptASGD
        • TorchOptASGD._abc_impl
        • TorchOptASGD.alpha
        • TorchOptASGD.lambd
        • TorchOptASGD.model_config
        • TorchOptASGD.t0
      • TorchOptAdadelta
        • TorchOptAdadelta._abc_impl
        • TorchOptAdadelta.model_config
        • TorchOptAdadelta.rho
      • TorchOptAdafactor
        • TorchOptAdafactor._abc_impl
        • TorchOptAdafactor.beta2_decay
        • TorchOptAdafactor.clipping_threshold
        • TorchOptAdafactor.model_config
      • TorchOptAdagrad
        • TorchOptAdagrad._abc_impl
        • TorchOptAdagrad.fused
        • TorchOptAdagrad.initial_accumulator_value
        • TorchOptAdagrad.lr_decay
        • TorchOptAdagrad.model_config
      • TorchOptAdam
        • TorchOptAdam._abc_impl
        • TorchOptAdam.amsgrad
        • TorchOptAdam.fused
        • TorchOptAdam.model_config
      • TorchOptAdamW
        • TorchOptAdamW._abc_impl
        • TorchOptAdamW.amsgrad
        • TorchOptAdamW.fused
        • TorchOptAdamW.model_config
      • TorchOptAdamax
        • TorchOptAdamax._abc_impl
        • TorchOptAdamax.model_config
      • TorchOptBaseConfig
        • TorchOptBaseConfig._abc_impl
        • TorchOptBaseConfig.learning_rate
        • TorchOptBaseConfig.model_config
      • TorchOptLBFGS
        • TorchOptLBFGS._abc_impl
        • TorchOptLBFGS.history_size
        • TorchOptLBFGS.line_search_fn
        • TorchOptLBFGS.max_eval
        • TorchOptLBFGS.max_iter
        • TorchOptLBFGS.model_config
        • TorchOptLBFGS.tolerance_change
        • TorchOptLBFGS.tolerance_grad
      • TorchOptNAdam
        • TorchOptNAdam._abc_impl
        • TorchOptNAdam.model_config
        • TorchOptNAdam.momentum_decay
      • TorchOptRAdam
        • TorchOptRAdam._abc_impl
        • TorchOptRAdam.model_config
      • TorchOptRMSprop
        • TorchOptRMSprop._abc_impl
        • TorchOptRMSprop.alpha
        • TorchOptRMSprop.centered
        • TorchOptRMSprop.model_config
        • TorchOptRMSprop.momentum
      • TorchOptRprop
        • TorchOptRprop._abc_impl
        • TorchOptRprop.etas
        • TorchOptRprop.model_config
        • TorchOptRprop.step_sizes
      • TorchOptSGD
        • TorchOptSGD._abc_impl
        • TorchOptSGD.dampening
        • TorchOptSGD.fused
        • TorchOptSGD.model_config
        • TorchOptSGD.momentum
        • TorchOptSGD.nesterov
      • TorchOptSparseAdam
        • TorchOptSparseAdam._abc_impl
        • TorchOptSparseAdam.model_config
    • loss
      • get()
    • metric
      • get()
    • optimizer
      • get()
    • tools
      • ModelCheckpoint
        • ModelCheckpoint.__init__()
        • ModelCheckpoint.save()
      • TorchDataset
        • TorchDataset.monkey_patch()
      • _execute_epoch()
      • compile()
      • get()
      • get_callbacks()
      • pre_build()
      • resolve_config()
      • train()
Previous Next

© Copyright 2025, Alex Braun <alexander.g.braun@gmail.com>.

Built with Sphinx using a theme provided by Read the Docs.