Add dynamic artifacts naming, documentation and tests

[avishniakov]

Describe changes

I implemented the dynamic artifacts naming for output artifacts to support the following use cases:

• Static naming (as it was before)
• Dynamic via placeholder - {time} and {date} are supported out of the box + any custom placeholder can be passed via name_subs

@step(name_subs={"my_time":"value"})
def ret_42()->Annotated[float,"dummy_{my_time}"]:
    return time.time()
    
@pipeline
def my_pipeline():
    ret_42()
    ret_42(name_subs={"my_time":"another_value"})()

The same applies to ArtifactConfig(name=...) pattern.

There are breaking changes for frontend since now the user can see something like this:

We talked with @Cahllagerfeld and I shared the solution to use:

• Output key from Deployment
• Map it with the original_name of the artifact inside PipelineRun outputs
  This is also backward compatible since all static artifacts will have original_name set to the name itself.

DO NOT MERGE BEFORE FE CHANGES ARE READY

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)

[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 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.

[htahir1]

Great!

[schustmi]

Do we want to reuse the date/time from the pipeline run here, same as we do with model version names? If it's even possible to pass this here, I'm not sure

[avishniakov]

Might be interesting. Maybe this can be set on a context level instead of pulling fresh each time.

[avishniakov]

I didn't implement this, but I can give it a shot if the PR is conceptually fine with you.

[schustmi]

I don't really get this, why would an artifact have an original name on top of the name it already has?

Isn't the only issue with this the dynamic naming of step outputs, but once we actually create the artifact there should only be one name?

[avishniakov]

When the artifact is created the name is already evaluated, so name_{date} would be name_20241122. The original_name is used to store the original template name_{date} and to be able to map it to the Run outputs on DAG and other places, since it will be the name in the Deployment and not the evaluated one.
Moreover original_name is only filled for dynamic names, while for static ones it will be null and filled in runtime with the name to keep responses consistent.