Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Docs] Revise Vizro-AI docs for dashboard generation pages #596

Merged
merged 22 commits into from
Aug 6, 2024
Merged
Changes from 1 commit
Commits
Show all changes
22 commits
Select commit Hold shift + click to select a range
a8ee655
Some changes to tidy up Vizro-AI docs ahead of dashboard updates
stichbury Jul 24, 2024
8a70907
Update customize-vizro-ai.md
stichbury Jul 24, 2024
1de8cb3
Create 20240724_120604_jo_stichbury_revise_vizroai_docset.md
stichbury Jul 24, 2024
b010aee
Merge branch 'main' into docs/revise-vizroai-docset
stichbury Jul 26, 2024
887c17c
[Docs] First version of dashboard docs (#601)
lingyielia Jul 26, 2024
267bb02
Update from feedback
stichbury Jul 26, 2024
b7c727e
Integrate dashboard generation
stichbury Jul 31, 2024
6c6efc1
Few more changes
stichbury Jul 31, 2024
f500a17
Few more updates
stichbury Jul 31, 2024
0a4fce1
Lint and changelog
stichbury Jul 31, 2024
2c43c04
Merge branch 'main' into docs/revise-vizroai-docset
stichbury Jul 31, 2024
d10ee9e
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Jul 31, 2024
9752aa7
Further changes
stichbury Jul 31, 2024
fcb1b5d
Merge branch 'docs/revise-vizroai-docset' of https://github.com/mckin…
stichbury Jul 31, 2024
e31e350
Update vizro-ai/docs/index.md
stichbury Aug 1, 2024
43f1213
Updates from feedback
stichbury Aug 1, 2024
6439861
Merge branch 'docs/revise-vizroai-docset' of https://github.com/mckin…
stichbury Aug 1, 2024
af2401f
Merge branch 'main' into docs/revise-vizroai-docset
stichbury Aug 1, 2024
8035067
Update vizro-ai/docs/pages/user-guides/customize-vizro-ai.md
stichbury Aug 2, 2024
a838dcb
Merge branch 'main' of github.com:mckinsey/vizro into docs/revise-viz…
lingyielia Aug 2, 2024
4582b8f
update dashboard related docs
lingyielia Aug 3, 2024
5a575e0
Merge branch 'main' into docs/revise-vizroai-docset
stichbury Aug 6, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Update from feedback
stichbury committed Jul 26, 2024
commit 267bb029328b702b1a7e8e2c5da8629793f87430
7 changes: 1 addition & 6 deletions vizro-ai/docs/pages/tutorials/quickstart-dashboard.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,6 @@
# How to generate a Vizro dashboard using Vizro-AI

Vizro-AI now supports text-to-dashboard functionality. It can generate a multi-page dashboard including the following features:

- Vizro components including Graph, AgGrid (basic), and Card
- Vizro Filters including Dropdown, Checklist, Dropdown, RadioItems, RangeSlider, Slider, DatePicker(in development)
- Vizro Layout
- Multi-dataframe and multi-page support
Vizro-AI supports text-to-dashboard functionality, enabling you to generate a multi-page dashboard.

## Setup
Install Vizro-AI
15 changes: 4 additions & 11 deletions vizro-ai/docs/pages/user-guides/dashboard-iterate-and-deploy.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,11 @@
# How to update and reuse the Vizro-AI generated dashboard

This guide shows how to further use the Vizro-AI generated dashboard.
This guide shows you how to refine a Vizro-AI generated dashboard.

While Vizro-AI can follow complex user requirements well and generate high-quality dashboards, due to the nature of LLMs, the generated dashboards often approximately match user expectations but may not be exact. Besides refining the user prompt and rerunning Vizro-AI, you can also extract the code and iterate manually to achieve the desired result.

## Setup
```py
%pip install vizro_ai

from vizro import Vizro
from vizro_ai import VizroAI

vizro_ai = VizroAI()
```
<!-- TO DO -->
<!-- Write how to set up as per tutorial and use the prompt below to generate a dashboard -->
<!-- you get the dashboard object, which you can a) render like xxx, b) modify like xx c) xxx alternatively you can return elements, which gives you access to a) code b) dashboard object -->

## Prepare the data and user prompt
```py