logging
Logging submodule.
The methods are responsible for the in-console logger.
ProgressBar
#
Keras style progress bar.
Adapted from https://github.com/yueyericardo/pkbar.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
max_value | Optional[int] | Maximum progress bar value, by default None. | None |
epoch | Optional[int] | Zero-indexed current epoch, by default None. | None |
num_epochs | Optional[int] | Total number of epochs, by default None. | None |
stateful_metrics | Optional[list] | Iterable of string names of metrics that should not be averaged over time. Metrics in this list will be displayed as-is. All others will be averaged by the progress bar before display, by default None. | None |
always_stateful | bool |
| False |
mode | str | Mode, one of "train", "val", or "predict", by default "train". | 'train' |
Source code in src/careamics/utils/logging.py
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 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 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 |
|
__init__(max_value=None, epoch=None, num_epochs=None, stateful_metrics=None, always_stateful=False, mode='train')
#
Constructor.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
max_value | Optional[int] | Maximum progress bar value, by default None. | None |
epoch | Optional[int] | Zero-indexed current epoch, by default None. | None |
num_epochs | Optional[int] | Total number of epochs, by default None. | None |
stateful_metrics | Optional[list] | Iterable of string names of metrics that should not be averaged over time. Metrics in this list will be displayed as-is. All others will be averaged by the progress bar before display, by default None. | None |
always_stateful | bool | Whether to set all metrics to be stateful, by default False. | False |
mode | str | Mode, one of "train", "val", or "predict", by default "train". | 'train' |
Source code in src/careamics/utils/logging.py
add(n, values=None)
#
Update the progress bar by n steps.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
n | int | Number of steps to increase the progress bar with. | required |
values | Optional[list] | Updated metrics values, by default None. | None |
Source code in src/careamics/utils/logging.py
spinning_cursor()
#
Generate a spinning cursor animation.
Taken from https://github.com/manrajgrover/py-spinners/tree/master.
Returns:
Type | Description |
---|---|
Generator | Generator of animation frames. |
Source code in src/careamics/utils/logging.py
update(current_step, batch_size=1, values=None)
#
Update the progress bar.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
current_step | int | Index of the current step. | required |
batch_size | int | Batch size, by default 1. | 1 |
values | Optional[list] | Updated metrics values, by default None. | None |
Source code in src/careamics/utils/logging.py
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 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 |
|
get_logger(name, log_level=logging.INFO, log_path=None)
#
Create a python logger instance with configured handlers.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
name | str | Name of the logger. | required |
log_level | int | Log level (info, error etc.), by default logging.INFO. | INFO |
log_path | Optional[Union[str, Path]] | Path in which to save the log, by default None. | None |
Returns:
Type | Description |
---|---|
Logger | Logger. |