model.h

Go to the documentation of this file.

// Copyright (c) 2021, Aalto University, developed by Erik Schultheis
// All rights reserved.
//
// SPDX-License-Identifier: MIT
 
#ifndef DISMEC_MODEL_H
#define DISMEC_MODEL_H
 
#include <vector>
#include <memory>
#include <variant>
#include "matrix_types.h"
#include "data/types.h"
 
namespace dismec::model
{
    struct PartialModelSpec {
        label_id_t first_label;     
        long label_count;           
        long total_labels;          
    };
 
    class Model {
    public:
        using PredictionMatrixOut = Eigen::Ref<PredictionMatrix>;
        using FeatureMatrixIn = GenericInMatrix ;
        using WeightVectorIn = GenericInVector ;
 
        explicit Model(PartialModelSpec spec);
 
        virtual ~Model() = default;
 
        // general data shape
        [[nodiscard]] long num_labels() const noexcept { return m_NumLabels; };
 
        [[nodiscard]] virtual long num_features() const = 0;
 
        [[nodiscard]] long num_weights() const noexcept { return labels_end() - labels_begin(); }
 
        [[nodiscard]] virtual bool has_sparse_weights() const = 0;
 
        // submodel data
        [[nodiscard]] bool is_partial_model() const;
 
        [[nodiscard]] label_id_t labels_begin() const noexcept { return m_LabelsBegin; }
 
        [[nodiscard]] label_id_t labels_end() const noexcept { return m_LabelsEnd; }
 
        [[nodiscard]] long contained_labels() const noexcept { return m_LabelsEnd - m_LabelsBegin; }
 
        void get_weights_for_label(label_id_t label, Eigen::Ref<DenseRealVector> target) const;
 
        void set_weights_for_label(label_id_t label, const WeightVectorIn& weights);
        void predict_scores(const FeatureMatrixIn& instances, PredictionMatrixOut target) const;
 
    protected:
        [[nodiscard]] label_id_t adjust_label(label_id_t label) const;
 
    private:
        virtual void predict_scores_unchecked(const FeatureMatrixIn& instances,
                                              PredictionMatrixOut target) const = 0;
 
        virtual void get_weights_for_label_unchecked(label_id_t label, Eigen::Ref<DenseRealVector> target) const = 0;
 
        virtual void set_weights_for_label_unchecked(label_id_t label, const WeightVectorIn& weights) = 0;
 
        label_id_t m_LabelsBegin;
        label_id_t m_LabelsEnd;
 
 
        long m_NumLabels;
    };
 
}
 
#endif //DISMEC_MODEL_H