src/sammie/py/ModuleConnector.py
def runAggregator(self, aggregatorID: str, destinationPath:str, data:SessionData, modulesById:Dict[str, ModuleBase], batchNum:int, adtlParams:Dict = None) -> AggregatorReturn:
        """
        An aggregator function will append data from a pipeline to a file provided by user.
        See PipelineAggregatorOutput datatype on js side.
        Args:
            aggregatorID (str): ID for this function, usually the function name. It is provided by JS as the aggregatorID field in PipelineAggregatorOutput datatype.
            destinationPath (str): Path of the file to write to
            data (SessionData): SessionData containing current pipeline state
            modulesById (Dict[str,ModuleBase]): Dictionary containing active module instances in the pipeline. Sometimes an aggregator need to communicate with the module directly, to get more than just the pipelinedata in SessionData.
            batchNum (int): The index of the batch this data is coming from. This is used so that if the same batch is run multiple times, the aggregator can overwrite previous outputs, rather than appending them to the file.
            adtlParams (Dict): Additional parameters passed to the exporter by JS. These are static parameters defined in the pipeline (See PipelineAggregatorOutpur.exporterParams in JS) merged with with the parameters for the batch (see Pipeline.inputParameters in JS).

        Returns:
            An AggregatorReturn, instance containing info on the aggregation and new file info after aggregation.

        """
        pass

        An aggregator function will append data from a pipeline to a file provided by user.
        See PipelineAggregatorOutput datatype on js side.
        Args:
            aggregatorID (str): ID for this function, usually the function name. It is provided by JS as the aggregatorID field in PipelineAggregatorOutput datatype.
            destinationPath (str): Path of the file to write to
            data (SessionData): SessionData containing current pipeline state
            modulesById (Dict[str,ModuleBase]): Dictionary containing active module instances in the pipeline. Sometimes an aggregator need to communicate with the module directly, to get more than just the pipelinedata in SessionData.
            batchNum (int): The index of the batch this data is coming from. This is used so that if the same batch is run multiple times, the aggregator can overwrite previous outputs, rather than appending them to the file.
            adtlParams (Dict): Additional parameters passed to the exporter by JS. These are static parameters defined in the pipeline (See PipelineAggregatorOutpur.exporterParams in JS) merged with with the parameters for the batch (see Pipeline.inputParameters in JS).

        Returns:
            An AggregatorReturn, instance containing info on the aggregation and new file info after aggregation.

        
An aggregator function will append data from a pipeline to a file provided by user.
See PipelineAggregatorOutput datatype on js side.
An aggregator function will append data from a pipeline to a file provided by user . See PipelineAggregatorOutput datatype on js side .
def runAggregator(self, aggregatorID: str, destinationPath:str, data:SessionData, modulesById:Dict[str, ModuleBase], batchNum:int, adtlParams:Dict = None) -> AggregatorReturn:
        pass
def runAggregator ( self , aggregatorID : str , destinationPath : str , data : SessionData , modulesById : Dict [ str , ModuleBase ] , batchNum : int , adtlParams : Dict = None ) -> AggregatorReturn : pass
An aggregator function will append data from a pipeline to a file provided by user.
An aggregator function will append data from a pipeline to a file provided by user .
"""
        An aggregator function will append data from a pipeline to a file provided by user.
        See PipelineAggregatorOutput datatype on js side.
        Args:
            aggregatorID (str): ID for this function, usually the function name. It is provided by JS as the aggregatorID field in PipelineAggregatorOutput datatype.
            destinationPath (str): Path of the file to write to
            data (SessionData): SessionData containing current pipeline state
            modulesById (Dict[str,ModuleBase]): Dictionary containing active module instances in the pipeline. Sometimes an aggregator need to communicate with the module directly, to get more than just the pipelinedata in SessionData.
            batchNum (int): The index of the batch this data is coming from. This is used so that if the same batch is run multiple times, the aggregator can overwrite previous outputs, rather than appending them to the file.
            adtlParams (Dict): Additional parameters passed to the exporter by JS. These are static parameters defined in the pipeline (See PipelineAggregatorOutpur.exporterParams in JS) merged with with the parameters for the batch (see Pipeline.inputParameters in JS).

        Returns:
            An AggregatorReturn, instance containing info on the aggregation and new file info after aggregation.

        """
An AggregatorReturn, instance containing info on the aggregation and new file info after aggregation.
An AggregatorReturn instance containing info on the aggregation and new file info after aggregation .
self
aggregatorID
str
ID for this function, usually the function name. It is provided by JS as the aggregatorID field in PipelineAggregatorOutput datatype.
ID for this function usually the function name . It is provided by JS as the aggregatorID field in PipelineAggregatorOutput datatype .
destinationPath
str
Path of the file to write to
Path of the file to write to
data
SessionData
SessionData containing current pipeline state
SessionData containing current pipeline state
modulesById
Dict[str, ModuleBase]
Dictionary containing active module instances in the pipeline. Sometimes an aggregator need to communicate with the module directly, to get more than just the pipelinedata in SessionData.
Dictionary containing active module instances in the pipeline . Sometimes an aggregator need to communicate with the module directly to get more than just the pipelinedata in SessionData .
batchNum
int
The index of the batch this data is coming from. This is used so that if the same batch is run multiple times, the aggregator can overwrite previous outputs, rather than appending them to the file.
The index of the batch this data is coming from . This is used so that if the same batch is run multiple times the aggregator can overwrite previous outputs rather than appending them to the file .
adtlParams
Dict
Additional parameters passed to the exporter by JS. These are static parameters defined in the pipeline (See PipelineAggregatorOutpur.exporterParams in JS) merged with with the parameters for the batch .
Additional parameters passed to the exporter by JS . These are static parameters defined in the pipeline ( See PipelineAggregatorOutpur . exporterParams in JS ) merged with with the parameters for the batch .