module.py

Go to the documentation of this file.

#
# Collective Mind
#
# See cM LICENSE.txt for licensing details.
# See cM Copyright.txt for copyright details.
#
# Developer(s): (C) Grigori Fursin, started on 2011.09
#

# Should always be here
ini={}
cm_kernel=None

# Local settings
import os
import csv
import math

# ============================================================================
def init(i):
    return {'cm_return':0}

# ============================================================================
def build(i):

    """
    Build model

    Input:  {
              data                 
              ct_dimensions_input
              ct_dimensions_output
              desc
              model_name                   - (earth, svm)
              (record_data_to_file_prefix) - if !='', use this filename prefix instead of randomly generated
            }

    Output: {
              cm_return       - return code >0 if error
              file_with_model - file with model
            }
    
    """

    model_name=i.get('model_name','')
    if model_name=='': 
       return {'cm_return':1, 'cm_error':'model name is not specified'}

    # Prepare calling model
    model_code=ini['cfg']['model_code'].replace(cm_kernel.convert_str_to_special('model_name'), model_name)

    cm_kernel.print_for_con('')
    cm_kernel.print_for_con('Loading module code ...')

    r=cm_kernel.load_code({'cm_path':ini['path'], 'cm_code_name':model_code})
    if r['cm_return']>0: return r

    code=r['code']
    a=getattr(code, 'build')
    return a(i)

# ============================================================================
def predict(i):

    """
    Predict using model

    Input:  {
              model_file 
              data                 
              ct_dimensions_input
              (ct_dimensions_output)  - for comparison
              desc                    - cM data description
              model_name              - (earth, svm)
              (max_variation_percent) - for comparison, report points where variation is more than this number (default=0.2)
            }

    Output: {
              cm_return - return code >0 if error
              (rmse)    - if comparison, root mean square error for predictions vs original
              (max_var) - list of points with variation more than max_variation_percent          
            }
    
    """

    model_name=i.get('model_name','')
    if model_name=='': 
       return {'cm_return':1, 'cm_error':'model name is not specified'}

    data=i.get('data',{})
    desc=i.get('desc',{})

    # Prepare calling model
    model_code=ini['cfg']['model_code'].replace(cm_kernel.convert_str_to_special('model_name'), model_name)

    cm_kernel.print_for_con('')
    cm_kernel.print_for_con('Loading module code ...')

    r=cm_kernel.load_code({'cm_path':ini['path'], 'cm_code_name':model_code})
    if r['cm_return']>0: return r

    code=r['code']
    a=getattr(code, 'predict')
    rr=a(i)
    if rr['cm_return']>0: return rr

    # check saving to json (values as strings)
    fx=i.get('ct_output_file_s_json','')
    if fx!='':
       cm_kernel.print_for_con('')
       cm_kernel.print_for_con('Recording to json file '+fx+' ...')

       r=cm_kernel.save_array_to_file_as_json({'cm_filename':fx, 'cm_array':{'data':data, 'desc':desc}})
       if r['cm_return']>0: return r

    return rr