EngineABCRunParams¶
- class EngineABCRunParams[source]¶
Parameters for configuring the
EngineABC.run()method.- Optional Keys:
- auto_get_mask (bool):
Whether to automatically generate segmentation masks using wsireader.tissue_mask() during processing.
- batch_size (int):
Number of image patches per forward pass.
- class_dict (dict):
Mapping of classification outputs to class names.
- device (str):
Device to run the model on (e.g., “cpu”, “cuda”). See https://pytorch.org/docs/stable/tensor_attributes.html#torch.device for more details.
- labels (list):
Optional labels for input images. Only a single label per image is supported.
- memory_threshold (int):
Memory usage threshold (in percentage) to trigger caching behavior.
- num_workers (int):
Number of workers for DataLoader and post-processing.
- output_file (str):
Filename for saving output (e.g., “zarr” or “annotationstore”).
- return_labels (bool):
Whether to return labels with predictions.
- scale_factor (tuple[float, float]):
Scale factor for annotations (model_mpp / slide_mpp). Used to convert coordinates from non-baseline to baseline resolution.
- stride_shape (IntPair):
Stride used during WSI processing, at requested read resolution. Must be positive. Defaults to patch_input_shape if not provided.
- verbose (bool):
Whether to enable verbose logging.
Methods
Attributes
auto_get_maskbatch_sizeclass_dictdevicelabelsmemory_thresholdnum_workersoutput_filereturn_labelsscale_factorstride_shapeverbose