Checkpoint¶
Distributed static generation uses GenerationCheckpoint when
settings.enable_checkpointing is enabled. See the
checkpoint and resume manual.
Persist completed chunks and recover an interrupted parquet append.
Attributes:
| Name | Type | Description |
|---|---|---|
root |
Output directory containing checkpoint.json and the datasets. |
|
state |
Last successfully published checkpoint. |
Source code in gridfm_datakit/checkpoint.py
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 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 | |
__init__(root, state)
¶Bind a validated checkpoint to its output directory.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
root
|
Path
|
Generation output directory. |
required |
state
|
_CheckpointState
|
Validated saved progress and file manifest. |
required |
Source code in gridfm_datakit/checkpoint.py
89 90 91 92 93 94 95 96 97 | |
commit(next_chunk)
¶Advance only after all dataset writes for a large chunk succeeded.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
next_chunk
|
int
|
Index of the first large chunk not yet saved. |
required |
Source code in gridfm_datakit/checkpoint.py
223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 | |
create(root, config, seed)
classmethod
¶Persist a fresh seed before any scenarios are generated.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
root
|
Path
|
Empty output directory prepared by generation setup. |
required |
config
|
dict[str, Any]
|
Validated generation configuration. |
required |
seed
|
int
|
Effective random seed for this run. |
required |
Returns:
| Type | Description |
|---|---|
GenerationCheckpoint
|
Newly published checkpoint with no completed chunks. |
Source code in gridfm_datakit/checkpoint.py
176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 | |
load(root, config)
classmethod
¶Check resume eligibility before existing logs or output are changed.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
root
|
Path
|
Generation output directory. |
required |
config
|
dict[str, Any]
|
Validated requested configuration. |
required |
Returns:
| Type | Description |
|---|---|
Optional[GenerationCheckpoint]
|
Existing checkpoint, or None for a fresh run or ordinary append. |
Raises:
| Type | Description |
|---|---|
ValueError
|
If settings, checkpoint state, or committed files disagree. |
Source code in gridfm_datakit/checkpoint.py
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 173 174 | |
recover()
¶Remove uncommitted output files and restore the committed sample count.
Source code in gridfm_datakit/checkpoint.py
217 218 219 220 221 | |