TorchLean API

NN.API.Public.Facade.Runtime.Optim

TorchLean Optimizers #

Public optimizer configuration records and runtime optimizer constructors.

@[reducible, inline]

Optimizer hyperparameter configuration for the supervised training helpers.

This configuration covers the optimizer choices exposed by the public training helpers. It mirrors a few common PyTorch optimizers by name/defaults, but it does not try to cover the full option surface of torch.optim.*.

Instances For

    Public SGD optimizer configuration.

    • lr : Float

      Learning rate.

    • momentum : Float

      Momentum coefficient.

    Instances For

      Public Adam optimizer configuration.

      • lr : Float

        Learning rate.

      • beta1 : Float

        First moment coefficient.

      • beta2 : Float

        Second moment coefficient.

      • epsilon : Float

        Numerical stabilizer.

      Instances For

        Public AdamW optimizer configuration.

        Instances For

          SGD optimizer config, written optim.sgd { lr := 0.05 }.

          Instances For

            Momentum SGD optimizer config. Pass lr and optionally override momentum.

            Instances For

              Adam optimizer config, written optim.adam { lr := 1e-3 }.

              Instances For

                AdamW optimizer config, written optim.adamw { lr := 1e-3, weightDecay := 0.01 }.

                Instances For
                  @[reducible, inline]

                  Optimizer algorithm accepted by simple CLI commands that expose a --optim flag.

                  Instances For
                    @[reducible, inline]

                    Parse an optimizer name accepted by a command-line --optim flag.

                    Instances For

                      Human-readable optimizer name used in logs.

                      Instances For

                        Build a public optimizer config for this optimizer kind and learning rate.

                        Instances For
                          def TorchLean.optim.runtimeAdam {α : Type} [Runtime.TensorScalar α] (lr beta1 beta2 epsilon : α) {paramShapes : List Shape} :

                          Runtime Adam optimizer for module-level training.

                          Instances For
                            def TorchLean.optim.runtimeAdamW {α : Type} [Runtime.TensorScalar α] (lr weightDecay beta1 beta2 epsilon : α) {paramShapes : List Shape} :

                            Runtime AdamW optimizer for module-level training.

                            Instances For

                              Runtime SGD optimizer for module-level training.

                              Instances For
                                def TorchLean.optim.runtimeMomentumSGD {α : Type} [Runtime.TensorScalar α] (lr momentum : α) {paramShapes : List Shape} :

                                Runtime momentum-SGD optimizer for module-level training.

                                Instances For