Interfaces.cs

using MyCaffe.basecode.descriptors;
using System;
using System.Collections.Generic;
using System.Linq;
using System.Runtime.Serialization;
using System.ServiceModel;
using System.Text;
 
namespace MyCaffe.basecode
{
    public enum SPECIAL_TOKENS
    {
        PAD = 0,
        BOS = 1,
        EOS = 2
    }
 
    public enum TRAINING_CATEGORY
    {
        NONE,
        CUSTOM,
        REINFORCEMENT,
        RECURRENT,
        DUAL
    }
 
    public enum Phase
    {
        NONE = 0,
        TRAIN = 1,
        TEST = 2,
        RUN = 3,
        ALL = 5
    }
 
    public enum Stage
    {
        NONE = 0,
        RNN = 1,
        RL = 2,
        ALL = 3,
        CUSTOM = 4
    }
 
 
    public enum GYM_TYPE
    {
        NONE,
        DYNAMIC,
        DATA
    }
 
    public enum DATA_TYPE
    {
        DEFAULT,
        VALUES,
        BLOB
    }
 
    public enum DB_LOAD_METHOD
    {
        LOAD_ON_DEMAND,
        LOAD_ALL,
        LOAD_EXTERNAL,
        LOAD_ON_DEMAND_BACKGROUND,
        LOAD_ON_DEMAND_NOCACHE
    }
 
    public enum SNAPSHOT_WEIGHT_UPDATE_METHOD
    {
        DISABLED = -1,
        FAVOR_ACCURACY,
        FAVOR_ERROR,
        FAVOR_BOTH
    }
 
    public enum SNAPSHOT_LOAD_METHOD
    {
        LAST_STATE = 0,
        WEIGHTS_BEST_ACCURACY = 1,
        WEIGHTS_BEST_ERROR = 2,
        STATE_BEST_ACCURACY = 4,
        STATE_BEST_ERROR = 8
    }
 
    public enum ApVersion
    {
        ELEVENPOINT,
        MAXINTEGRAL,
        INTEGRAL
    }
 
    public interface ITestKnownFailures
    {
        List<Tuple<string, string, string>> KnownFailures { get; }
        int GetPriority(string strClass, string strMethod);
    }
 
 
    //-------------------------------------------------------------------------------------------------
    //  IXImageDatabase Interfaces
    //-------------------------------------------------------------------------------------------------
 
    [Serializable]
    [DataContract]
    public enum DB_ITEM_SELECTION_METHOD
    {
        [EnumMember]
        NONE = 0x0000,
        [EnumMember]
        RANDOM = 0x0001,
        [EnumMember]
        PAIR = 0x0002,
        [EnumMember]
        RANDOM_AND_PAIR = 0x0003,
        [EnumMember]
        BOOST = 0x0004,
        [EnumMember]
        RANDOM_AND_BOOST = 0x0005,
        [EnumMember]
        RANDOM_AND_PAIR_AND_BOOST = 0x0007,
        [EnumMember]
        FIXEDINDEX = 0x0008,
        [EnumMember]
        CLEARFIXEDINDEX = 0x0010
    }
 
    [Serializable]
    [DataContract]
    public enum DB_LABEL_SELECTION_METHOD
    {
        [EnumMember]
        NONE = 0x0000,
        [EnumMember]
        RANDOM = 0x0001,
        [EnumMember]
        BOOST = 0x0002
    }
 
    [Serializable]
    [DataContract]
    public enum IMGDB_SORT
    {
        [EnumMember]
        NONE = 0x0000,
        [EnumMember]
        BYDESC = 0x0001,
        [EnumMember]
        BYTIME = 0x0002,
        [EnumMember]
        BYID = 0x0004,
        [EnumMember]
        BYID_DESC = 0x0008,
        [EnumMember]
        BYIDX = 0x0010
    }
 
    [Serializable]
    [DataContract]
    public enum DB_VERSION
    {
        [EnumMember]
        NONE,
        [EnumMember]
        IMG_V1,
        [EnumMember]
        IMG_V2,
        [EnumMember]
        TEMPORAL,
        [EnumMember]
        DEFAULT = IMG_V2
    }
 
#pragma warning disable 1591
 
    [ServiceContract]
    public interface IXDatabaseEvent 
    {
        [OperationContract(IsOneWay = false)]
        void OnResult(string strMsg, double dfProgress);
 
        [OperationContract(IsOneWay = false)]
        void OnError(DatabaseErrorData err);
    }
 
#pragma warning restore 1591
 
    [ServiceContract(CallbackContract = typeof(IXDatabaseEvent), SessionMode = SessionMode.Required)]
    public interface IXDatabaseBase
    {
        #region Initialization and Cleanup
 
        [OperationContract(IsOneWay = false)]
        void SetConnection(ConnectInfo ci);
 
        [OperationContract(IsOneWay = false)]
        bool InitializeWithDsName1(SettingsCaffe s, string strDs, string strEvtCancel = null, PropertySet prop = null);
 
        [OperationContract(IsOneWay = false)]
        bool InitializeWithDs1(SettingsCaffe s, DatasetDescriptor ds, string strEvtCancel = null, PropertySet prop = null);
 
        [OperationContract(IsOneWay = false)]
        bool InitializeWithDsId1(SettingsCaffe s, int nDataSetID, string strEvtCancel = null, int nPadW = 0, int nPadH = 0, PropertySet prop = null);
 
        [OperationContract(IsOneWay = false)]
        bool LoadDatasetByID1(int nDsId, string strEvtCancel = null);
 
        [OperationContract(IsOneWay = false)]
        bool LoadDatasetByName1(string strDs, string strEvtCancel = null);
 
        [OperationContract(IsOneWay = false)]
        void CleanUp(int nDsId = 0, bool bForce = false);
 
        #endregion // Initialization and Cleanup
 
        #region Properties
        [OperationContract(IsOneWay = false)]
        DB_VERSION GetVersion();
 
        [OperationContract(IsOneWay = false)]
        bool GetLoadItemDataCriteria();
 
        [OperationContract(IsOneWay = false)]
        bool GetLoadItemDebugData();
 
        [OperationContract(IsOneWay = false)]
        double GetDatasetLoadedPercentByName(string strDataset, out double dfTraining, out double dfTesting);
 
        [OperationContract(IsOneWay = false)]
        double GetDatasetLoadedPercentById(int nDatasetID, out double dfTraining, out double dfTesting);
 
        [OperationContract(IsOneWay = false)]
        int GetItemCount(int nSrcId, string strFilterVal = null, int? nBoostVal = null, bool bBoostValIsExact = false);
 
        [OperationContract(IsOneWay = false)]
        Tuple<DB_LABEL_SELECTION_METHOD, DB_ITEM_SELECTION_METHOD> GetSelectionMethod();
 
        [OperationContract(IsOneWay = false)]
        void SetSelectionMethod(DB_LABEL_SELECTION_METHOD? lbl, DB_ITEM_SELECTION_METHOD? img);
        #endregion
 
        #region Sources
        [OperationContract(IsOneWay = false)]
        SourceDescriptor GetSourceById(int nSrcId);
 
        [OperationContract(IsOneWay = false)]
        SourceDescriptor GetSourceByName(string strSrc);
 
        [OperationContract(IsOneWay = false)]
        string GetSourceName(int nSrcId);
 
        [OperationContract(IsOneWay = false)]
        int GetSourceID(string strSrc);
        #endregion
 
        #region Datasets
        [OperationContract(IsOneWay = false)]
        DatasetDescriptor GetDatasetById(int nDsId);
 
        [OperationContract(IsOneWay = false)]
        DatasetDescriptor GetDatasetByName(string strDs);
 
        [OperationContract(IsOneWay = false)]
        string GetDatasetName(int nDsId);
 
        [OperationContract(IsOneWay = false)]
        int GetDatasetID(string strDs);
 
        [OperationContract(IsOneWay = false)]
        bool ReloadDataset(int nDsId);
 
        [OperationContract(IsOneWay = false)]
        bool UnloadDatasetByName(string strDataset);
 
        [OperationContract(IsOneWay = false)]
        bool UnloadDatasetById(int nDatasetID);
        #endregion
 
        #region Image Acquisition
 
        [OperationContract(IsOneWay = false)]
        SimpleDatum QueryItem(int nSrcId, int nIdx, DB_LABEL_SELECTION_METHOD? labelSelectionOverride = null, DB_ITEM_SELECTION_METHOD? imageSelectionOverride = null, int? nLabel = null, bool bLoadDataCriteria = false, bool bLoadDebugData = false);
 
