NetworkView
flyvision.network.directories.NetworkDir ¶
Bases: Directory
Directory for a network.
Written to by the solver.
Name | Type | Description |
---|---|---|
loss |
ArrayFile
|
Loss values over iterations. |
activity |
ArrayFile
|
Mean activity values over iterations. |
activity_min |
ArrayFile
|
Minimum activity values over iterations. |
activity_max |
ArrayFile
|
Maximum activity values over iterations. |
loss_<task> |
ArrayFile
|
Loss values for each specific task over iterations. |
chkpt_index |
ArrayFile
|
Numerical identifiers of checkpoints. |
chkpt_iter |
ArrayFile
|
Iterations at which checkpoints were recorded. |
best_chkpt_index |
ArrayFile
|
Checkpoint index with minimal validation loss. |
dt |
ArrayFile
|
Current time constant of the dataset. |
time_trained |
ArrayFile
|
Total time spent training. |
Written by NetworkView.
Name | Type | Description |
---|---|---|
__cache__ |
Directory
|
joblib cache. |
Source code in flyvision/network/directories.py
18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 |
|
flyvision.network.network_view.NetworkView ¶
IO interface for network.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
network_dir |
Union[str, PathLike, NetworkDir]
|
Directory of the network. |
required |
network_class |
Module
|
Network class. Defaults to Network. |
Network
|
root_dir |
PathLike
|
Root directory. Defaults to flyvision.results_dir. |
results_dir
|
connectome_getter |
Callable
|
Function to get the connectome. Defaults to flyvision_connectome. |
get_avgfilt_connectome
|
checkpoint_mapper |
Callable
|
Function to map checkpoints. Defaults to resolve_checkpoints. |
resolve_checkpoints
|
best_checkpoint_fn |
Callable
|
Function to get the best checkpoint. Defaults to best_checkpoint_default_fn. |
best_checkpoint_default_fn
|
best_checkpoint_fn_kwargs |
dict
|
Keyword arguments for best_checkpoint_fn. Defaults to {“validation_subdir”: “validation”, “loss_file_name”: “loss”}. |
{'validation_subdir': 'validation', 'loss_file_name': 'loss'}
|
recover_fn |
Callable
|
Function to recover the network. Defaults to recover_network. |
recover_network
|
Attributes:
Name | Type | Description |
---|---|---|
network_class |
Module
|
Network class. |
dir |
Directory
|
Network directory. |
name |
str
|
Network name. |
root_dir |
PathLike
|
Root directory. |
connectome_getter |
Callable
|
Function to get the connectome. |
checkpoint_mapper |
Callable
|
Function to map checkpoints. |
connectome_view |
ConnectomeView
|
Connectome view. |
connectome |
Directory
|
Connectome directory. |
checkpoints |
Mapped checkpoints. |
|
memory |
Memory
|
Joblib memory cache. |
best_checkpoint_fn |
Callable
|
Function to get the best checkpoint. |
best_checkpoint_fn_kwargs |
dict
|
Keyword arguments for best_checkpoint_fn. |
recover_fn |
Callable
|
Function to recover the network. |
_network |
CheckpointedNetwork
|
Checkpointed network instance. |
decoder |
Decoder instance. |
|
_initialized |
dict
|
Initialization status for network and decoder. |
cache |
FIFOCache
|
Cache for storing results. |
Source code in flyvision/network/network_view.py
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 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 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 |
|
get_checkpoint ¶
get_checkpoint(checkpoint='best')
Return the best checkpoint index.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
checkpoint |
Checkpoint identifier. Defaults to “best”. |
'best'
|
Returns:
Name | Type | Description |
---|---|---|
str |
Path to the checkpoint. |
Source code in flyvision/network/network_view.py
229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 |
|
network ¶
network(checkpoint='best', network=None, lazy=False)
Lazy loading of network instance.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
checkpoint |
Checkpoint identifier. Defaults to “best”. |
'best'
|
|
network |
Optional[Any]
|
Existing network instance to use. Defaults to None. |
None
|
lazy |
If True, don’t recover the network immediately. Defaults to False. |
False
|
Returns:
Name | Type | Description |
---|---|---|
CheckpointedNetwork |
CheckpointedNetwork
|
Checkpointed network instance. |
Source code in flyvision/network/network_view.py
249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 |
|
init_network ¶
init_network(checkpoint='best', network=None)
Initialize the network.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
checkpoint |
Checkpoint identifier. Defaults to “best”. |
'best'
|
|
network |
Optional[Any]
|
Existing network instance to use. Defaults to None. |
None
|
Returns:
Name | Type | Description |
---|---|---|
Network |
Network
|
Initialized network instance. |
Source code in flyvision/network/network_view.py
274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 |
|
init_decoder ¶
init_decoder(checkpoint='best', decoder=None)
Initialize the decoder.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
checkpoint |
Checkpoint identifier. Defaults to “best”. |
'best'
|
|
decoder |
Existing decoder instance to use. Defaults to None. |
None
|
Returns:
Name | Type | Description |
---|---|---|
Decoder |
Initialized decoder instance. |
Source code in flyvision/network/network_view.py
291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 |
|
flash_responses ¶
flash_responses(*args, **kwargs)
Generate flash responses.
Source code in flyvision/network/network_view.py
337 338 339 340 341 |
|
moving_edge_responses ¶
moving_edge_responses(*args, **kwargs)
Generate moving edge responses.
Source code in flyvision/network/network_view.py
343 344 345 346 347 |
|
moving_edge_currents ¶
moving_edge_currents(*args, **kwargs)
Generate moving edge currents.
Source code in flyvision/network/network_view.py
349 350 351 352 353 354 355 |
|
moving_bar_responses ¶
moving_bar_responses(*args, **kwargs)
Generate moving bar responses.
Source code in flyvision/network/network_view.py
357 358 359 360 361 |
|
naturalistic_stimuli_responses ¶
naturalistic_stimuli_responses(*args, **kwargs)
Generate naturalistic stimuli responses.
Source code in flyvision/network/network_view.py
363 364 365 366 367 |
|
central_impulses_responses ¶
central_impulses_responses(*args, **kwargs)
Generate central ommatidium impulses responses.
Source code in flyvision/network/network_view.py
369 370 371 372 373 |
|
spatial_impulses_responses ¶
spatial_impulses_responses(*args, **kwargs)
Generate spatial ommatidium impulses responses.
Source code in flyvision/network/network_view.py
375 376 377 378 379 |
|
optimal_stimulus_responses ¶
optimal_stimulus_responses(cell_type, *args, **kwargs)
Generate optimal stimuli responses.
Source code in flyvision/network/network_view.py
381 382 383 384 385 386 387 388 389 |
|
flyvision.network.network_view.CheckpointedNetwork
dataclass
¶
A network representation with checkpoint that can be pickled.
Attributes:
Name | Type | Description |
---|---|---|
network_class |
Any
|
Network class (e.g., flyvision.Network). |
config |
Dict
|
Configuration for the network. |
name |
str
|
Name of the network. |
checkpoint |
PathLike
|
Checkpoint path. |
recover_fn |
Any
|
Function to recover the network. |
network |
Optional[Network]
|
Network instance to avoid reinitialization. |
Source code in flyvision/network/network_view.py
392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 |
|
init ¶
init(eval=True)
Initialize the network.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
eval |
bool
|
Whether to set the network in evaluation mode. |
True
|
Returns:
Type | Description |
---|---|
Network
|
The initialized network. |
Source code in flyvision/network/network_view.py
412 413 414 415 416 417 418 419 420 421 422 423 424 425 |
|
recover ¶
recover(checkpoint=None)
Recover the network from the checkpoint.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
checkpoint |
Optional[PathLike]
|
Path to the checkpoint. If None, uses the default checkpoint. |
None
|
Returns:
Type | Description |
---|---|
Network
|
The recovered network. |
Note
Initializes the network if it hasn’t been initialized yet.
Source code in flyvision/network/network_view.py
427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 |
|