# evidently.pipeline

## Submodules

## column\_mapping module <a href="#module-evidently.pipeline.column_mapping" id="module-evidently.pipeline.column_mapping"></a>

### class ColumnMapping(target: Optional\[str] = 'target', prediction: Union\[str, int, Sequence\[str], Sequence\[int], NoneType] = 'prediction', datetime: Optional\[str] = 'datetime', id: Optional\[str] = None, numerical\_features: Optional\[List\[str]] = None, categorical\_features: Optional\[List\[str]] = None, datetime\_features: Optional\[List\[str]] = None, target\_names: Optional\[List\[str]] = None, task: Optional\[str] = None, pos\_label: Union\[str, int, NoneType] = 1)

Bases: `object`

#### Attributes:

&#x20;    **categorical\_features : Optional\[List\[str]] = None**

&#x20;    **datetime : Optional\[str] = 'datetime'**

&#x20;    **datetime\_features : Optional\[List\[str]] = None**

&#x20;    **id : Optional\[str] = None**

&#x20;    **numerical\_features : Optional\[List\[str]] = None**

&#x20;    **pos\_label : Optional\[Union\[str, int]] = 1**

&#x20;    **prediction : Optional\[Union\[str, int, Sequence\[str], Sequence\[int]]] = 'prediction'**

&#x20;    **target : Optional\[str] = 'target'**

&#x20;    **target\_names : Optional\[List\[str]] = None**

&#x20;    **task : Optional\[str] = None**

#### Methods:

&#x20;    **is\_classification\_task()**

&#x20;    **is\_regression\_task()**

### class TaskType()

Bases: `object`

#### Attributes:

&#x20;    **CLASSIFICATION\_TASK : str = 'classification'**

&#x20;    **REGRESSION\_TASK : str = 'regression'**

## pipeline module <a href="#module-evidently.pipeline.pipeline" id="module-evidently.pipeline.pipeline"></a>

### class Pipeline(stages: Sequence\[PipelineStage], options: list)

Bases: `object`

#### Attributes:

&#x20;    **analyzers\_results : Dict\[Type\[Analyzer], object]**

&#x20;    **options\_provider :** [**OptionsProvider**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.options#evidently.options.OptionsProvider)

&#x20;    **stages : Sequence\[PipelineStage]**

#### Methods:

&#x20;    **execute(reference\_data: DataFrame, current\_data: Optional\[DataFrame] = None, column\_mapping: Optional\[ColumnMapping] = None)**

&#x20;    **get\_analyzers()**

## stage module <a href="#module-evidently.pipeline.stage" id="module-evidently.pipeline.stage"></a>

### class PipelineStage()

Bases: `object`

#### Attributes:

&#x20;    **options\_provider :** [**OptionsProvider**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.options#evidently.options.OptionsProvider)

#### Methods:

&#x20;    **add\_analyzer(analyzer\_type: Type\[Analyzer])**

&#x20;    **analyzers()**

&#x20;    **abstract calculate(reference\_data: DataFrame, current\_data: DataFrame, column\_mapping: ColumnMapping, analyzers\_results: Dict\[Type\[Analyzer], Any])**