        [OperationContract(IsOneWay = false)]
        List<SimpleDatum> GetItemsFromIndex(int nSrcId, int nStartIdx, int nQueryCount = int.MaxValue, string strFilterVal = null, int? nBoostVal = null, bool bBoostValIsExact = false, bool bAttemptDirectLoad = false);
 
        [OperationContract(IsOneWay = false)]
        List<SimpleDatum> GetItemsFromTime(int nSrcId, DateTime dtStart, int nQueryCount = int.MaxValue, string strFilterVal = null, int? nBoostVal = null, bool bBoostValIsExact = false);
 
        [OperationContract(IsOneWay = false)]
        List<SimpleDatum> GetItems(int nSrcId, int[] rgIdx, string strFilterVal = null, int? nBoostVal = null, bool bBoostValIsExact = false);
 
        [OperationContract(IsOneWay = false)]
        SimpleDatum GetItem(int nItemID, params int[] rgSrcId);
 
        [OperationContract(IsOneWay = false)]
        int FindItemIndex(int nSrcId, DateTime dt, string strDescription);
 
        #endregion
 
        #region Item Mean
 
        [OperationContract(IsOneWay = false)]
        [FaultContract(typeof(DatabaseErrorData))]
        SimpleDatum QueryItemMean(int nSrcId);
 
        [OperationContract(IsOneWay = false)]
        [FaultContract(typeof(DatabaseErrorData))]
        SimpleDatum QueryItemMeanFromDb(int nSrcId);
 
        [OperationContract(IsOneWay = false)]
        [FaultContract(typeof(DatabaseErrorData))]
        SimpleDatum GetItemMean(int nSrcId);
 
        [OperationContract(IsOneWay = false)]
        SimpleDatum QueryItemMeanFromDataset(int nDatasetId);
 
        #endregion // Image Mean
    }
 
    [ServiceContract(CallbackContract = typeof(IXDatabaseEvent), SessionMode = SessionMode.Required)]
    public interface IXTemporalDatabaseBase : IXDatabaseBase
    {
        [OperationContract(IsOneWay = false)]
        void SetInitializationProperties(PropertySet prop);
 
        [OperationContract(IsOneWay = false)]
        int GetTotalSize(int nDsId, Phase phase, int nHistoricalSteps, int nFutureSteps);
 
        [OperationContract(IsOneWay = false)]
        SimpleTemporalDatumCollection QueryTemporalItem(int nQueryIdx, int nSrcId, ref int? nItemIdx, ref int? nValueIdx, DB_LABEL_SELECTION_METHOD? itemSelectionOverride = null, DB_ITEM_SELECTION_METHOD? valueSelectionOverride = null, bool bEnableDebug = false, string strDebugPath = null);
 
        [OperationContract(IsOneWay = false)]
        void Reset();
    }
 
    [ServiceContract(CallbackContract = typeof(IXDatabaseEvent), SessionMode = SessionMode.Required)]
    public interface IXImageDatabaseBase : IXDatabaseBase
    {
        #region Properties
 
        [OperationContract(IsOneWay = false)]
        string GetBoostQueryHitPercentsAsTextFromSourceName(string strSource);
 
        [OperationContract(IsOneWay = false)]
        string GetLabelQueryHitPercentsAsTextFromSourceName(string strSource);
 
        [OperationContract(IsOneWay = false)]
        string GetLabelQueryEpocsAsTextFromSourceName(string strSource);
 
        #endregion // Properties
 
        #region Datasets
 
        [OperationContract(IsOneWay = false)]
        bool ReloadImageSet(int nSrcId);
 
        #endregion // Datasets
 
        #region Labels
 
        [OperationContract(IsOneWay = false)]
        List<LabelDescriptor> GetLabels(int nSrcId);
 
        [OperationContract(IsOneWay = false)]
        string GetLabelName(int nSrcId, int nLabel);
 
        [OperationContract(IsOneWay = false)]
        void SetLabelMapping(int nSrcId, LabelMapping map);
 
        [OperationContract(IsOneWay = false)]
        void UpdateLabelMapping(int nSrcId, int nNewLabel, List<int> rgOriginalLabels);
 
        [OperationContract(IsOneWay = false)]
        void ResetLabels(int nProjectId, int nSrcId);
 
        [OperationContract(IsOneWay = false)]
        void UpdateLabelCounts(int nProjectId, int nSrcId);
 
        [OperationContract(IsOneWay = false)]
        [FaultContract(typeof(DatabaseErrorData))]
        Dictionary<int, int> LoadLabelCounts(int nSrcId);
 
        [OperationContract(IsOneWay = false)]
        string GetLabelCountsAsTextFromSourceId(int nSrcId);
 
        [OperationContract(IsOneWay = false)]
        string GetLabelCountsAsTextFromSourceName(string strSource);
 
        #endregion // Labels
    }
 
    [ServiceContract(CallbackContract = typeof(IXDatabaseEvent), SessionMode = SessionMode.Required)]
    public interface IXImageDatabase1 : IXImageDatabaseBase
    {
        [OperationContract(IsOneWay = false)]
        void UpdateLabelBoosts(int nProjectId, int nSrcId);
 
        [OperationContract(IsOneWay = false)]
        void ResetQuery(int nDsID);
 
        [OperationContract(IsOneWay = false)]
        bool Sort(int nSrcId, IMGDB_SORT method);
 
        [OperationContract(IsOneWay = false)]
        int CreateDatasetOranizedByTime(int nDsId);
 
        [OperationContract(IsOneWay = false)]
        bool DeleteCreatedDataset(int nDsId);
 
        [OperationContract(IsOneWay = false)]
        void DeleteAllCreatedDatasets();
 
        [OperationContract(IsOneWay = false)]
        void DeleteLabelBoosts(int nProjectId, int nSrcId);
 
        [OperationContract(IsOneWay = false)]
        void AddLabelBoost(int nProjectId, int nSrcId, int nLabel, double dfBoost);
 
        [OperationContract(IsOneWay = false)]
        string GetLabelBoostsAsTextFromProject(int nProjectId, int nSrcId);
 
        [OperationContract(IsOneWay = false)]
        bool LoadNextSet(string strEvtCancel);
    }
 
    [ServiceContract(CallbackContract = typeof(IXDatabaseEvent), SessionMode = SessionMode.Required)]
    public interface IXImageDatabase2 : IXImageDatabaseBase
    {
        #region Initialization and Cleanup
 
        [OperationContract(IsOneWay = false)]
        long InitializeWithDsName(SettingsCaffe s, string strDs, string strEvtCancel = null);
 
        [OperationContract(IsOneWay = false)]
        long InitializeWithDs(SettingsCaffe s, DatasetDescriptor ds, string strEvtCancel = null);
 
        [OperationContract(IsOneWay = false)]
        long InitializeWithDsId(SettingsCaffe s, int nDataSetID, string strEvtCancel = null, int nPadW = 0, int nPadH = 0);
 
        [OperationContract(IsOneWay = false)]
        long LoadDatasetByID(int nDsId, string strEvtCancel = null);
 
        [OperationContract(IsOneWay = false)]
        long LoadDatasetByName(string strDs, string strEvtCancel = null);
 
        [OperationContract(IsOneWay = false)]
        bool ReloadIndexing(int nDsId);
 
        [OperationContract(IsOneWay = false)]
        bool ReloadIndexing(string strDs);
 
        bool WaitForDatasetToLoad(int nDsId, bool bTraining, bool bTesting, int nWait = int.MaxValue);
 
        bool WaitForDatasetToLoad(string strDs, bool bTraining, bool bTesting, int nWait = int.MaxValue);
 
        #endregion // Initialization and Cleanup
 
        #region Query States
 
        [OperationContract(IsOneWay = false)]
        long CreateQueryState(int nDsId, bool bUseUniqueLabelIndexes = true, bool bUseUniqueImageIndexes = true, IMGDB_SORT sort = IMGDB_SORT.NONE);
 
        [OperationContract(IsOneWay = false)]
        long CreateQueryState(string strDs, bool bUseUniqueLabelIndexes = true, bool bUseUniqueImageIndexes = true, IMGDB_SORT sort = IMGDB_SORT.NONE);
 
        [OperationContract(IsOneWay = false)]
        bool SetDefaultQueryState(int nDsId, long lQueryState);
 
        [OperationContract(IsOneWay = false)]
        bool SetDefaultQueryState(string strDs, long lQueryState);
 
        [OperationContract(IsOneWay = false)]
        bool FreeQueryState(int nDsId, long lHandle);
 
