Skip to content

Commit

Permalink
[pre-commit.ci] auto fixes from pre-commit.com hooks
Browse files Browse the repository at this point in the history
for more information, see https://pre-commit.ci
  • Loading branch information
pre-commit-ci[bot] committed Nov 18, 2024
1 parent ca17a90 commit da78a81
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 6 deletions.
2 changes: 1 addition & 1 deletion vizro-ai/docs/pages/user-guides/create-advanced-charts.md
Original file line number Diff line number Diff line change
Expand Up @@ -137,4 +137,4 @@ Let's explore how to generate a 3-dimensional surface plot with VizroAI.
fig.show()
```

[VizroAIChart3]: ../../assets/user_guides/surface_plot.gif
[VizroAIChart3]: ../../assets/user_guides/surface_plot.gif
10 changes: 5 additions & 5 deletions vizro-ai/docs/pages/user-guides/run-vizro-ai-dashboard.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# How to run Vizro-AI dashboard

This guide offers insights into different ways of running `VizroAI.dashboard` to generate Vizro dashboard.
This guide offers insights into different ways of running `VizroAI.dashboard` to generate Vizro dashboard.

??? note "Note: API key"

Make sure you have followed the [LLM setup guide](../user-guides/install.md#set-up-access-to-a-large-language-model) and thatyour api key is set up in a `.env` file in the same folder as your Notebook file (`.ipynb`).

## Run Vizro-AI dashboard
## Run Vizro-AI dashboard

### 1. Prepare the data and user prompt
```py
Expand Down Expand Up @@ -73,11 +73,11 @@ This triggers the dashboard building process. Once Vizro-AI finishes the dashboa

## Retrieve the Python code of the dashboard

To illustrate the process, lets re-use the example provided above.
To illustrate the process, lets re-use the example provided above.

Like the `VizroAI.plot` method, in order to produce more comprehensive output we need to set `return_elements=True`. `return_elements` is a boolean (by default `False`) which determines the return type of `VizroAI.dashboard`.
Like the `VizroAI.plot` method, in order to produce more comprehensive output we need to set `return_elements=True`. `return_elements` is a boolean (by default `False`) which determines the return type of `VizroAI.dashboard`.

- If set to `False` it produces a `Vizro` dashboard object.
- If set to `False` it produces a `Vizro` dashboard object.
- If set to `True`, it returns a class (a Pydantic model) containing both the dashboard object and the code string used to generate it.

!!! example "View dashboard code"
Expand Down

0 comments on commit da78a81

Please sign in to comment.