RAPID machine learning Matching python interface specifications

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

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

    1. Generates the information of input data definition
    2. Converts data
    3. Trains the model
  • For predict

    1. Deploys model and some converting information
    2. Converts data
    3. Predicts the score with the model

Quickstart

Matching

In [1]:
from rapid_matching_python import convert

mode = 'cls'
data_conf_path = '/path/to/data_conf_ssi.json'
convert(mode, data_conf_path)
In [2]:
from rapid_matching_python import train_matching

data_conf_path = '/path/to/data_conf_ssi_new.json'
train_matching(mode, data_conf_path)
In [3]:
from rapid_matching_python import predict_matching

predict_matching(mode, data_conf_path)

Filtering

In [1]:
from rapid_matching_python import convert

mode = 'cls'
data_conf_path = '/path/to/data_conf_sse.json'
convert(mode, data_conf_path)
In [2]:
from rapid_matching_python import train_filtering

data_conf_path = '/path/to/data_conf_sse_new.json'
train_filtering(mode, data_conf_path)
In [3]:
from rapid_matching_python import predict_filtering

predict_filtering(mode, data_conf_path)

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