# evidently.suite
## Submodules
## base\_suite module
### class Context(execution\_graph: Optional\[ExecutionGraph], metrics: list, tests: list, metric\_results: dict, test\_results: dict, state: State, renderers: [RenderersDefinitions](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.renderers#evidently.renderers.base_renderer.RenderersDefinitions))
Bases: `object`
Pipeline execution context tracks pipeline execution and lifecycle
#### Attributes:
**execution\_graph : Optional\[ExecutionGraph]**
**metric\_results : dict**
**metrics : list**
**renderers :** [**RenderersDefinitions**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.renderers#evidently.renderers.base_renderer.RenderersDefinitions)
**state : State**
**test\_results : dict**
**tests : list**
### class Display(options: Optional\[list] = None)
Bases: `object`
#### Attributes:
**options\_provider :** [**OptionsProvider**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.options#evidently.options.OptionsProvider)
#### Methods:
**abstract as\_dict()**
**json()**
**save\_html(filename: str, mode: Union\[str, SaveMode] = SaveMode.SINGLE\_FILE)**
**save\_json(filename)**
**show(mode='auto')**
### exception ExecutionError()
Bases: `Exception`
### class State(name: str)
Bases: `object`
#### Attributes:
**name : str**
### class States()
Bases: `object`
#### Attributes:
**Calculated = State(name='Calculated')**
**Init = State(name='Init')**
**Tested = State(name='Tested')**
**Verified = State(name='Verified')**
### class Suite()
Bases: `object`
#### Attributes:
**context : Context**
#### Methods:
**add\_metric(metric:** [**Metric**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.metrics#evidently.metrics.base_metric.Metric)**)**
**add\_test(test:** [**Test**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.tests#evidently.tests.base_test.Test)**)**
**run\_calculate(data:** [**InputData**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.metrics#evidently.metrics.base_metric.InputData)**)**
**run\_checks()**
**verify()**
### find\_metric\_renderer(obj, renderers: [RenderersDefinitions](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.renderers#evidently.renderers.base_renderer.RenderersDefinitions))
### find\_test\_renderer(obj, renderers: [RenderersDefinitions](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.renderers#evidently.renderers.base_renderer.RenderersDefinitions))
## execution\_graph module
### class ExecutionGraph()
Bases: `object`
#### Methods:
**abstract get\_metric\_execution\_iterator()**
**abstract get\_test\_execution\_iterator()**
### class SimpleExecutionGraph(metrics: List\[[Metric](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.metrics#evidently.metrics.base_metric.Metric)], tests: List\[[Test](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.tests#evidently.tests.base_test.Test)])
Bases: `ExecutionGraph`
Simple execution graph without any work with dependencies at all,
assumes that metrics already in order for execution
#### Attributes:
**metrics : List\[**[**Metric**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.metrics#evidently.metrics.base_metric.Metric)**]**
**tests : List\[**[**Test**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.tests#evidently.tests.base_test.Test)**]**
#### Methods:
**get\_metric\_execution\_iterator()**
**get\_test\_execution\_iterator()**