===========================================================================
RAPID machine learning Time Series Analysis python interface specifications
===========================================================================

This document describes specifications of the RAPID machine learning Time Series Analysis(RAPID TSA) python interface.

.. contents:: Contents
    :local:

Overview
========
This software is RAPID TSA python interface, which is python interface for RAPID TSA V2.2.

Below is procedure with API of RAPID TSA python interface.

.. note::
   The procedure is the same with RAPID TSA V2.2.

- For train

   #. Calculates the statistics
   #. Pre-processes the train data
   #. Trains with the label data, and generate the model

- For predict

   #. Pre-processes the predict data with train's statistics
   #. Predicts the label with the model

Quickstart
----------

.. |example| raw:: html
  :file: _build/nbconvert/example.html

|example|


Input Specification
===================

Data and config files of RAPID TSA python interface are same with RAPID TSA V2.2.
So, refer to chapter 6 of RAPID TSA V2.2 User Guide.


Others
======

Logging and Error messages
--------------------------
Logging and error messages are output in log file following with RAPID TSA V2.2.
So, refer to chapter 6.7 of RAPID TSA V2.2 User Guide.

.. note::
   You can see log file with `cat`, `less` or etc. command at Jupyter Terminal.
   And log file is outputted at `/var/log/nec/rapid/TSA_<index>.log` and `/var/log/nec/rapid/MLE_<index>.log` by default.
