.. _program_listing_file_src_models_model_base.h:

Program Listing for File model_base.h
=====================================

|exhale_lsh| :ref:`Return to documentation for file <file_src_models_model_base.h>` (``src/models/model_base.h``)

.. |exhale_lsh| unicode:: U+021B0 .. UPWARDS ARROW WITH TIP LEFTWARDS

.. code-block:: cpp

   #pragma once
   
   #include <string>
   #include "marian.h"
   #include "layers/loss.h"
   #include "layers/generic.h"
   
   namespace marian {
   namespace models {
   
   enum struct usage { raw, training, scoring, translation, embedding };
   }
   }  // namespace marian
   
   YAML_REGISTER_TYPE(marian::models::usage, int)
   
   namespace marian {
   namespace models {
   
   // model = input -> predictions
   class IModel {
   public:
     virtual void load(Ptr<ExpressionGraph>,
                       const std::string&,
                       bool markReloaded = true)
         = 0;
     virtual void save(Ptr<ExpressionGraph>,
                       const std::string&,
                       bool saveTranslatorConfig = false)
         = 0;
   
     virtual Logits build(Ptr<ExpressionGraph> graph,
                          Ptr<data::Batch> batch,
                          bool clearGraph = true)
         = 0;
   
     virtual void clear(Ptr<ExpressionGraph> graph) = 0;
   };
   
   // criterion = (input, reference) -> loss
   // @TODO: Is there a better name?
   class ICriterionFunction {
   public:
     virtual ~ICriterionFunction() {}
   
     virtual void load(Ptr<ExpressionGraph>,
                       const std::string&,
                       bool markReloaded = true)
         = 0;
     virtual void save(Ptr<ExpressionGraph>,
                       const std::string&,
                       bool saveTranslatorConfig = false)
         = 0;
   
     virtual Ptr<RationalLoss> build(Ptr<ExpressionGraph> graph,
                                     Ptr<data::Batch> batch,
                                     bool clearGraph = true)
         = 0;
   
     virtual void clear(Ptr<ExpressionGraph> graph) = 0;
   };
   
   }  // namespace models
   }  // namespace marian