gradient-checker.cpp

Go to the documentation of this file.

#include <alpaqa/config/config.hpp>
#include <alpaqa/util/demangled-typename.hpp>
#include <alpaqa/util/print.hpp>
#include <alpaqa-version.h>
 
#include "options.hpp"
#include "problem.hpp"
#include "util.hpp"
 
#ifdef ALPAQA_HAVE_CASADI
#include <casadi/config.h>
#endif
#ifdef WITH_IPOPT
#include <IpoptConfig.h>
#endif
 
#include <algorithm>
#include <filesystem>
#include <fstream>
#include <iostream>
#include <random>
#include <span>
#include <stdexcept>
#include <string>
#include <string_view>
#include <tuple>
#include <type_traits>
namespace fs = std::filesystem;
 
USING_ALPAQA_CONFIG(alpaqa::DefaultConfig);
 
void print_usage(const char *a0) {
    const auto *opts = " [<problem-type>:][<path>/]<name> [options...]\n";
    const auto *docs = R"==(
    problem types:
        dl: Dynamically loaded problem using the DLProblem class.
            Specify the prefix of the registration function using the
            problem.prefix option, e.g. problem.prefix=alpaqa_problem will look
            for a registration function with the name alpaqa_problem_register.
            Further options can be passed to the problem using
            problem.<key>[=<value>].
        cs: Load a CasADi problem using the CasADiProblem class.
            If a .tsv file with the same name as the shared library file exists,
            the bounds and parameters will be loaded from that file. See
            CasADiProblem::load_numerical_data for more details.
            The problem parameter can be set using the problem.param option.
        cu: Load a CUTEst problem using the CUTEstProblem class.
 
    options:
        --full-print
            Print the full gradients.
        --seed=<seed>
            Seed for the random number generator.
    )==";
    std::cout << "alpaqa gradient-checker (" ALPAQA_VERSION_FULL ")\n\n"
                 "    Command-line utility to check problem gradients.\n"
                 "    alpaqa is published under the LGPL-3.0.\n"
                 "    https://github.com/kul-optec/alpaqa"
                 "\n\n"
                 "    Usage: "
              << a0 << opts << docs << std::endl;
    std::cout
        << "Third-party libraries:\n"
        << "  * Eigen " << EIGEN_WORLD_VERSION << '.' << EIGEN_MAJOR_VERSION
        << '.' << EIGEN_MINOR_VERSION
        << " (https://gitlab.com/libeigen/eigen) - MPL-2.0\n"
#ifdef ALPAQA_HAVE_CASADI
        << "  * CasADi " CASADI_VERSION_STRING
           " (https://github.com/casadi/casadi) - LGPL-3.0-or-later\n"
#endif
#ifdef ALPAQA_HAVE_CUTEST
        << "  * CUTEst"
           " (https://github.com/ralna/CUTEst) - BSD-3-Clause\n"
#endif
        << std::endl;
}
 
/// Split the string @p s on the first occurrence of @p tok.
/// Returns ("", s) if tok was not found.
auto split_once(std::string_view s, char tok = '.') {
    auto tok_pos = s.find(tok);
    if (tok_pos == s.npos)
        return std::make_tuple(std::string_view{}, s);
    std::string_view key{s.begin(), s.begin() + tok_pos};
    std::string_view rem{s.begin() + tok_pos + 1, s.end()};
    return std::make_tuple(key, rem);
}
 
auto get_problem_path(const char *const *argv) {
    bool rel_to_exe              = argv[1][0] == '^';
    std::string_view prob_path_s = argv[1] + static_cast<ptrdiff_t>(rel_to_exe);
    std::string_view prob_type;
    std::tie(prob_type, prob_path_s) = split_once(prob_path_s, ':');
    fs::path prob_path{prob_path_s};
    if (rel_to_exe)
        prob_path = fs::canonical(fs::path(argv[0])).parent_path() / prob_path;
    return std::make_tuple(std::move(prob_path), prob_type);
}
 
struct CheckGradientsOpts {
    bool print_full;
};
 
void check_gradients(LoadedProblem &, std::ostream &,
                     const CheckGradientsOpts &);
 
