inference

Tasks related to the creation of datacards for inference purposes.

Classes:

CreateDatacards(*args, **kwargs)
CreateDatacardsWrapper(*args, **kwargs)

class CreateDatacards(*args, **kwargs)

Bases: InferenceModelMixin, MLModelsMixin, ProducersMixin, SelectorStepsMixin, CalibratorsMixin, LocalWorkflow, RemoteWorkflow

Attributes:

sandbox
reqs
exclude_index
exclude_params_branch
exclude_params_htcondor_workflow
exclude_params_index
exclude_params_remote_workflow
exclude_params_repr
exclude_params_repr_empty
exclude_params_req
exclude_params_req_get
exclude_params_req_set
exclude_params_sandbox
exclude_params_slurm_workflow
exclude_params_workflow

Methods:

create_branch_map()	Abstract method that must be overwritten by inheriting tasks to define the branch map.
get_mc_datasets(proc_obj)	Helper to find automatic datasets
workflow_requires()	Hook to add workflow requirements.
requires()	The Tasks that this Task depends on.
output()	The output that this Task produces.
run()	The task run method, to be overridden in a subclass.

sandbox = 'bash::$CF_BASE/sandboxes/venv_columnar.sh'

reqs = {'BuildBashSandbox': <class 'columnflow.tasks.framework.remote.BuildBashSandbox'>, 'BundleBashSandbox': <class 'columnflow.tasks.framework.remote.BundleBashSandbox'>, 'BundleCMSSWSandbox': <class 'columnflow.tasks.framework.remote.BundleCMSSWSandbox'>, 'BundleRepo': <class 'columnflow.tasks.framework.remote.BundleRepo'>, 'BundleSoftware': <class 'columnflow.tasks.framework.remote.BundleSoftware'>, 'MergeHistograms': <class 'columnflow.tasks.histograms.MergeHistograms'>, 'MergeShiftedHistograms': <class 'columnflow.tasks.histograms.MergeShiftedHistograms'>}

create_branch_map()

Abstract method that must be overwritten by inheriting tasks to define the branch map.

get_mc_datasets(proc_obj)

Helper to find automatic datasets

Parameters:

proc_obj (dict) – process object from an InferenceModel

Return type:

list[str]

Returns:

List of dataset names corresponding to the process proc_obj

workflow_requires()

Hook to add workflow requirements. This method is expected to return a dictionary. When this method is called from a branch task, an exception is raised.

requires()

The Tasks that this Task depends on.

A Task will only run if all of the Tasks that it requires are completed. If your Task does not require any other Tasks, then you don’t need to override this method. Otherwise, a subclass can override this method to return a single Task, a list of Task instances, or a dict whose values are Task instances.

See Task.requires

output()

The output that this Task produces.

The output of the Task determines if the Task needs to be run–the task is considered finished iff the outputs all exist. Subclasses should override this method to return a single Target or a list of Target instances.

Implementation note

If running multiple workers, the output must be a resource that is accessible by all workers, such as a DFS or database. Otherwise, workers might compute the same output since they don’t see the work done by other workers.

See Task.output

run()

The task run method, to be overridden in a subclass.

See Task.run

exclude_index = False

exclude_params_branch = {'acceptance', 'branches', 'cancel_jobs', 'cleanup_jobs', 'htcondor_cpus', 'htcondor_flavor', 'htcondor_gpus', 'htcondor_logs', 'htcondor_memory', 'htcondor_pool', 'htcondor_scheduler', 'htcondor_share_software', 'ignore_submission', 'job_workers', 'max_runtime', 'no_poll', 'parallel_jobs', 'pilot', 'poll_fails', 'poll_interval', 'retries', 'shuffle_jobs', 'slurm_flavor', 'slurm_partition', 'submission_threads', 'tasks_per_job', 'tolerance', 'transfer_logs', 'walltime'}

exclude_params_htcondor_workflow = {}

exclude_params_index = {'effective_workflow'}

exclude_params_remote_workflow = {}

exclude_params_repr = {'cancel_jobs', 'cleanup_jobs', 'workflow'}

exclude_params_repr_empty = {'ml_models', 'selector_steps'}

exclude_params_req = {'effective_workflow'}

exclude_params_req_get = {}

exclude_params_req_set = {}

exclude_params_sandbox = {'log_file', 'sandbox'}

exclude_params_slurm_workflow = {}

exclude_params_workflow = {'branch'}

class CreateDatacardsWrapper(*args, **kwargs)

Bases: AnalysisTask, WrapperTask

Attributes:

configs
exclude_index
exclude_params_index
exclude_params_repr
exclude_params_repr_empty
exclude_params_req
exclude_params_req_get
exclude_params_req_set
exclude_params_sandbox
skip_configs

Methods:

requires()	Collect requirements defined by the underlying require_cls of the WrapperTask depending on optional additional parameters.
update_wrapper_params(params)

configs = <law.parameter.CSVParameter object>

exclude_index = False

exclude_params_index = {}

exclude_params_repr = {}

exclude_params_repr_empty = {}

exclude_params_req = {}

exclude_params_req_get = {}

exclude_params_req_set = {}

exclude_params_sandbox = {'log_file', 'sandbox'}

requires() → Requirements

Collect requirements defined by the underlying require_cls of the WrapperTask depending on optional additional parameters.

Return type:

Requirements

Returns:

Requirements for the WrapperTask instance.

skip_configs = <law.parameter.CSVParameter object>

update_wrapper_params(params)