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

Log URL for pipelines and model versions when running a pipeline #2506

Merged
merged 24 commits into from
Mar 19, 2024

Conversation

wjayesh
Copy link
Contributor

@wjayesh wjayesh commented Mar 8, 2024

Describe changes

  • I implemented a get_model_version_url to construct the URL for a model version inside dashboard utils.
  • Updated the get_base_url function to use the URL from server configuration if it's set.
  • Log pipeline URL before it is run.

Pre-requisites

Please ensure you have done the following:

  • I have read the CONTRIBUTING.md document.
  • If my change requires a change to docs, I have updated the documentation accordingly.
  • I have added tests to cover my changes.
  • I have based my new branch on develop and the open PR is targeting develop. If your branch wasn't based on develop read Contribution guide on rebasing branch to develop.
  • If my changes require changes to the dashboard, these changes are communicated/requested.

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Other (add details above)

Copy link
Contributor

coderabbitai bot commented Mar 8, 2024

Important

Auto Review Skipped

Auto reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository.

To trigger a single review, invoke the @coderabbitai review command.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit-tests for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit tests for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit tests.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • The JSON schema for the configuration file is available here.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

@github-actions github-actions bot added internal To filter out internal PRs and issues enhancement New feature or request labels Mar 8, 2024
@wjayesh wjayesh requested a review from schustmi March 11, 2024 07:16
src/zenml/utils/dashboard_utils.py Outdated Show resolved Hide resolved
Copy link
Contributor

@avishniakov avishniakov left a comment

Choose a reason for hiding this comment

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

Smells like a circular dep, based on the CI output

@wjayesh
Copy link
Contributor Author

wjayesh commented Mar 13, 2024

Hmm, I can't seem to figure out why that's happening. Let me take a deeper look

Copy link
Contributor

Quickstart template updates in examples/quickstart have been pushed.

src/zenml/model/model.py Outdated Show resolved Hide resolved
src/zenml/new/pipelines/pipeline.py Show resolved Hide resolved
src/zenml/model/model.py Outdated Show resolved Hide resolved
src/zenml/model/model.py Outdated Show resolved Hide resolved
Copy link
Contributor

@avishniakov avishniakov left a comment

Choose a reason for hiding this comment

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

All good, one small suggestion.

src/zenml/new/pipelines/run_utils.py Outdated Show resolved Hide resolved
src/zenml/model/model.py Outdated Show resolved Hide resolved
@wjayesh wjayesh requested a review from schustmi March 19, 2024 03:33
Copy link
Contributor

@schustmi schustmi left a comment

Choose a reason for hiding this comment

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

LGTM, thanks for the adjustments!

@wjayesh wjayesh merged commit 332eab7 into develop Mar 19, 2024
54 of 56 checks passed
@wjayesh wjayesh deleted the feature/log-cloud-urls-pipeline-models branch March 19, 2024 07:35
adtygan pushed a commit to adtygan/zenml that referenced this pull request Mar 21, 2024
…ml-io#2506)

* add model url function and use config's base url

* attach model version URL with model creation log

* output url of pipeline in dashboard before deploying it

* only display model URL for cloud

* log model url for new and existing models

Co-authored-by: Andrei Vishniakov <[email protected]>

* don't add workspace in cloud url

* small embellishment

* attempt to fix circular import

* Auto-update of Starter template

* format files

* fix function arg type

* fix loading of config

* change where model URL is logged

* linting

* improve logging message and log non cloud case only once

* fix docstring

* make cloud check more robust

* move cloud functions to new cloud utils

* fix linter and docstring

---------

Co-authored-by: Andrei Vishniakov <[email protected]>
Co-authored-by: GitHub Actions <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request internal To filter out internal PRs and issues run-slow-ci
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants