colda.utils package

Subpackages

• colda.utils.dtypes package
  • Submodules
  • colda.utils.dtypes.api module
    • is_dict_like()
    • is_float()
    • is_integer()
    • is_list()
    • is_list_like()
    • is_numpy()
    • is_serializable()
    • is_set()
    • is_tuple()
    • to_list()
    • to_serializable()
    • to_string()
    • to_tuple()
  • colda.utils.dtypes.convert module
    • to_list()
    • to_serializable()
    • to_string()
    • to_tuple()
  • colda.utils.dtypes.inference module
    • is_dict_like()
    • is_float()
    • is_integer()
    • is_list()
    • is_list_like()
    • is_numpy()
    • is_serializable()
    • is_set()
    • is_tuple()
  • Module contents
• colda.utils.log package
  • Submodules
  • colda.utils.log.abstract_log module
    • AbstractLog
      • AbstractLog.get_all_logs()
      • AbstractLog.get_log()
      • AbstractLog.log_serialization()
      • AbstractLog.store_log()
  • colda.utils.log.algorithm_log module
    • AlgorithmLog
      • AlgorithmLog.delete()
      • AlgorithmLog.get_all_logs()
      • AlgorithmLog.get_instance()
      • AlgorithmLog.get_log()
      • AlgorithmLog.log_serialization()
      • AlgorithmLog.store_log()
  • colda.utils.log.api module
    • GetAlgorithmLog
      • GetAlgorithmLog.get_instance()
    • GetWorkflowLog
      • GetWorkflowLog.get_instance()
  • colda.utils.log.base module
    • BaseLog
      • BaseLog.placeholder()
  • colda.utils.log.log_factory module
    • AbstractLogFactory
      • AbstractLogFactory.get_log()
    • GetAlgorithmLog
      • GetAlgorithmLog.get_instance()
    • GetWorkflowLog
      • GetWorkflowLog.get_instance()
  • colda.utils.log.workflow_log module
    • WorkflowLog
      • WorkflowLog.delete()
      • WorkflowLog.get_all_logs()
      • WorkflowLog.get_instance()
      • WorkflowLog.get_log()
      • WorkflowLog.log_serialization()
      • WorkflowLog.store_log()
  • Module contents

Submodules

colda.utils.api module

class colda.utils.api.Constant

Bases: object

INITIAL_DEFAULT_MODE: Final[str] = 'auto'

MAXIMUM_ROUND: Final[int] = 3

class colda.utils.api.DictHelper

Bases: object

Handle dictionary structure mainly for following 2 scenarios:

1. Database

2. Log

Methods

is_key_in_dict generate_dict_root_key store_value get_value get_all_key_value_pairs

classmethod generate_dict_root_key(user_id: str, task_id: str | None = None, supplement_key: str | list[str] | None = None) → tuple[DictKey]

Generate unique dictionary key to store imformation for each task

Parameters

user_id : str task_id : str supplement_key : Union[str, list[str], None]=None

Returns

tuple[str]

classmethod generate_dict_supplement_key(root_key: tuple[DictKey], supplement_key: str | list[str] | None = None) → tuple[DictKey]

Generate unique dictionary key to store imformation for each task

Parameters

user_id : str task_id : str supplement_key : Union[str, list[str], None]=None

Returns

tuple[str]

classmethod get_all_key_value_pairs(container: dict[DictKey, DictValue]) → dict[DictKey, DictValue]

Return all data in current container

Parameters

container : dict[DictKey, DictValue]

Returns

dict

classmethod get_value(key: tuple[DictKey] | Iterable[DictKey], container: dict[DictKey, DictValue]) → DictValue

Get value corresponding to the key in dict.

Parameters

key : DictKey container : dict[DictKey, DictValue]

Returns

DictValue

classmethod is_key_in_dict(key: DictKey, container: dict) → bool

check if key is in dict

Parameters

key : DictKey container : dict

Returns

bool

classmethod store_value(key: tuple[DictKey] | Iterable[DictKey], value: DictValue, container: dict[DictKey, DictValue], store_type: Literal['append', 'store_once', 'store_multiple'] = 'store_once') → None

Store value in dict

Parameters

key : DictKey value : Union[dict[DictKey, DictValue], list[DictValue]] container : dict[DictKey, DictValue] store_type : Dict_Store_Type

We have different store type to handle different situations

Returns

None

class colda.utils.api.Serialization

Bases: object

classmethod make_data_serializable(data: Any) → dict | list | tuple | str | int | float | bool | None

Change data type to serializable data type

Parameters

data : Any

Returns

Serializable_Datatype

colda.utils.api.del_instance(objectInstance: object) → None

colda.utils.api.load_file(fileName: str = 'Colda', path: str = 'D:\\GitHub\\ColAI\\colda\\package\\colda\\utils', mode: str = 'pickle') → Any

