Access Job ID within data generator

[SNMS95]

If we only implemented the execute function, we have access to the ExperimentSample object which does not have an ID.
How can we then log information about the current JOB?

[mpvanderschelling]

Hi Surya,
In short; the ExperimentSample itself does not have an ID. It is when it is combined in an ExperimentData object that it gains an ID since the .data attribute of the ExperimentData is a dictionary like {id: ExperimentSample}.

Internally when iterating over the samples, we yield a tuple (id, ExperimentSample). When implementing your data-driven process with a Block, you have access to each ID when you for-loop over the experiment samples. When using the DataGenerator, you implement the local transformation of the sample. The store method of the ExperimentSample will make sure that on_disk objects are stored accordingly with their respective ID.

Hope that makes sense!

[mpvanderschelling]

I have added a optional argument to the .call function of a DataGenerator: pass_id: bool in v.2.0.1
This argument passed the ID number of the job to the execute function as a id key-word argument.
This enables you to extract the ID number for each execute call