Runnable Example Commands

Command-line records used by TorchLean's runnable model examples.

These declarations live under example support because they describe repository commands and local artifact formats, not the tensor, trainer, or runtime API. Applications can use the public trainer directly without importing diffusion schedules, PPM paths, or prepared-dataset defaults.

Generative-model artifacts

structure NN.Examples.Support.DiffusionScheduleFlags : Type

Diffusion schedule parameters exposed by the runnable diffusion example.

• T : ℕ

  Number of diffusion timesteps in the schedule.

• betaStart : Float

  First beta value in the schedule.

• betaEnd : Float

  Final beta value in the schedule.

def NN.Examples.Support.instReprDiffusionScheduleFlags.repr : DiffusionScheduleFlags → ℕ → Std.Format

@[instance_reducible]

instance NN.Examples.Support.instReprDiffusionScheduleFlags : Repr DiffusionScheduleFlags

def NN.Examples.Support.DiffusionScheduleFlags.parse (args : List String) (defaultT : ℕ := 100) (defaultBetaStart : Float := 1e-4) (defaultBetaEnd : Float := 0.12) : Except String (DiffusionScheduleFlags × List String)

Parse --T, --beta-start, and --beta-end.

def NN.Examples.Support.DiffusionScheduleFlags.trainLogNotes (config : DiffusionScheduleFlags) : Array String

Stable TrainLog metadata for a diffusion schedule.

structure NN.Examples.Support.ImageArtifactFlags : Type

Optional image artifacts emitted by generation and reconstruction examples.

• reconstructStep? : Option ℕ

  Optional timestep used for reconstruction-from-noise artifacts.

• samplePpm? : Option System.FilePath

  Optional path for an unconditional sample image.

• referencePpm? : Option System.FilePath

  Optional path for the clean reference image.

• noisyPpm? : Option System.FilePath

  Optional path for the noised or intermediate image.

• reconstructPpm? : Option System.FilePath

  Optional path for the reconstructed image.

def NN.Examples.Support.instReprImageArtifactFlags.repr : ImageArtifactFlags → ℕ → Std.Format

@[instance_reducible]

instance NN.Examples.Support.instReprImageArtifactFlags : Repr ImageArtifactFlags

def NN.Examples.Support.ImageArtifactFlags.parse (args : List String) : Except String (ImageArtifactFlags × List String)

Parse image-artifact paths and the optional reconstruction timestep.

def NN.Examples.Support.ImageArtifactFlags.trainLogNotes (config : ImageArtifactFlags) : Array String

Stable TrainLog metadata for requested image artifacts.

Prepared-data and diagnostic artifacts

structure NN.Examples.Support.PairedNpyEvalFlags : Type

Train/test tensor paths and row counts for paired-NPY scientific examples.

• trainRows : ℕ

  Number of rows loaded from the prepared training tensors.

• testRows : ℕ

  Number of rows loaded from the prepared held-out tensors.

• evalRows : ℕ

  Prefix length used for deterministic train/test loss reports.

• trainX : System.FilePath

  Training input .npy path.

• trainY : System.FilePath

  Training target .npy path.

• testX : System.FilePath

  Held-out input .npy path.

• testY : System.FilePath

  Held-out target .npy path.

def NN.Examples.Support.instReprPairedNpyEvalFlags.repr : PairedNpyEvalFlags → ℕ → Std.Format

@[instance_reducible]

instance NN.Examples.Support.instReprPairedNpyEvalFlags : Repr PairedNpyEvalFlags

def NN.Examples.Support.PairedNpyEvalFlags.parse (exeName : String) (args : List String) (defaultTrainX defaultTrainY defaultTestX defaultTestY : System.FilePath) (defaultTrainRows defaultTestRows : ℕ) (defaultEvalRows : ℕ := 16) : Except String (PairedNpyEvalFlags × List String)

Parse train/test paths and row counts for paired NPY tensors.