colda.utils.api.save_file(input: Any, fileName: str = 'Colda', path: str = 'D:\\GitHub\\ColAI\\colda\\package\\colda\\utils', mode: str = 'pickle') → None

colda.utils.constant module

class colda.utils.constant.Constant

Bases: object

INITIAL_DEFAULT_MODE: Final[str] = 'auto'

MAXIMUM_ROUND: Final[int] = 3

colda.utils.dict_helper module

class colda.utils.dict_helper.DictHelper

Bases: object

Handle dictionary structure mainly for following 2 scenarios:

1. Database

2. Log

Methods

is_key_in_dict generate_dict_root_key store_value get_value get_all_key_value_pairs

classmethod generate_dict_root_key(user_id: str, task_id: str | None = None, supplement_key: str | list[str] | None = None) → tuple[DictKey]

Generate unique dictionary key to store imformation for each task

Parameters

user_id : str task_id : str supplement_key : Union[str, list[str], None]=None

Returns

tuple[str]

classmethod generate_dict_supplement_key(root_key: tuple[DictKey], supplement_key: str | list[str] | None = None) → tuple[DictKey]

Generate unique dictionary key to store imformation for each task

Parameters

user_id : str task_id : str supplement_key : Union[str, list[str], None]=None

Returns

tuple[str]

classmethod get_all_key_value_pairs(container: dict[DictKey, DictValue]) → dict[DictKey, DictValue]

Return all data in current container

Parameters

container : dict[DictKey, DictValue]

Returns

dict

classmethod get_value(key: tuple[DictKey] | Iterable[DictKey], container: dict[DictKey, DictValue]) → DictValue

Get value corresponding to the key in dict.

Parameters

key : DictKey container : dict[DictKey, DictValue]

Returns

DictValue

classmethod is_key_in_dict(key: DictKey, container: dict) → bool

check if key is in dict

Parameters

key : DictKey container : dict

Returns

bool

classmethod store_value(key: tuple[DictKey] | Iterable[DictKey], value: DictValue, container: dict[DictKey, DictValue], store_type: Literal['append', 'store_once', 'store_multiple'] = 'store_once') → None

Store value in dict

Parameters

key : DictKey value : Union[dict[DictKey, DictValue], list[DictValue]] container : dict[DictKey, DictValue] store_type : Dict_Store_Type

We have different store type to handle different situations

Returns

None

colda.utils.serialization module

class colda.utils.serialization.Serialization

Bases: object

classmethod make_data_serializable(data: Any) → dict | list | tuple | str | int | float | bool | None

Change data type to serializable data type

Parameters

data : Any

Returns

Serializable_Datatype

colda.utils.store module

colda.utils.store.create_path(path: str) → None

colda.utils.store.load_file(fileName: str = 'Colda', path: str = 'D:\\GitHub\\ColAI\\colda\\package\\colda\\utils', mode: str = 'pickle') → Any

colda.utils.store.process_path(fileName: str, path: str, mode: str) → str

Process path according to the mode

colda.utils.store.save_file(input: Any, fileName: str = 'Colda', path: str = 'D:\\GitHub\\ColAI\\colda\\package\\colda\\utils', mode: str = 'pickle') → None

colda.utils.utils module

colda.utils.utils.DeleteObjectAllProperties(objectInstance) → None

colda.utils.utils.del_instance(objectInstance: object) → None

colda.utils.utils.handle_Algorithm_return_value(name, return_val, first_val, second_val)

Check if the return value returned by the Algorithm equals to the correct value, e.x. return_val[0] == first_val (‘200’), return_val[1] == second_val (‘make_train’)

Parameters:

• name – String. The name of current return_val

• return_val – String. Contains the status code, name, paths that are returned by Algorithm

• first_val – String. The first value needs to be checked

• second_val – String. The second value needs to be checked

Returns:

return_val that has been split

Raises:

OSError – Placeholder.

colda.utils.utils.load_file(file_address)

start task with all assistors

Parameters:

• file_address – Integer. Maximum training round

• file_content – List. The List of assistors’ usernames

Returns:

Tuple. Contains a string ‘handleTrainRequest successfully’ and the task id

Raises:

OSError – Placeholder.

colda.utils.utils.log_helper(msg, root, user_id, task_id)

Append the msg to log file

Parameters:

msg – List[String]. The name of current return_val

Returns:

None

Raises:

OSError – Placeholder.

colda.utils.utils.save_file(file_address, file_content)

start task with all assistors

Parameters:

• file_address – Integer. Maximum training round

• file_content – List. The List of assistors’ usernames

Returns:

Tuple. Contains a string ‘handleTrainRequest successfully’ and the task id

Raises:

OSError – Placeholder.

Module contents