aswi2021tri-musketyri-gitlab/Server/ServerApp/Predictor/IPredictor.cs @ 9a529f10

//
// Author: Roman Kalivoda
//

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using Microsoft.ML;
using Microsoft.ML.Data;


namespace ServerApp.Predictor
{
    /// <summary>
    /// A predictor interface.
    /// </summary>
    public interface IPredictor
    {
        /// <summary>
        /// Trains the predictor with the given training data input.
        /// </summary>
        /// <param name="trainInput">A collection of <c>ModelInput</c> instances. The objects contain both feature vector inputs and corresponding labels.</param>
        void Fit(IEnumerable<ModelInput> trainInput);

        /// <summary>
        /// Predicts class to the given feature vector.
        /// </summary>
        /// <param name="input">A feature vector in <c>ModelInput</c> instance.</param>
        /// <returns>A predicted label.</returns>
        string Predict(ModelInput input);

        /// <summary>
        /// Evaluates the model on <paramref name="modelInputs"/> and prints metrics to console.
        /// </summary>
        /// <param name="modelInputs">Input data used to evaluate the predictor.</param>
        void Evaluate(IEnumerable<ModelInput> modelInputs);

        /// <summary>
        /// Saves the trained model under given filename.
        /// </summary>
        /// <param name="filename">Path of the file.</param>
        public void Save(string filename);

        /// <summary>
        /// Loads an IPredictor model from file
        /// </summary>
        /// <param name="filename">Path to the model file.</param>
        /// <returns>A prediction model.</returns>
        public void Load(string filename);
    }
}