JobCollection¶
Bases: VizTools
The JobCollection class provides facilities for handling and downloading multiple jobs results as one object.
A jobcollection is created as the result of e.g. running multiple jobs in parallel:
jobcollection = workflow.run_jobs_parallel()
Initialize a jobcollection from existing jobs:
jobcollection = up42.initialize_jobcollection(job_ids=["12345", "6789"])
Source code in up42/jobcollection.py
16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 |
|
info: Dict[str, dict]
property
¶
Gets and updates the metadata information for each job in the jobcollection, dictionary of job_id : job_information.
status: Dict[str, str]
property
¶
Gets the status for each job in the jobcollection, a dictionary with job_id : job status.
apply(worker, only_succeeded=True, **kwargs)
¶
Helper function to apply worker
on all jobs in the collection.
worker
needs to accept Job
as first argument. For example, a
lambda function that returns the job info:
self.apply(lambda job: job.info)
Parameters:
Name | Type | Description | Default |
---|---|---|---|
worker |
Callable
|
A function to apply on all jobs in the collection. |
required |
only_succeeded |
bool
|
Only apply to succeeded jobs (default is |
True
|
kwargs |
additional keyword arguments to pass to |
{}
|
Source code in up42/jobcollection.py
67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 |
|
download_results(output_directory=None, merge=True, unpacking=True)
¶
Downloads the job results. The final results are individually downloaded and by default a merged data.json is generated with all the results in a single feature collection. Unpacking the final will happen as default. Args: output_directory: The file output directory, defaults to the current working directory. merge: Wether to generate a merged data.json with all results. unpacking: By default the final result which is in TAR archive format will be unpacked.
Returns:
Type | Description |
---|---|
Dict[str, List[str]]
|
Dict of the job_ids and jobs' downloaded results filepaths. In addition, |
Dict[str, List[str]]
|
an additional key merged_result is added with the path to the merged |
Dict[str, List[str]]
|
data.json. |
Source code in up42/jobcollection.py
108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 |
|