chemicalchecker.util.pipeline.tasks.task_cc_predict.CCPredict

class CCPredict(cc_root, cctype, molset, **params)[source]

Bases: BaseTask

Initialize CC predict task.

Parameters:
  • cc_root (str) – The CC root path (Required)

  • cctype (str) – The CC type where the predict is applied (Required)

  • molset (str) – The signature molset (e.g. full or reference) on which the predict method will be called.

  • name (str) – The name of the task (default:cctype)

  • datasets (list) – The list of dataset codes to apply the predict (Optional, by default ‘essential’ which includes all essential CC datasets)

  • sign_args (dict) – A dictionary where key is dataset code and value is a list with all dataset specific parameters for initializing the signature. (Optional)

  • sign_kwargs (dict) – A dictionary where key is dataset code and value is a dictionary with all dataset specific key-worded parameters for initializing the signature. (Optional)

  • predict_fn (str) – The name of the predict function to call. By default si predict.

  • predict_args (dict) – A dictionary where key is dataset code and value is a list with all dataset specific parameters for calling the signature predict method. (Optional)

  • predict_kwargs (dict) – A dictionary where key is dataset code and value is a dictionary with all dataset specific key-worded calling the signature predict method. (Optional)

  • hpc_kwargs (dict) – A dictionary where key is dataset code and value is a dictionary with key-worded parameters for the HPC module. (Optional)

Methods

clean

Clean the step.

custom_ready

execute

Same as run but for Airflow.

is_ready

Check if the step is already done.

mark_ready

Mark the step as done.

run

Run the task.

set_dirs

clean(substep=None)

Clean the step.

execute(context)[source]

Same as run but for Airflow.

is_ready(substep=None)

Check if the step is already done.

mark_ready(substep=None)

Mark the step as done.

run()[source]

Run the task.