int main(int argc, const char *argv[]) try {
    // Check command line options
    if (argc < 1)
        return -1;
    if (argc == 1)
        return print_usage(argv[0]), 0;
    if (argc < 2)
        return print_usage(argv[0]), -1;
    std::span args{argv, static_cast<size_t>(argc)};
    Options opts{argc - 2, argv + 2};
 
    // Check where to write the output to
    std::ostream &os = std::cout;
 
    // Check which problem to load
    auto [prob_path, prob_type] = get_problem_path(argv);
 
    // Load problem
    os << "Loading problem " << prob_path << std::endl;
    auto problem = load_problem(prob_type, prob_path.parent_path(),
                                prob_path.filename(), opts);
    os << "Loaded problem " << problem.path.stem().c_str() << " from "
       << problem.path << "\nnvar: " << problem.problem.get_n()
       << "\nncon: " << problem.problem.get_m() << "\nProvided functions:\n";
    alpaqa::print_provided_functions(os, problem.problem);
    os << std::endl;
 
    // Options
    auto has_opt = [&opts](std::string_view o) {
        auto o_it = std::ranges::find(opts.options(), o);
        if (o_it == opts.options().end())
            return false;
        auto index         = static_cast<size_t>(o_it - opts.options().begin());
        opts.used()[index] = true;
        return true;
    };
    CheckGradientsOpts cg_opts{
        .print_full = has_opt("--full-print"),
    };
 
    // Seed rand
    auto seed = static_cast<unsigned int>(std::time(nullptr));
    set_params(seed, "--seed", opts);
    std::srand(seed);
 
    // Check options
    auto used       = opts.used();
    auto unused_opt = std::ranges::find(used, false);
    auto unused_idx = static_cast<size_t>(unused_opt - used.begin());
    if (unused_opt != used.end())
        throw std::invalid_argument("Unused option: " +
                                    std::string(opts.options()[unused_idx]));
 
    // Check gradients
    check_gradients(problem, os, cg_opts);
 
} catch (std::exception &e) {
    std::cerr << "Error: " << demangled_typename(typeid(e)) << ":\n  "
              << e.what() << std::endl;
    return -1;
}
 
vec finite_diff(const std::function<real_t(crvec)> &f, crvec x) {
    const auto n = x.size();
    vec grad(n);
    vec h        = vec::Zero(n);
    const auto ε = 5e-6;
    const auto δ = 1e-2 * ε;
    for (index_t i = 0; i < n; ++i) {
        real_t hh        = std::abs(x(i)) * ε > δ ? x(i) * ε : δ;
        h(i)             = hh;
        grad.coeffRef(i) = (f(x + h) - f(x)) / hh;
        h(i)             = 0;
    }
    return grad;
}
 
void check_gradients(LoadedProblem &lproblem, std::ostream &log,
                     const CheckGradientsOpts &opts) {
    auto &te_problem = lproblem.problem;
 
    auto x0 = lproblem.initial_guess_x;
    auto y0 = lproblem.initial_guess_y;
    auto sc = x0.norm();
    auto n = te_problem.get_n(), m = te_problem.get_m();
 
    std::srand(static_cast<unsigned int>(std::time(nullptr)));
    vec Σ = 1.5 * vec::Random(m).array() + 2;
    vec y = y0 + y0.norm() * vec::Random(m);
    vec x = x0 + sc * vec::Random(n);
    vec v = 5e-6 * sc * vec::Random(n);
    vec gx(m);
    vec wn(n), wm(m);
 
    auto print_compare = [&log, &opts](const auto &fd, const auto &ad) {
        auto abs_err = (fd - ad).template lpNorm<Eigen::Infinity>();
        auto rel_err = abs_err / fd.template lpNorm<Eigen::Infinity>();
        log << "  abs error = " << alpaqa::float_to_str(abs_err) << '\n';
        log << "  rel error = " << alpaqa::float_to_str(rel_err) << '\n';
        if (opts.print_full) {
            alpaqa::print_matlab(log << "  fd = ", fd);
            alpaqa::print_matlab(log << "  ad = ", ad) << std::endl;
        }
    };
 
    auto f = [&](crvec x) { return te_problem.eval_f(x); };
    log << "Gradient verification: ∇f(x)\n";
    vec fd_grad_f = finite_diff(f, x);
    vec grad_f(n);
    te_problem.eval_grad_f(x, grad_f);
    print_compare(fd_grad_f, grad_f);
 
    log << "Gradient verification: ∇L(x)\n";
    auto L = [&](crvec x) {
        te_problem.eval_g(x, gx);
        return te_problem.eval_f(x) + gx.dot(y);
    };
    vec fd_grad_L = finite_diff(L, x);
    vec grad_L(n);
    te_problem.eval_grad_L(x, y, grad_L, wn);
    print_compare(fd_grad_L, grad_L);
 
    log << "Gradient verification: ∇ψ(x)\n";
    auto ψ        = [&](crvec x) { return te_problem.eval_ψ(x, y, Σ, wm); };
    vec fd_grad_ψ = finite_diff(ψ, x);
    vec grad_ψ(n);
    te_problem.eval_grad_ψ(x, y, Σ, grad_ψ, wn, wm);
    print_compare(fd_grad_ψ, grad_ψ);
 
    if (te_problem.provides_eval_hess_ψ_prod()) {
        log << "Hessian product verification: ∇²ψ(x)\n";
        vec grad_ψv(n);
        vec xv = x + v;
        te_problem.eval_grad_ψ(xv, y, Σ, grad_ψv, wn, wm);
        vec fd_hess_ψv = grad_ψv - grad_ψ;
        vec hess_ψv(n);
        te_problem.eval_hess_ψ_prod(x, y, Σ, 1, v, hess_ψv);
        print_compare(fd_hess_ψv, hess_ψv);
    }
}