        [OperationContract(IsOneWay = false)]
        bool FreeQueryState(string strDs, long lHandle);
 
        [OperationContract(IsOneWay = false)]
        string GetLabelQueryHitPercentsAsTextFromSourceName(long lQueryState, string strSource);
 
        [OperationContract(IsOneWay = false)]
        string GetLabelQueryEpocsAsTextFromSourceName(long lQueryState, string strSource);
 
        [OperationContract(IsOneWay = false)]
        string GetBoostQueryHitPercentsAsTextFromSourceName(long lQueryState, string strSource);
 
        #endregion // Query States
 
        #region Properties
 
        [OperationContract(IsOneWay = false)]
        int GetImageCount(long lQueryState, int nSrcId, string strFilterVal = null, int? nBoostVal = null, bool bBoostValIsExact = false);
 
        #endregion // Properties
 
        #region Image Acquisition
 
        [OperationContract(IsOneWay = false)]
        List<SimpleDatum> GetImagesFromIndex(long lQueryState, int nSrcId, int nStartIdx, int nQueryCount = int.MaxValue, string strFilterVal = null, int? nBoostVal = null, bool bBoostValIsExact = false, bool bAttemptDirectLoad = false);
 
        [OperationContract(IsOneWay = false)]
        List<SimpleDatum> GetImagesFromTime(long lQueryState, int nSrcId, DateTime dtStart, int nQueryCount = int.MaxValue, string strFilterVal = null, int? nBoostVal = null, bool bBoostValIsExact = false);
 
        [OperationContract(IsOneWay = false)]
        SimpleDatum QueryImage(long lQueryState, int nSrcId, int nIdx, DB_LABEL_SELECTION_METHOD? labelSelectionOverride = null, DB_ITEM_SELECTION_METHOD? imageSelectionOverride = null, int? nLabel = null, bool bLoadDataCriteria = false, bool bLoadDebugData = false);
 
        #endregion // Image Acquisition
 
        #region Boosts
 
        [OperationContract(IsOneWay = false)]
        void ResetAllBoosts(int nSrcId);
 
        #endregion // Boosts
 
        #region Load Limit Refresh
 
        bool WaitForDatasetToRefresh(int nDsId, bool bTraining, bool bTesting, int nWait = int.MaxValue);
 
        bool WaitForDatasetToRefresh(string strDs, bool bTraining, bool bTesting, int nWait = int.MaxValue);
 
        bool IsRefreshRunning(int nDsId, bool bTraining, bool bTesting);
 
        bool IsRefreshRunning(string strDs, bool bTraining, bool bTesting);
 
        bool StartRefresh(string strDs, bool bTraining, bool bTesting, double dfReplacementPct);
 
        bool StopRefresh(string strDs, bool bTraining, bool bTesting);
 
        bool StartRefresh(int nDsID, bool bTraining, bool bTesting, double dfReplacementPct);
 
        bool StopRefresh(int nDsID, bool bTraining, bool bTesting);
 
        bool StartAutomaticRefreshSchedule(string strDs, bool bTraining, bool bTesting, int nPeriodInMs, double dfReplacementPct);
 
        bool StopAutomaticRefreshSchedule(string strDs, bool bTraining, bool bTesting);
 
        bool GetScheduledAutoRefreshInformation(string strDs, out int nPeriodInMs, out double dfReplacementPct, out int nTrainingRefreshCount, out int nTestingRefreshCount);
 
        bool StartAutomaticRefreshSchedule(int nDsID, bool bTraining, bool bTesting, int nPeriodInMs, double dfReplacementPct);
 
        bool StopAutomaticRefreshSchedule(int nDsID, bool bTraining, bool bTesting);
 
        bool GetScheduledAutoRefreshInformation(int nDsID, out int nPeriodInMs, out double dfReplacementPct, out int nTrainingRefreshCount, out int nTestingRefreshCount);
 
        #endregion
 
        #region Results
 
        List<SimpleResult> GetAllResults(string strSource, bool bRequireExtraData, int nMax = -1);
 
        #endregion
    }
 
#pragma warning disable 1591
 
    [DataContract]
    public class DatabaseErrorData 
    {
        [DataMember]
        public bool Result { get; set; }
        [DataMember]
        public string ErrorMessage { get; set; }
        [DataMember]
        public string ErrorDetails { get; set; }
    }
 
#pragma warning restore 1591
}