Skip to content
  • API documentation
  • careamics
  • lightning
  • dataset_ng
  • callbacks
  • prediction_writer
  • write_strategy

write_strategy

Module containing different strategies for writing predictions.

WriteStrategy #

Bases: Protocol

Protocol for write strategy classes.

Source code in src/careamics/lightning/dataset_ng/callbacks/prediction_writer/write_strategy.py 
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
class WriteStrategy(Protocol):
    """Protocol for write strategy classes."""

    def write_batch(
        self,
        dirpath: Path,
        predictions: list[ImageRegionData],
    ) -> None:
        """
        WriteStrategy subclasses must contain this function to write a batch.

        Parameters
        ----------
        dirpath : Path
            Path to directory to save predictions to.
        predictions : list[ImageRegionData]
            Decollated predictions.
        """
        ...

write_batch(dirpath, predictions) #

WriteStrategy subclasses must contain this function to write a batch.

Parameters:

Name Type Description Default
dirpath Path

Path to directory to save predictions to.

 required
predictions list[ImageRegionData]

Decollated predictions.

 required
Source code in src/careamics/lightning/dataset_ng/callbacks/prediction_writer/write_strategy.py 
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
def write_batch(
    self,
    dirpath: Path,
    predictions: list[ImageRegionData],
) -> None:
    """
    WriteStrategy subclasses must contain this function to write a batch.

    Parameters
    ----------
    dirpath : Path
        Path to directory to save predictions to.
    predictions : list[ImageRegionData]
        Decollated predictions.
    """
    ...