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

//
// Author: Roman Kalivoda
//

using System.Collections.Generic;
using ServerApp.Connection.XMLProtocolHandler;

namespace ServerApp.Predictor
{
    /// <summary>
    /// Interface for PredictionController class. Defines basic interface methods to access the "model" package.
    /// </summary>
    public interface IPredictionController
    {
        /// <summary>
        /// </summary>
        /// <returns>A list with all existing predictors.</returns>
        List<string> GetPredictors();

        /// <summary>
        /// Trains all predictors. The training data are taken from given path location.
        /// </summary>
        void Train();

        /// <summary>
        /// Loads trained predictors from files in <c>path</c>.
        /// </summary>
        /// <param name="path">A path to folder with trained prediction model.</param>
        int Load(string path);

        /// <summary>
        /// Rolls back the predictors to previous trained instances.
        /// </summary>
        int Rollback();

        /// <summary>
        /// Predicts turnout level at given time supposing given weather conditions.
        /// </summary>
        /// <param name="request">A request with time and weather information.</param>
        /// <returns>A server response filled with predictions.</returns>
        Response Predict(Request request);

        /// <summary>
        /// Returns the filenames of data files used to train current predictor instances
        /// </summary>
        /// <returns>Collection of filenames</returns>
        IEnumerable<string> GetDataFileNames();

        /// <summary>
        /// Saves the predictors to model data path.
        /// </summary>
        public void Save();
    }
}