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.

Sign up for GitHub

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

Jump to bottom

[Docs] Add PlotOutputs example to VizroAi docs #599

Merged
merged 5 commits into from
Jul 29, 2024
Merged

[Docs] Add PlotOutputs example to VizroAi docs #599

merged 5 commits into from
Jul 29, 2024

Conversation

nadijagraca
Copy link
Contributor

Description

VizroAI.plot() method returns PlotOutputs data class once return_elements=True. Added the example illustrating that to the docs.

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.

@nadijagraca nadijagraca temporarily deployed to circleci_secrets July 25, 2024 11:26 — with GitHub Actions Inactive
@nadijagraca nadijagraca temporarily deployed to vizro_ai_secrets July 25, 2024 11:26 — with GitHub Actions Inactive
@nadijagraca nadijagraca temporarily deployed to vizro_ai_secrets July 25, 2024 11:26 — with GitHub Actions Inactive
@nadijagraca nadijagraca temporarily deployed to vizro_ai_secrets July 25, 2024 11:26 — with GitHub Actions Inactive
@nadijagraca nadijagraca temporarily deployed to vizro_ai_secrets July 25, 2024 11:26 — with GitHub Actions Inactive
@nadijagraca nadijagraca temporarily deployed to vizro_ai_secrets July 25, 2024 11:26 — with GitHub Actions Inactive
@github-actions github-actions bot added the Vizro-AI 🤖 Issue/PR that addresses Vizro-AI package label Jul 25, 2024
@nadijagraca nadijagraca self-assigned this Jul 25, 2024
@nadijagraca nadijagraca added the Docs 🗒️ Issue for markdown and API documentation label Jul 25, 2024
lingyielia
lingyielia approved these changes Jul 25, 2024
View reviewed changes
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.

Thank you addressing this! Approved with one comment

vizro-ai/docs/pages/user-guides/run-vizro-ai.md Outdated Show resolved Hide resolved
stichbury
stichbury approved these changes Jul 25, 2024
View reviewed changes
Copy link
Contributor

@stichbury stichbury left a comment

Choose a reason for hiding this comment

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

LGTM! 🌟

maxschulz-COL
maxschulz-COL approved these changes Jul 26, 2024
View reviewed changes
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.

Looks good! Just a few small suggestions, thanks! 🙏

vizro-ai/docs/pages/user-guides/run-vizro-ai.md Outdated Show resolved Hide resolved
vizro-ai/docs/pages/user-guides/run-vizro-ai.md Outdated Show resolved Hide resolved
vizro-ai/docs/pages/user-guides/run-vizro-ai.md Outdated Show resolved Hide resolved
vizro-ai/docs/pages/user-guides/run-vizro-ai.md Outdated Show resolved Hide resolved
@nadijagraca nadijagraca merged commit 5648d24 into main Jul 29, 2024
37 checks passed
@nadijagraca nadijagraca deleted the docs/vizroai_update_docs branch July 29, 2024 09:54
nadijagraca added a commit that referenced this pull request Aug 1, 2024
@nadijagraca
[Docs] Add PlotOutputs example to VizroAi docs (#599)
282e55d
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@maxschulz-COL maxschulz-COL maxschulz-COL approved these changes

@lingyielia lingyielia lingyielia approved these changes

@stichbury stichbury stichbury approved these changes

@Joseph-Perkins Joseph-Perkins Awaiting requested review from Joseph-Perkins Joseph-Perkins is a code owner

@antonymilne antonymilne Awaiting requested review from antonymilne antonymilne is a code owner

@huong-li-nguyen huong-li-nguyen Awaiting requested review from huong-li-nguyen huong-li-nguyen is a code owner

@Anna-Xiong Anna-Xiong Awaiting requested review from Anna-Xiong

Assignees

@nadijagraca nadijagraca

Labels
Docs 🗒️ Issue for markdown and API documentation Vizro-AI 🤖 Issue/PR that addresses Vizro-AI package
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@nadijagraca @stichbury @lingyielia @maxschulz-COL