===============================================================
RAPID machine learning Matching python interface specifications
===============================================================

This document describes specifications of the RAPID machine learning Matching python interface.

.. contents:: Contents
    :local:

Overview
========
This software is RAPID machine learning Matching python interface, which is python interface for RAPID machine learning Matching v2.2.

Below is procedure to matching and filtering with API of RAPID machine learning Matching python interface.

.. note::
   The procedure is the same with RAPID machine learning Matching v2.2.

- For train

   #. Generates the information of input data definition
   #. Converts data
   #. Trains the model

- For predict

   #. Deploys model and some converting information
   #. Converts data
   #. Predicts the score with the model

Quickstart
----------

Matching
~~~~~~~~

.. |notebook_matching| raw:: html
  :file: _build/nbconvert/matching_example_generated_data.html

|notebook_matching|


Filtering
~~~~~~~~~
.. |notebook_filtering| raw:: html
  :file: _build/nbconvert/filtering_example_generated_data.html

|notebook_filtering|


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

Data and config files of RAPID machine learning Matching python interface are same with RAPID machine learning Matching v2.2.
So, refer to RAPID machine learning Matching v2.2 User Guide:

- chapter 4.2 for data files
- chapter 5 for config files

Others
======

Logging and Error messages
--------------------------
Logging and error messages are output in log file following with RAPID machine learning Matching v2.2.
So, refer to RAPID machine learning Matching v2.2 User Guide:

- chapter 6 for log file infomation
- chapter 7 for error messages
- chapter 9 for trouble-shooting

.. note::
   You can see log file with `cat`, `less` or etc. command at Jupyter Terminal.
   And the default path of log file is `/var/log/nec/pyrapid/etc/pyrapid_logger.log`.

Template for Config Files
-------------------------

The following config template file is prepared at `/opt/nec/pyrapid/template/matching/etc/` directory.

- hparam_sse.json
- hparam_ssi.json
- logger_config.conf
