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.Schedule.Options : 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.

@[instance_reducible]

instance NN.Examples.Support.Schedule.instReprOptions : Repr Options

def NN.Examples.Support.Schedule.instReprOptions.repr : Options → ℕ → Std.Format

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

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

def NN.Examples.Support.Schedule.Options.logNotes (config : Options) : Array String

Stable TrainLog metadata for a diffusion schedule.

structure NN.Examples.Support.Image.OutputOptions : 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.

@[instance_reducible]

instance NN.Examples.Support.Image.instReprOutputOptions : Repr OutputOptions

def NN.Examples.Support.Image.instReprOutputOptions.repr : OutputOptions → ℕ → Std.Format

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

Parse image-artifact paths and the optional reconstruction timestep.

def NN.Examples.Support.Image.OutputOptions.logNotes (config : OutputOptions) : Array String

Stable TrainLog metadata for requested image artifacts.

Prepared-data and diagnostic artifacts

structure NN.Examples.Support.Npy.SplitOptions : 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.Npy.instReprSplitOptions.repr : SplitOptions → ℕ → Std.Format

@[instance_reducible]

instance NN.Examples.Support.Npy.instReprSplitOptions : Repr SplitOptions

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

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

def NN.Examples.Support.Npy.SplitOptions.logNotes (config : SplitOptions) : Array String

Stable TrainLog metadata for paired train/test NPY tensors.

structure NN.Examples.Support.Npy.Options : 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.

@[instance_reducible]

instance NN.Examples.Support.Npy.instReprOptions : Repr Options

def NN.Examples.Support.Npy.instReprOptions.repr : Options → ℕ → Std.Format

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

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

def NN.Examples.Support.Npy.Options.logNotes (config : Options) (datasetName : String) : Array String

Stable TrainLog metadata for an NPY-backed dataset branch.

inductive NN.Examples.Support.Image.Dataset : Type

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

• imagenet64 : Dataset

  Prepared 64x64 RGB image tensors.

• cifar10 : Dataset

  Prepared CIFAR-10 32x32 RGB tensors.

@[instance_reducible]

instance NN.Examples.Support.Image.instReprDataset : Repr Dataset

def NN.Examples.Support.Image.instReprDataset.repr : Dataset → ℕ → Std.Format

@[instance_reducible]

instance NN.Examples.Support.Image.instBEqDataset : BEq Dataset

def NN.Examples.Support.Image.instBEqDataset.beq : Dataset → Dataset → Bool

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

Parse --dataset cifar10|imagenet64; without the flag the dataset is imagenet64.

structure NN.Examples.Support.Forecast.Options : 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.

def NN.Examples.Support.Forecast.instReprOptions.repr : Options → ℕ → Std.Format

@[instance_reducible]

instance NN.Examples.Support.Forecast.instReprOptions : Repr Options

def NN.Examples.Support.Forecast.Options.logNotes (config : Options) : Array String

Stable TrainLog metadata for forecasting-window datasets.

Data plus training controls

structure NN.Examples.Support.Training.Options (Data : Type) : Type

Training controls paired with the caller's data options.

• training : TorchLean.CLI.Training.OptimizerOptions

  Optimizer, step, batching, and logging controls.

• data : Data

  Dataset paths and data-specific controls.

@[instance_reducible]

instance NN.Examples.Support.Training.instReprOptions {Data✝ : Type} [Repr Data✝] : Repr (Options Data✝)

def NN.Examples.Support.Training.instReprOptions.repr {Data✝ : Type} [Repr Data✝] : Options Data✝ → ℕ → Std.Format

def NN.Examples.Support.Training.Options.parse {Data : Type} (exeName : String) (args : List String) (defaultLogPath : System.FilePath) (defaultSteps : ℕ := 1) (defaultLr : Float := 1e-3) (parseData : List String → Except String (Data × List String)) : Except String (Options Data × List String)

Parse data options before the shared optimizer and logging options. Unconsumed arguments remain available to the runtime parser.

structure NN.Examples.Support.Csv.Options : Type

Data options for a command that reads one supervised CSV.

• path : System.FilePath

  CSV file containing model inputs and targets.

def NN.Examples.Support.Csv.instReprOptions.repr : Options → ℕ → Std.Format

@[instance_reducible]

instance NN.Examples.Support.Csv.instReprOptions : Repr Options

def NN.Examples.Support.Csv.Options.parse (args : List String) (defaultPath : System.FilePath) : Except String (Options × List String)

Parse the CSV path, leaving training and runtime options to their parsers.