/* NiuTrans.Tensor - an open-source tensor library
 * Copyright (C) 2018, Natural Language Processing Lab, Northestern University. 
 * All rights reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

/*
 * $Created by: XIAO Tong (xiaotong@mail.neu.edu.cn) 2018-07-31
 */

#ifndef __T2TMODEL_H__
#define __T2TMODEL_H__

#include "T2TFNN.h"
#include "T2TAttention.h"
#include "T2TEncoder.h"
#include "T2TDecoder.h"
#include "T2TOutput.h"

namespace transformer
{

class T2TModel
{
public:
    /* device id */
    int devID;

    /* memory pool */
    XMem * mem;

    /* the encoder */
    AttEncoder encoder;

    /* the decoder */
    AttDecoder decoder;

    /* output layer */
    T2TOutput outputLayer;

    /* indicates whether the model is running for language modeling */
    bool isLM;

    /* indicates whether the model is running for machine translation */
    bool isMT;

    /* number of heads in the attention model */
    int nhead;

public:
    /* constructor */
    T2TModel();

    /* de-constructor */
    ~T2TModel();

    /* initialize the model */
    void InitModel(int argc, const char ** argv);

    /* make the encoding network */
    XTensor MakeEncoding(XTensor &input, XTensor &mask, bool skipInputRes, bool isTraining);

    /* make the entire network (with the output softmax layer) */
    void Make(XTensor &input, XTensor &output, XTensor &padding, bool isTraining);

    /* get parameter matrics */
    void GetParams(XList &list);

    /* dump the parameters */
    void Dump(const char * fn);

    /* read the parameters */
    void Read(const char * fn);
};

}

#endif
