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 Vizro-AI dashboard examples page #867

Closed
wants to merge 6 commits into from

Conversation

nadijagraca
Copy link
Contributor

Description

Add Vizro-AI dashboard examples page

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.

=== "Page2"
[![VizroAIDashboardPage2]][VizroAIDashboardPage2]

[VizroAIDashboardPage1]: ../../assets/user_guides/dashboard/dashboard1_page1.png
Copy link
Contributor

Choose a reason for hiding this comment

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

Where are these files? They're not part of the PR?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

This is already existing dashboard example, I just copied it to the dashboard examples as well. So the screenshot already exists.

@@ -0,0 +1,195 @@
# Gallery of examples
Copy link
Contributor

@stichbury stichbury Nov 12, 2024

Choose a reason for hiding this comment

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

I'm slightly worried about confusing the readers. For Vizro, we keep our gallery of examples separate from docs, linked from vizro.mckinsey.com.

Here for Vizro-AI, we are using the word "gallery" but keeping it here in docs and not linking out to anywhere. That's inconsisent. Also, it's not easy for people to try them (the gallery is just a few screenshots and some code that they need copy and paste).

I know it's harder with PyCafe etc because we need API keys but I wonder if we should have these examples on the mckinsey.vizro.com site (even if just with screenshots) and then link to PyCafe projects where people can add their own API key to try them out.

@maxschulz-COL WDYT?

Copy link
Contributor

Choose a reason for hiding this comment

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

Hmm you raise a very valid point, it is indeed inconsistent. And I am not sure what I would propose here.

Regarding your suggestion, I am not sure that this would flow nicely, where on vizro.mckinsey.com would this fit nicely 🤔 ?

Alternative but slightly contentious suggestion:

  • scrap the entire Examples section for a tab that says: Try out! (this would lead to vizro.mckinsey.com)
  • add the chart examples under Advanced charts (basically as a kind of user guide), each chart in its own category
  • combine Generate a complex dashboard and Retrieve code for a generated dashboard into a new Run vizro_ai.dashboard to match exactly what we have for charts, significantly reducing the repeat on the code generation page, which always annoyed me (this would make the two sections align), ideally using a very! simple dashboard prompt
  • add the more complex dashboard examples under a new page that mimics the Generate a complex dashboard one
  • (bonus) remove the component table on the home page (the one that says whats possible) and add it in the new Run vizro-ai.dashboard, where it really belongs
  • (bonus) Add a similarly awesome gif to the chart creation one for the dashboard creation on both the homepage and the README

Copy link
Contributor

Choose a reason for hiding this comment

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

I like this suggestion! Of course, I'm not the one doing the work, but I think it would be more useful for a reader. I think we need to put the effort into Vizro-AI in coming weeks to get it in front of as many people as we can, so yes, let's consider this as a better way forward. Sorry @nadijagraca it is a chunk more effort and I totally recognise what you've put together here already. If you want, we could drop this in for now and then roll it back when @maxschulz-COL's suggested approach is ready. But I think we should just push forward and do it without a temporary version (ie. close this PR without merging). Please can I leave you to consider which you want to do?

Copy link
Contributor

Choose a reason for hiding this comment

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

If you want a temporary solution, let me know and I'll do a light edit on the copy you've created.

Copy link
Contributor Author

@nadijagraca nadijagraca Nov 13, 2024

Choose a reason for hiding this comment

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

Thank you for your feedback. I also think its best if we do it the right (suggested) way, without the temporary version.
I will close this PR and start working on the suggested changes today.

@nadijagraca
Copy link
Contributor Author

As agreed in the comments, I will close this PR and start working on the suggested changes.

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

Successfully merging this pull request may close these issues.

3 participants