mirror of
https://github.com/deepset-ai/haystack.git
synced 2026-01-29 11:04:43 +00:00
90894491cf
* Update documentation and remove unused assets. Enhanced the 'agents' and 'components' sections with clearer descriptions and examples. Removed obsolete images and updated links for better navigation. Adjusted formatting for consistency across various documentation pages. * remove dependency * address comments * delete more empty pages * broken link * unduplicate headings * alphabetical components nav
90 lines
3.0 KiB
Plaintext
90 lines
3.0 KiB
Plaintext
---
|
|
title: "Visualizing Pipelines"
|
|
id: visualizing-pipelines
|
|
slug: "/visualizing-pipelines"
|
|
description: "You can visualize your pipelines as graphs to better understand how the components are connected."
|
|
---
|
|
|
|
import ClickableImage from "@site/src/components/ClickableImage";
|
|
|
|
# Visualizing Pipelines
|
|
|
|
You can visualize your pipelines as graphs to better understand how the components are connected.
|
|
|
|
Haystack pipelines have `draw()` and `show()` methods that enable you to visualize the pipeline as a graph using Mermaid graphs.
|
|
|
|
:::info
|
|
Data Privacy Notice
|
|
|
|
Exercise caution with sensitive data when using pipeline visualization.
|
|
|
|
This feature is based on Mermaid graphs web service that doesn't have clear terms of data retention or privacy policy.
|
|
:::
|
|
|
|
## Prerequisites
|
|
|
|
To use Mermaid graphs, you must have an internet connection to reach the Mermaid graph renderer at https://mermaid.ink.
|
|
|
|
## Displaying a Graph
|
|
|
|
Use the pipeline's `show()` method to display the diagram in Jupyter notebooks.
|
|
|
|
```python
|
|
|
|
```
|
|
|
|
## Saving a Graph
|
|
|
|
Use the pipeline's `draw()` method passing the path where you want to save the diagram and the diagram format. Possible formats are: `mermaid-text` and `mermaid-image` (default).
|
|
|
|
```python
|
|
my_pipeline.draw(path=local_path)
|
|
```
|
|
|
|
## Visualizing SuperComponents
|
|
|
|
To show the internal structure of [SuperComponents](../components/supercomponents.mdx) in your digram instead of a black box component, set the `super_component_expansion` parameter to `True`:
|
|
|
|
```python
|
|
my_pipeline.show(super_component_expansion=True)
|
|
|
|
## or
|
|
|
|
my_pipeline.draw(path=local_path,
|
|
super_component_expansion=True)
|
|
```
|
|
|
|
## Visualizing Locally
|
|
|
|
If you don't have an internet connection or don't want to send your pipeline data to the remote https://mermaid.ink, you can install a local mermaid.ink server and use it to render your pipeline.
|
|
|
|
Let's run a local mermaid.ink server using their official Docker images from https://github.com/jihchi/mermaid.ink/pkgs/container/mermaid.ink.
|
|
|
|
In this case, let's install one for a system running a MacOS M3 chip and expose it on port 3000:
|
|
|
|
```dockerfile
|
|
docker run --platform linux/amd64 --publish 3000:3000 --cap-add=SYS_ADMIN ghcr.io/jihchi/mermaid.ink
|
|
```
|
|
|
|
Check that the local mermaid.ink server is running by going to http://localhost:3000/.
|
|
|
|
You should see a local server running, and now you can simply render the image using your local mermaid.ink server by specifying the URL when calling the`show()`or `draw()` method:
|
|
|
|
```python
|
|
my_pipeline.show(server_url="http://localhost:3000")
|
|
## or
|
|
my_pipeline.draw("my_pipeline.png", server_url="http://localhost:3000")
|
|
```
|
|
|
|
## Example
|
|
|
|
This is an example of what a pipeline graph may look like:
|
|
<ClickableImage src="/img/46a8989-Untitled.png" alt="" />
|
|
|
|
<br />
|
|
|
|
## Importing a Pipeline to deepset Studio
|
|
|
|
YYou can import your Haystack pipeline into deepset Studio and continue visually building your pipeline
|
|
|
|
To do that, follow the steps described in our deepset AI Platform [documentation](https://docs.cloud.deepset.ai/docs/import-a-pipeline#import-your-pipeline). |