From da78a8111d010c32aaffd6cbfd3e1ecece215954 Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Mon, 18 Nov 2024 16:30:12 +0000 Subject: [PATCH] [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --- .../docs/pages/user-guides/create-advanced-charts.md | 2 +- .../docs/pages/user-guides/run-vizro-ai-dashboard.md | 10 +++++----- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/vizro-ai/docs/pages/user-guides/create-advanced-charts.md b/vizro-ai/docs/pages/user-guides/create-advanced-charts.md index fc8c7cd15..15caa114e 100644 --- a/vizro-ai/docs/pages/user-guides/create-advanced-charts.md +++ b/vizro-ai/docs/pages/user-guides/create-advanced-charts.md @@ -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 \ No newline at end of file + [VizroAIChart3]: ../../assets/user_guides/surface_plot.gif diff --git a/vizro-ai/docs/pages/user-guides/run-vizro-ai-dashboard.md b/vizro-ai/docs/pages/user-guides/run-vizro-ai-dashboard.md index 979dc9950..99196438f 100644 --- a/vizro-ai/docs/pages/user-guides/run-vizro-ai-dashboard.md +++ b/vizro-ai/docs/pages/user-guides/run-vizro-ai-dashboard.md @@ -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 @@ -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"