def NN.Examples.Support.PairedNpyEvalFlags.trainLogNotes (config : PairedNpyEvalFlags) : Array String

Stable TrainLog metadata for paired train/test NPY tensors.

structure NN.Examples.Support.CsvArtifactFlags : Type

Optional CSV artifact path for commands that emit one tabular diagnostic.

• plotCsv : System.FilePath

  CSV path for the diagnostic artifact.

def NN.Examples.Support.instReprCsvArtifactFlags.repr : CsvArtifactFlags → ℕ → Std.Format

@[instance_reducible]

instance NN.Examples.Support.instReprCsvArtifactFlags : Repr CsvArtifactFlags

def NN.Examples.Support.CsvArtifactFlags.parse (args : List String) (defaultPlotCsv : System.FilePath) : Except String (CsvArtifactFlags × List String)

Parse the optional --plot-csv artifact path.

structure NN.Examples.Support.NpyDataFlags : Type

Prepared NPY feature/target paths and their row budget.

• xPath : System.FilePath

  Prepared feature or image tensor path.

• yPath : System.FilePath

  Prepared label or target tensor path.

• nRows : ℕ

  Number of rows to read from the arrays.

• seed : ℕ

  Data-loader seed.

def NN.Examples.Support.instReprNpyDataFlags.repr : NpyDataFlags → ℕ → Std.Format

@[instance_reducible]

instance NN.Examples.Support.instReprNpyDataFlags : Repr NpyDataFlags

def NN.Examples.Support.NpyDataFlags.parse (args : List String) (defaultX defaultY : System.FilePath) (defaultRows : ℕ) : Except String (NpyDataFlags × List String)

Parse --seed, --n-total, --x, and --y for an NPY-backed example.

def NN.Examples.Support.NpyDataFlags.trainLogNotes (config : NpyDataFlags) (datasetName : String) : Array String

Stable TrainLog metadata for an NPY-backed dataset branch.

inductive NN.Examples.Support.ImageDatasetChoice : Type

Prepared image datasets understood by the built-in image-model commands.

• imagenet64 : ImageDatasetChoice

  Prepared 64x64 RGB image tensors.

• cifar10 : ImageDatasetChoice

  Prepared CIFAR-10 32x32 RGB tensors.

@[instance_reducible]

instance NN.Examples.Support.instReprImageDatasetChoice : Repr ImageDatasetChoice

def NN.Examples.Support.instReprImageDatasetChoice.repr : ImageDatasetChoice → ℕ → Std.Format

def NN.Examples.Support.instBEqImageDatasetChoice.beq : ImageDatasetChoice → ImageDatasetChoice → Bool

@[instance_reducible]

instance NN.Examples.Support.instBEqImageDatasetChoice : BEq ImageDatasetChoice

def NN.Examples.Support.ImageDatasetChoice.parse (args : List String) : Except String (ImageDatasetChoice × List String)

Parse the dataset selector and reject ambiguous combinations.

structure NN.Examples.Support.ForecastWindowDataFlags : Type

Prepared forecasting-window paths and report controls.

• xPath : System.FilePath

  Prepared input-window tensor path.

• yPath : System.FilePath

  Prepared target-window tensor path.

• windows : ℕ

  Number of forecasting windows to use.

• reportOffset : ℕ

  Window index used for before/after forecast display.

• seed : ℕ

  Data-loader seed.

@[instance_reducible]

instance NN.Examples.Support.instReprForecastWindowDataFlags : Repr ForecastWindowDataFlags

def NN.Examples.Support.instReprForecastWindowDataFlags.repr : ForecastWindowDataFlags → ℕ → Std.Format

def NN.Examples.Support.ForecastWindowDataFlags.trainLogNotes (config : ForecastWindowDataFlags) : Array String

Stable TrainLog metadata for forecasting-window datasets.

Data plus training controls

structure NN.Examples.Support.NpyLoggedTrainFlags : Type

Fixed-step training flags paired with an NPY dataset.

• training : TorchLean.CLI.Training.RunOptions

  Step, batching, and logging controls.

• data : NpyDataFlags

  NPY paths, row budget, and data seed.

@[instance_reducible]

instance NN.Examples.Support.instReprNpyLoggedTrainFlags : Repr NpyLoggedTrainFlags

def NN.Examples.Support.instReprNpyLoggedTrainFlags.repr : NpyLoggedTrainFlags → ℕ → Std.Format

def NN.Examples.Support.NpyLoggedTrainFlags.parse (exeName : String) (args : List String) (defaultLogPath : System.FilePath) (defaultSteps : ℕ) (parseData : List String → Except String (NpyDataFlags × List String)) : Except String NpyLoggedTrainFlags

Parse NPY data and logged-training flags, then reject unused command arguments.

structure NN.Examples.Support.NpyModelTrainFlags : Type

Optimizer/training flags paired with an NPY dataset.

• training : TorchLean.CLI.Training.OptimizerOptions

  Optimizer, step, batching, and logging controls.

• data : NpyDataFlags

  NPY paths, row budget, and data seed.

@[instance_reducible]

instance NN.Examples.Support.instReprNpyModelTrainFlags : Repr NpyModelTrainFlags

def NN.Examples.Support.instReprNpyModelTrainFlags.repr : NpyModelTrainFlags → ℕ → Std.Format

def NN.Examples.Support.NpyModelTrainFlags.parse (exeName : String) (args : List String) (defaultLogPath : System.FilePath) (defaultSteps : ℕ := 1) (defaultLearningRate : Float := 1e-3) (parseData : List String → Except String (NpyDataFlags × List String)) : Except String (NpyModelTrainFlags × List String)

Parse NPY data and the standard model-training flags.

structure NN.Examples.Support.ForecastWindowModelTrainFlags : Type

Optimizer/training flags paired with a forecasting-window dataset.

• training : TorchLean.CLI.Training.OptimizerOptions

  Optimizer, step, batching, and logging controls.

• data : ForecastWindowDataFlags

  Prepared forecasting-window paths and reporting controls.

@[instance_reducible]

instance NN.Examples.Support.instReprForecastWindowModelTrainFlags : Repr ForecastWindowModelTrainFlags

def NN.Examples.Support.instReprForecastWindowModelTrainFlags.repr : ForecastWindowModelTrainFlags → ℕ → Std.Format

def NN.Examples.Support.ForecastWindowModelTrainFlags.parse (exeName : String) (args : List String) (defaultLogPath : System.FilePath) (defaultSteps : ℕ := 100) (defaultLearningRate : Float := 1e-2) (parseData : List String → Except String (ForecastWindowDataFlags × List String)) : Except String (ForecastWindowModelTrainFlags × List String)

Parse forecasting data and the standard model-training flags.

structure NN.Examples.Support.CsvTrainFlags : Type

Optimizer/training flags for a model command that reads one supervised CSV.

• training : TorchLean.CLI.Training.OptimizerOptions

  Optimizer, step, batching, and logging controls.

• csvPath : System.FilePath

  CSV file containing model inputs and targets.

• seed : ℕ

  Seed used for model initialization and data shuffling.

def NN.Examples.Support.instReprCsvTrainFlags.repr : CsvTrainFlags → ℕ → Std.Format

@[instance_reducible]

instance NN.Examples.Support.instReprCsvTrainFlags : Repr CsvTrainFlags

def NN.Examples.Support.parseCsvTrainFlags (exeName : String) (args : List String) (defaultCsv defaultLogPath : System.FilePath) (defaultSteps : ℕ := 1) (defaultLearningRate : Float := 1e-3) (allowZeroSteps : Bool := false) : Except String (CsvTrainFlags × List String)

Parse a CSV path, seed, and the standard model-training flags.