onnx_function_impl.hpp

/*
 *    This file is part of CasADi.
 *
 *    CasADi -- A symbolic framework for dynamic optimization.
 *    Copyright (C) 2010-2023 Joel Andersson, Joris Gillis, Moritz Diehl,
 *                            KU Leuven. All rights reserved.
 *    Copyright (C) 2011-2014 Greg Horn
 *
 *    CasADi is free software; you can redistribute it and/or
 *    modify it under the terms of the GNU Lesser General Public
 *    License as published by the Free Software Foundation; either
 *    version 3 of the License, or (at your option) any later version.
 *
 *    CasADi is distributed in the hope that it will be useful,
 *    but WITHOUT ANY WARRANTY; without even the implied warranty of
 *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *    Lesser General Public License for more details.
 *
 *    You should have received a copy of the GNU Lesser General Public
 *    License along with CasADi; if not, write to the Free Software
 *    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 *
 */
 
 
#ifndef CASADI_ONNX_FUNCTION_IMPL_HPP
#define CASADI_ONNX_FUNCTION_IMPL_HPP
 
#include "onnx_function.hpp"
#include "function_internal.hpp"
#include "plugin_interface.hpp"
#include <set>
 
 
namespace casadi {
 
  class GraphBuilderInternal;
 
  struct OnnxTensorInfo {
    std::string name;                    
    std::vector<casadi_int> shape;       
    casadi_int elem_type;                
    casadi_int numel;                    
  };
 
  struct CASADI_EXPORT OnnxMemory : public FunctionMemory {
  };
 
  CASADI_EXPORT std::string onnx_dtype_name(casadi_int elem_type);
 
  CASADI_EXPORT casadi_int onnx_dtype_enum(const std::string& name);
 
  class CASADI_EXPORT OnnxFunction : public FunctionInternal, public PluginInterface<OnnxFunction> {
   public:
    OnnxFunction(const std::string& name,
                 const GraphBuilderInternal* gb,
                 const std::vector<std::string>& inputs,
                 const std::vector<std::string>& outputs);
    ~OnnxFunction() override;
 
    typedef OnnxFunction* (*Creator)(const std::string& name,
                                     const GraphBuilderInternal* gb,
                                     const std::vector<std::string>& inputs,
                                     const std::vector<std::string>& outputs,
                                     const Dict& opts);
 
    struct Exposed { };
 
 
    static const Options options_;
    const Options& get_options() const override { return options_;}
 
    // The plugin fills tensor metadata before init(); the base exposes I/O from it
    size_t get_n_in() override { return in_.size(); }
    size_t get_n_out() override { return out_.size(); }
    std::string get_name_in(casadi_int i) override { return in_.at(i).name; }
    std::string get_name_out(casadi_int i) override { return out_.at(i).name; }
    Sparsity get_sparsity_in(casadi_int i) override { return tensor_sparsity(in_.at(i).shape); }
    Sparsity get_sparsity_out(casadi_int i) override { return tensor_sparsity(out_.at(i).shape); }
 
    void init(const Dict& opts) override;
 
    void* alloc_mem() const override { return new OnnxMemory(); }
    void free_mem(void* mem) const override { delete static_cast<OnnxMemory*>(mem); }
 
    int eval(const double** arg, double** res,
             casadi_int* iw, double* w, void* mem) const override = 0;
 
    bool uses_output() const override { return false; }
 
    // A model authored with CasADi's derivative naming can serve its own forward sensitivities:
    // get_forward re-create()s from the same model selecting the fwd_* tensors. Otherwise CasADi
    // falls back to finite differences.
    bool has_forward(casadi_int nfwd) const override;
    Function get_forward(casadi_int nfwd, const std::string& name,
                         const std::vector<std::string>& inames,
                         const std::vector<std::string>& onames,
                         const Dict& opts) const override;
    bool has_reverse(casadi_int nadj) const override;
    Function get_reverse(casadi_int nadj, const std::string& name,
                         const std::vector<std::string>& inames,
                         const std::vector<std::string>& onames,
                         const Dict& opts) const override;
    bool has_jacobian() const override;
    Function get_jacobian(const std::string& name,
                          const std::vector<std::string>& inames,
                          const std::vector<std::string>& onames,
                          const Dict& opts) const override;
 
    void serialize_body(SerializingStream &s) const override;
    void serialize_type(SerializingStream &s) const override;
    std::string serialize_base_function() const override { return "Onnx"; }
    static ProtoFunction* deserialize(DeserializingStream& s);
 
    static std::string meta_doc;
 
    static Function create(const std::string& solver,
                           const std::string& name,
                           const GraphBuilderInternal* gb,
                           const std::vector<std::string>& inputs,
                           const std::vector<std::string>& outputs,
                           const Dict& opts);
 
    // Infix used to form plugin registration symbols (casadi_register_onnx_<name>)
    static const std::string infix_;
 
    static std::map<std::string, Plugin> solvers_;
 
#ifdef CASADI_WITH_THREADSAFE_SYMBOLICS
    static std::mutex mutex_solvers_;
#endif // CASADI_WITH_THREADSAFE_SYMBOLICS
 
   protected:
    explicit OnnxFunction(DeserializingStream& s);
 
    static Sparsity tensor_sparsity(const std::vector<casadi_int>& shape);
 
    void build_io_map();
 
    bool diff_in(casadi_int i) const { return is_diff_in_.empty() || is_diff_in_.at(i); }
    bool diff_out(casadi_int i) const { return is_diff_out_.empty() || is_diff_out_.at(i); }
 
    static Function from_model_data(const std::string& solver, const std::string& name,
                                    const std::vector<uint8_t>& model_data,
                                    const std::vector<std::string>& inputs,
                                    const std::vector<std::string>& outputs,
                                    const Dict& opts);
 
    Function wrap_derivative(const std::string& name,
                             const std::vector<std::string>& inames,
                             const std::vector<std::string>& onames,
                             const std::vector<Sparsity>& in_sp,
                             const std::vector<Sparsity>& out_sp,
                             const Dict& dim_bind, const Dict& opts) const;
 
    std::vector<uint8_t> model_data_;
 
    std::vector<OnnxTensorInfo> in_, out_;
 
    std::vector<OnnxTensorInfo> all_in_;
 
    std::vector<casadi_int> in_src_;
 
    std::vector<double> in_val_;
 
    std::set<std::string> model_inputs_, model_outputs_;
 
    std::string fwd_dim_ = "nfwd";
    std::string adj_dim_ = "nadj";
 
    std::map<std::string, std::vector<double>> input_values_;
  };
 
} // namespace casadi
 
 
#endif // CASADI_ONNX_FUNCTION_IMPL_HPP