FMTYieldModelNn.h

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.h"
#include "FMTYieldModel.h"
#include <boost/serialization/serialization.hpp>
#include <boost/serialization/nvp.hpp>
 
 
#ifndef FMTYIELDMODELNN_Hm_included
#define FMTYIELDMODELNN_Hm_included
 
namespace Ort 
{
    struct Env;
    struct Session;
}
 
 
namespace Core 
{
    // DocString: FMTYieldModelNn
    class FMTYieldModelNn : public FMTYieldModel
    {
        friend class boost::serialization::access;
        // DocString: FMTYieldModelNn::serialize
        template<class Archive>
        void serialize(Archive& ar, const unsigned int version)
        {
            ar & boost::serialization::make_nvp("FMTyieldmodel", boost::serialization::base_object<FMTYieldModel>(*this));
        }
    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;
    protected:
    #ifdef FMTWITHONNXR
        static std::unique_ptr<Ort::Env> m_envPtr;
        std::unique_ptr<Ort::Session> m_sessionPtr;
    #endif
        static const float m_UNKNOWN_DISTURBANCE_CODE;
        const std::string m_JSON_PROP_MODEL_TYPE = "modelType";
        const std::string m_JSON_PROP_MODEL_YIELDS = "modelYields";
        const std::string m_JSON_PROP_MODEL_OUTPUTS = "outputNames";
        const std::string m_JSON_PROP_STAND_FILE_PATH = "csvStandardisationFile";
        std::string m_modelType;
        std::vector<float> m_standardParamMeans = {};
        std::vector<float> m_standardParamVars = {};
        std::vector<std::string> m_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);
    };
}
 
#endif