1.1.5.1. src.ml_pipeline.ML_Model.Model

class Model(Models_inst, name, **override_kwargs)

Bases: ml_pipeline.ML_ParentClass.ML_ParentClass

Methods

custom_func
do_nothing
exit
export_cached
export_data
export_model_to_pickle
export_results
format_string_by_atts
generic_cleaning
get_attr	returns self.<att_string>
get_atts	returns all values of atts for class instance
get_random_Child
has_attr	returns True/False whether the instance has the attribute
has_atts	returns a list of True/False indicating whether the class has each attribute
import_cached
import_model_from_pickle
join_files
lambda_on_Children
make_Input_Files
open_Child_user
postprocess
preprocess
print_all_atts	Print off all Class instance attributes
print_atts	Print attributes of the class off, if not printed off, the string will be returned
print_class_type	Shows information about what type of class self is
print_imp_atts	Prints off (or returns a string) with the 'important' information about a class Most child classes will redefine this method with custom attributes to print off
print_one_line_atts	Prints off (or returns a string) with information about a class in one line Most child classes will redefine this method with custom attributes to print off
print_string	Function does one of two things 1.
read_files
run	Give the user options on what to run
run_algorithm
run_method	runs method_name associated with self and given *args and **kwargs, returns whatever the method_pointer returns
run_pipeline
select_Child_user
select_Children_where	return a list of Children instances where Child_add == Child_value
set_attr	sets self.att = val
set_atts	sets attributes of the class equal to the dictionary values
shap

Attributes

BASE_OPTIONS
DEFAULT_KWARGS
EXCEL_PARAMS
RELATIVE_DATA_DIR_KEYS
SUFFIX
UPDATED_OPTIONS

get_attr(att_string: str) → Any

returns self.<att_string>

get_atts(atts: str) → List[Any]

returns all values of atts for class instance

has_attr(att: str) → bool

returns True/False whether the instance has the attribute

has_atts(atts: List[str]) → List[bool]

returns a list of True/False indicating whether the class has each attribute

print_all_atts(print_off: bool = True)

Print off all Class instance attributes

print_atts(how: str = 'imp', **kwargs)

Print attributes of the class off, if not printed off, the string will be returned

print_class_type(print_off: bool = True)

Shows information about what type of class self is

print_imp_atts(print_off=True)

Prints off (or returns a string) with the ‘important’ information about a class Most child classes will redefine this method with custom attributes to print off

print_one_line_atts(print_off=True, leading_string='\t')

Prints off (or returns a string) with information about a class in one line Most child classes will redefine this method with custom attributes to print off

print_string(string: str, print_off: bool = True) → Any

Function does one of two things 1. Prints off the string and returns NOne 2. Returns the string

run()

Give the user options on what to run

run_method(method_name, *method_args, **method_kwargs)

runs method_name associated with self and given *args and **kwargs, returns whatever the method_pointer returns

select_Children_where(att, value)

return a list of Children instances where Child_add == Child_value

set_attr(att: str, val: Any) → None

sets self.att = val

set_atts(dictionary: dict) → None

sets attributes of the class equal to the dictionary values