Initialize datapipe#
initialize_datapipe
: This function that initializes and returns an instance of a data pipe class based on the specified ‘datapipe’ string and optional keyword arguments.- src.openCHA.datapipes.initialize_datapipe.initialize_datapipe(datapipe: str = DatapipeType.MEMORY, **kwargs: Any) DataPipe [source]
Initializes and returns an instance of a data pipe based on the specified ‘datapipe’ type.
- Parameters:
datapipe (str , optional) – A string specifying the type of data pipe to initialize (default is DatapipeType.MEMORY).
names. (Make sure you always use the DatapipeType enum and don't directly put the string) –
kwargs (Any) – Optional keyword arguments to be passed to the data pipe constructor.
- Returns:
An instance of the selected data pipe class.
- Return type:
- Raises:
ValueError – If the specified ‘datapipe’ type is not valid, with a message listing valid types.
Example
from openCHA.datapipes import DatapipeType memory = initialize_datapipe(datapipe=DatapipeType.MEMORY)