Main API Reference

Note

This page contains the documentation of the main API, which is the API that is used to create a DALI pipeline from a set of available processing steps, as well as the API for the data loading and data provider classes.

It also contains the documentation for the base classes needed to implement custom processing steps.

However, it does not contain the documentation of some helpers which are used internally, and can be useful when implementing custom processing steps. For more details on those, see the Additional API Reference page.

accvlab.dali_pipeline_framework.inputs	This module contains classes for handling the input data to the DALI pipeline.
accvlab.dali_pipeline_framework.pipeline	This module contains the pipeline definition class as well as classes which are used to structure and manage the data inside the pipeline as well as the output of the pipeline.
accvlab.dali_pipeline_framework.processing_steps	This module contains the classes which represent individual processing steps as well as the respective base classes, which can be used to implement custom processing steps (see PipelineStepBase) as well as access modifier wrapper steps (see GroupToApplyToSelectedStepBase).

See also

While the API documentation describes the API of the package, there are some use-case dependent helpers which are not part of the API, but are implemented as part of the examples. While these helpers are designed for a specific use-case (e.g. data-set, training implementation etc.), they can be potentially useful for similar use-cases.

For the NuScenes data loader, which is used in the examples, see Data Loading for NuScenes.