Improve source root docs/logs when running a pipeline

[schustmi]

Describe changes

I implemented/fixed _ to achieve _.

Pre-requisites

Please ensure you have done the following:

• I have read the CONTRIBUTING.md document.
• 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.
• IMPORTANT: I made sure that my changes are reflected properly in the following resources:
  • ZenML Docs
  • Dashboard: Needs to be communicated to the frontend team.
  • Templates: Might need adjustments (that are not reflected in the template tests) in case of non-breaking changes and deprecations.
  • Projects: Depending on the version dependencies, different projects might get affected.

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)

[coderabbitai]

Important

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.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

---

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

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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>, please review it.
  • Generate unit testing code 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 testing code 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

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 using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[schustmi]

@stefannica I already added a log that tells users to check whether their source root is correct before uploading the code. Do you think we should have an additional warning that we print when the .zen directory is not the same as the implicit source root (the parent directory of the __main__ module file)? Or only if there are a certain number of directory levels between them?

[strickvl]

@schustmi I saw that thread and I was wondering whether we need to model / explain (at least very briefly) the existence / use of zenml init already in the starter guide on this page somewhere?

[schustmi]

@schustmi I saw that thread and I was wondering whether we need to model / explain (at least very briefly) the existence / use of zenml init already in the starter guide on this page somewhere?

@strickvl I'm not sure if that might be too early and complicated on this page. It's not really relevant for local runs anyway, and even in remote runs from a single file it's not really necessary as it should work as expected. Especially given that the user probably hasn't used ZenML before, and therefore doesn't have any orphan .zen directories on their machine. WDYT?

[strickvl]

@schustmi I saw that thread and I was wondering whether we need to model / explain (at least very briefly) the existence / use of zenml init already in the starter guide on this page somewhere?

@strickvl I'm not sure if that might be too early and complicated on this page. It's not really relevant for local runs anyway, and even in remote runs from a single file it's not really necessary as it should work as expected. Especially given that the user probably hasn't used ZenML before, and therefore doesn't have any orphan .zen directories on their machine. WDYT?

Yeah I wasn't even thinking to go into that detail. Just to say something simple like "oh and do a zenml init at the root of your repository... it might well save you some pain in the future" and then link out to the main place we talk about why this is a thing.

[schustmi]

@strickvl Added a small mention

[stefannica]

@stefannica I already added a log that tells users to check whether their source root is correct before uploading the code. Do you think we should have an additional warning that we print when the .zen directory is not the same as the implicit source root (the parent directory of the __main__ module file)? Or only if there are a certain number of directory levels between them?

I think what you did should be enough.