QOPT OPTIMIZATION LIBRARY

Version 0.16.0
Developed by Joseph Hobbs under the MIT License

SYNTAX

    [binary-name] [--flag]* [--parameter value]*

FLAGS

    --opt-help              Display this help menu
    --quiet                 Does not print updates each iteration
    --no-stop-early         Do not check gradient magnitude for optimization convergence

PARAMETERS

    --print-every [int]     Prints updates every `[int]` iterations
    --paradigm [str]        Optimizes using the given paradigm
    --criterion [float]     Sets the gradient magnitude for optimization convergence
    --maxiter [int]         Sets the maximum number of iterations
    --maxtemp [float]       Sets the maximum annealing temperature (for `simulated-annealing` only)
    --stdev [float]         Sets the standard deviation for population mutation (for stochastic methods only)

PARADIGMS

    DETERMINISTIC METHODS

        `steepest-descent` (default)
            Steepest descent using a gradient-based method.  Ensure to set `criterion` appropriately.
        
        `newton`
            Newton's method.  Ensure to set `criterion` appropriately.

    STOCHASTIC METHODS

        `genetic`
            Genetic algorithm.  Ensure to set `maxiter` and `stdev` appropriately.

        `simulated-annealing`
            Simulated annealing.  Ensure to set `maxiter`, `maxtemp`, and `stdev` appropriately.
