FMTyieldmodelnn.hpp

Go to the documentation of this file.

 
/*
Copyright (c) 2019 Gouvernement du Québec
 
SPDX-License-Identifier: LiLiQ-R-1.1
License-Filename: LICENSES/EN/LiLiQ-R11unicode.txt
*/
#include "FMTobject.hpp"
#include "FMTyieldmodel.hpp"
#include <boost/serialization/serialization.hpp>
#include <boost/serialization/nvp.hpp>
 
 
#ifndef FMTYIELDMODELNN_H_INCLUDED
#define FMTYIELDMODELNN_H_INCLUDED
 
namespace Ort 
{
    struct Env;
    struct Session;
}
 
 
namespace Core 
{
    // DocString: FMTyieldmodelnn
    class FMTyieldmodelnn : public FMTyieldmodel
    {
        friend class boost::serialization::access;
        template<class Archive>
        void serialize(Archive& ar, const unsigned int version)
        {
            ar & boost::serialization::make_nvp("FMTyieldmodel", boost::serialization::base_object<FMTyieldmodel>(*this));
        }
    protected:
    #ifdef FMTWITHONNXR
        static std::unique_ptr<Ort::Env> envPtr;
        std::unique_ptr<Ort::Session> sessionPtr;
    #endif
        static const float UNKNOWN_DISTURBANCE_CODE;
        const std::string JSON_PROP_MODEL_TYPE = "modelType";
        const std::string JSON_PROP_MODEL_YIELDS = "modelYields";
        const std::string JSON_PROP_MODEL_OUTPUTS = "outputNames";
        const std::string JSON_PROP_STAND_FILE_PATH = "csvStandardisationFile";
        std::string modelType;
        std::vector<float> standardParamMeans = {};
        std::vector<float> standardParamVars = {};
        std::vector<std::string> modelOutputs = {};
        // DocString: FMTyieldmodelnn::GetNextLineAndSplitIntoTokens
        static const std::vector<std::string> GetNextLineAndSplitIntoTokens(std::istream& str);
        // DocString: FMTyieldmodelnn::Standardize
        static const std::vector<float> Standardize(std::vector<float>& input, const std::vector<float>& means, const std::vector<float>& vars);
        
        // DocString: FMTyieldmodelnn::ValidateInputYields
        void ValidateInputYields(std::vector<std::string>& expectedYields, std::vector<std::string>& inputYields) const;
        // DocString: FMTyieldmodelnn::GetModelType()
        const std::string& GetModelType() const;
        // DocString: FMTyieldmodelnn::GetStandardParamMeans()
        const std::vector<float>& GetStandardParamMeans() const;
        // DocString: FMTyieldmodelnn::GetStandardParamVars()
        const std::vector<float>& GetStandardParamVars() const;
        // DocString: FMTyieldmodelnn::GetModelOutputNames()
        const std::vector<std::string>& GetModelOutputNames() const;
        // DocString: FMTyieldmodelnn::GetInputValues()
        virtual const std::vector<double> GetInputValues(const Graph::FMTpredictor& predictor) const = 0;
        // DocString: FMTyieldmodelnn::RemoveNans
        const void RemoveNans(std::vector<float>& input) const;
        // DocString: FMTyieldmodelnn::FMTyieldmodelpools(const boost::property_tree::ptree& jsonProps, std::vector<std::string>& inputYields)
        FMTyieldmodelnn(const boost::property_tree::ptree& jsonProps, std::vector<std::string>& inputYields);
    public:
        // DocString: FMTyieldmodelnn::~FMTyieldmodel()
        virtual ~FMTyieldmodelnn();
        // DocString: FMTyieldmodelnn::FMTyieldmodelnn()
        FMTyieldmodelnn()=default;
        // DocString: FMTyieldmodelnn::FMTyieldmodelnn()
        FMTyieldmodelnn(const FMTyieldmodelnn& rhs);
        // DocString: FMTyieldmodelnn::Predict
        const std::vector<double>Predict(const Core::FMTyieldrequest& request) const;
        // DocString: FMTyieldmodelnn::std::string()
        virtual  operator std::string() const;
    };
}
 
#endif