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] Add new Vizro-AI tutorial for Goodreads dataset #955

Merged
merged 60 commits into from
Feb 4, 2025
Merged
Changes from 1 commit
Commits
Show all changes
60 commits
Select commit Hold shift + click to select a range
5227931
First chunk
stichbury Jan 15, 2025
ddba624
Second chunk: add notebook
stichbury Jan 15, 2025
cc85686
Update settings to add pycafe to Vizro-AI docs
stichbury Jan 15, 2025
6a1402c
Update project-tutorial.md
stichbury Jan 15, 2025
edd91c4
Merge branch 'main' into docs/add-vizroai-tutorial
stichbury Jan 15, 2025
d18ef29
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Jan 15, 2025
7e3b650
Merge branch 'main' into docs/add-vizroai-tutorial
stichbury Jan 15, 2025
6e5929a
Update project-tutorial.md
stichbury Jan 15, 2025
9c8849e
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Jan 15, 2025
e4fe788
Update project-tutorial.md
stichbury Jan 15, 2025
e0a4317
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Jan 15, 2025
02bd48e
Update project-tutorial.md
stichbury Jan 15, 2025
b15c8fb
Update project-tutorial.md
stichbury Jan 15, 2025
c4912a0
Update project-tutorial.md
stichbury Jan 15, 2025
37a104c
Update vizro-ai/docs/pages/tutorials/project-tutorial.md
stichbury Jan 16, 2025
54934ee
Update vizro-ai/docs/pages/tutorials/project-tutorial.md
stichbury Jan 16, 2025
4acd120
Merge branch 'main' into docs/add-vizroai-tutorial
stichbury Jan 16, 2025
9374244
Put prompts in copyable blocks of text
stichbury Jan 16, 2025
d831213
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Jan 16, 2025
f225c79
Few copy edit improvements
stichbury Jan 16, 2025
3d1e7f6
Merge branch 'docs/add-vizroai-tutorial' of https://github.com/mckins…
stichbury Jan 16, 2025
1797c0a
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Jan 16, 2025
21b2b5a
Linting
stichbury Jan 16, 2025
cb48c00
Merge branch 'docs/add-vizroai-tutorial' of https://github.com/mckins…
stichbury Jan 16, 2025
4e4996c
Change rules of repo for data files
stichbury Jan 16, 2025
834c8d9
Add Goodreads project and data to examples
stichbury Jan 16, 2025
c846698
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Jan 16, 2025
2e33e0f
Pass precommit
stichbury Jan 16, 2025
fd2fe3d
Minor tweaks to data/notebook
stichbury Jan 16, 2025
174202b
Update project-tutorial.md
stichbury Jan 16, 2025
13b4b5c
Merge branch 'docs/add-vizroai-tutorial' of https://github.com/mckins…
stichbury Jan 16, 2025
5ea2d7e
Update .pre-commit-config.yaml
stichbury Jan 16, 2025
5291fdb
Update for control
stichbury Jan 16, 2025
8776cfc
Update project-tutorial.md
stichbury Jan 16, 2025
5278e33
Update the controls
stichbury Jan 16, 2025
5cfd0f9
Rename markdown file
stichbury Jan 16, 2025
1239b7a
Update mkdocs.yml
stichbury Jan 16, 2025
1bacbdd
Merge branch 'main' into docs/add-vizroai-tutorial
stichbury Jan 16, 2025
4338889
Update .pre-commit-config.yaml
stichbury Jan 20, 2025
31b8b09
Merge branch 'docs/add-vizroai-tutorial' of https://github.com/mckins…
stichbury Jan 20, 2025
934aeb2
Merge branch 'main' into docs/add-vizroai-tutorial
stichbury Jan 20, 2025
dee27c3
Update goodreads-tutorial.md
stichbury Jan 20, 2025
a6af91d
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Jan 20, 2025
4050a1c
Merge branch 'main' into docs/add-vizroai-tutorial
stichbury Jan 20, 2025
29aaa6a
Merge branch 'main' into docs/add-vizroai-tutorial
stichbury Jan 21, 2025
5520d22
Add extrahead for google site verification
stichbury Jan 23, 2025
d9e607a
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Jan 23, 2025
5a32a49
Merge branch 'main' into docs/add-vizroai-tutorial
stichbury Jan 23, 2025
ff19b31
Reverting commit on wrong branch
stichbury Jan 23, 2025
0080159
Merge branch 'docs/add-vizroai-tutorial' of https://github.com/mckins…
stichbury Jan 23, 2025
313a989
Reverting commit on wrong branch
stichbury Jan 23, 2025
d2a7c42
Merge branch 'main' into docs/add-vizroai-tutorial
stichbury Feb 3, 2025
c7ac504
Add canonical tag
stichbury Feb 4, 2025
d239ff5
Update goodreads-tutorial.md
stichbury Feb 4, 2025
b4c26d6
Create check_for_datafiles.py
stichbury Feb 4, 2025
e3e9b1c
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Feb 4, 2025
145ff3c
Merge branch 'main' into docs/add-vizroai-tutorial
stichbury Feb 4, 2025
8ed6027
Update canonical_tag.py
stichbury Feb 4, 2025
330d125
Merge branch 'main' into docs/add-vizroai-tutorial
stichbury Feb 4, 2025
d0c25e1
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Feb 4, 2025
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 project-tutorial.md
stichbury committed Jan 16, 2025
commit 8776cfc76580ac7e719c32f4c44d2162d278aaee
3 changes: 2 additions & 1 deletion vizro-ai/docs/pages/tutorials/project-tutorial.md
Original file line number Diff line number Diff line change
@@ -242,7 +242,7 @@ To make the Vizro dashboards more interactive, we can ask Vizro-AI to add the co
It is a scatter chart. Use the x axis to show the date a book was read. Plot it at y=1.

+ Add a date picker filter so the user can adjust the range of dates for the Date Read on the x axis.

On the second page, plot a chart with the title "Pages and Book totals" .
It shows the cumulative total number of pages read by summing the Number of Pages of each book read in each year, using the Date Read data.
Plot date on the x axis and the number of pages on the y axis using a scale on the left hand side of the chart.
@@ -259,6 +259,7 @@ To make the Vizro dashboards more interactive, we can ask Vizro-AI to add the co
```

### Get the Notebook

You can see the code output in the [Notebook stored on the Vizro GitHub repository](https://raw.githubusercontent.com/mckinsey/vizro/834c8d9c198420e8b315c0dc045b7aa12534719d/vizro-ai/examples/goodreads_tutorial/goodreads.ipynb), and generate similar output by running it yourself, although it will not necessarily be identical because of the variability of restuls returned from generative AI.

The charts generated were similar to those created by the PyCafe host above, although the first chart was improved by spacing the books proportionate to the date read and the hover text included the book title as well as the date read, without an explicit request to do so.