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

Open
wants to merge 51 commits into
base: main
Choose a base branch
from

Conversation

stichbury
Copy link
Contributor

@stichbury stichbury commented Jan 15, 2025

Description

Now ready for review

Page in question is here: https://vizro--955.org.readthedocs.build/projects/vizro-ai/en/955/pages/tutorials/project-tutorial/

Please review the built docs ⬆️ rather than the markdown as you'll find it melts your head.

Couple of questions, probably for @huong-li-nguyen or @antonymilne :

  • Where should I store the Notebook associated with this project? I have currently linked to it stored on my repo, but ideally this should not be linked to my account. Can I drop the .pynb into the Vizro repo, and if so, shall I keep it with the docs markdown or in the examples subfolder?
  • Similarly, where shall I store the data for this project? It's currently in the docs folder alongside the markdown but this isn't maybe idea.
  • Finally, a question on the final version for @huong-li-nguyen -- I'm not happy with the filter for this project. I should probably walk you through it...maybe after standup or in a short call. Will DM you about it.

Still to do:

  • Final read through and copy edit
  • Apply Vale
  • Update links to use agreed location for data storage rather than my repo. Ditto notebook.
  • Convert this (separately) to a post for Medium publication. It'll need a top and tail about what Vizro is etc.

Screenshot

Notice

  • I acknowledge and agree that, by checking this box and clicking "Submit Pull Request":

    • I submit this contribution under the Apache 2.0 license and represent that I am entitled to do so on behalf of myself, my employer, or relevant third parties, as applicable.
    • I certify that (a) this contribution is my original creation and / or (b) to the extent it is not my original creation, I am authorized to submit this contribution on behalf of the original creator(s) or their licensees.
    • I certify that the use of this contribution as authorized by the Apache 2.0 license does not violate the intellectual property rights of anyone else.
    • I have not referenced individuals, products or companies in any commits, directly or indirectly.
    • I have not added data or restricted code in any commits, directly or indirectly.

@stichbury stichbury added the Docs 🗒️ Issue for markdown and API documentation label Jan 15, 2025
@stichbury stichbury self-assigned this Jan 15, 2025
@stichbury stichbury changed the title [Docs] Add new Vizro-AI tutorial for Goodreads dataset [Docs] [DRAFT] Add new Vizro-AI tutorial for Goodreads dataset Jan 15, 2025
@github-actions github-actions bot added the Vizro-AI 🤖 Issue/PR that addresses Vizro-AI package label Jan 15, 2025
@stichbury stichbury changed the title [Docs] [DRAFT] Add new Vizro-AI tutorial for Goodreads dataset [Docs] Add new Vizro-AI tutorial for Goodreads dataset Jan 15, 2025
@petar-qb petar-qb removed their request for review January 15, 2025 20:37
Copy link
Contributor

@lingyielia lingyielia left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for writing this tutorial based on real data! 💯📚 It's probably much more challenging than dealing with toy datasets. I really like how this tutorial managed to cover so many things: vizro-ai plot and dashboard, UI for chart, and PyCafe. 😆

My questions are mostly around those 3 charts we decided to plot. Curious to see whether it's possible to create charts with richer information revealed, which can help us understand the past reading history.

vizro-ai/docs/pages/tutorials/project-tutorial.md Outdated Show resolved Hide resolved
vizro-ai/docs/pages/tutorials/project-tutorial.md Outdated Show resolved Hide resolved
vizro-ai/docs/pages/tutorials/project-tutorial.md Outdated Show resolved Hide resolved
vizro-ai/docs/pages/tutorials/project-tutorial.md Outdated Show resolved Hide resolved
vizro-ai/docs/pages/tutorials/project-tutorial.md Outdated Show resolved Hide resolved
Copy link
Contributor

@maxschulz-COL maxschulz-COL left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this is a great tutorial - well done! I enjoyed reading it, and it really shows the value of VizroAI if you ask me :)

vizro-ai/docs/pages/tutorials/project-tutorial.md Outdated Show resolved Hide resolved
vizro-ai/docs/pages/tutorials/project-tutorial.md Outdated Show resolved Hide resolved
vizro-ai/docs/pages/tutorials/project-tutorial.md Outdated Show resolved Hide resolved
vizro-ai/docs/pages/tutorials/project-tutorial.md Outdated Show resolved Hide resolved
vizro-ai/docs/pages/tutorials/project-tutorial.md Outdated Show resolved Hide resolved
Copy link
Contributor

github-actions bot commented Jan 16, 2025

View the example dashboards of the current commit live on PyCafe ☕ 🚀

Updated on: 2025-01-23 11:15:24 UTC
Commit: 313a989

Link: vizro-core/examples/dev/

Link: vizro-core/examples/scratch_dev

Link: vizro-core/examples/visual-vocabulary/

Link: vizro-ai/examples/dashboard_ui/

@stichbury stichbury requested a review from lingyielia January 16, 2025 18:05
Copy link
Contributor

@lingyielia lingyielia left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! 📖

@stichbury
Copy link
Contributor Author

I won't merge this until Towards Data Science have seen and decided whether to publish so it is "exclusive content" when they review it (and when it is merged and published on stable, I'll add a canonical tag from TDS->our docs to ensure we get the SEO credit).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Docs 🗒️ Issue for markdown and API documentation Vizro-AI 🤖 Issue/PR that addresses Vizro-AI package
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants