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

feat(sdk): support display_name and description in @dsl.pipeline decorator #9153

Merged

Conversation

connor-mccarthy
Copy link
Member

@connor-mccarthy connor-mccarthy commented Apr 13, 2023

Description of your changes:

The @dsl.pipeline decorator now accepts display_name and description arguments. These are compiled to IR YAML.

from kfp import dsl

@dsl.pipeline(
    display_name='Human readable name',
    description='My description. Decorator argument takes precedence over docstring',
)
def my_pipeline():
    """Will use docstring description when decorator description is not provided.
         In this case, description is provided to decorator is docstring is unused.
    """
    ...

Checklist:

@connor-mccarthy connor-mccarthy requested a review from chensun April 13, 2023 21:56
@google-oss-prow
Copy link

Skipping CI for Draft Pull Request.
If you want CI signal for your change, please convert it to an actual PR.
You can still manually trigger a test run with /test all

@google-oss-prow google-oss-prow bot requested review from IronPan and zijianjoy April 13, 2023 21:56
@connor-mccarthy connor-mccarthy force-pushed the support-compiling-metadata branch 2 times, most recently from e6dbbc6 to 1d54f69 Compare April 13, 2023 21:58
@connor-mccarthy connor-mccarthy changed the title feat(sdk): support display_name and description in @dsl.pipeline decorator feat(sdk): support display_name and description in @dsl.pipeline decorator Apr 13, 2023
@connor-mccarthy connor-mccarthy force-pushed the support-compiling-metadata branch from 1d54f69 to 7819ae3 Compare April 13, 2023 21:59
@connor-mccarthy
Copy link
Member Author

/assign @chensun

@connor-mccarthy connor-mccarthy marked this pull request as ready for review April 13, 2023 22:00
@connor-mccarthy connor-mccarthy changed the title feat(sdk): support display_name and description in @dsl.pipeline decorator feat(sdk): support display_name and description in @dsl.pipeline decorator Apr 14, 2023
@connor-mccarthy connor-mccarthy requested a review from chensun April 17, 2023 17:46
@google-oss-prow
Copy link

@connor-mccarthy: The following test failed, say /retest to rerun all failed tests or /retest-required to rerun all mandatory failed tests:

Test name Commit Details Required Rerun command
kubeflow-pipelines-sdk-execution-tests 01863b7 link true /test kubeflow-pipelines-sdk-execution-tests

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. I understand the commands that are listed here.

Copy link
Member

@chensun chensun left a comment

Choose a reason for hiding this comment

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

/lgtm
/approve

@google-oss-prow google-oss-prow bot added the lgtm label Apr 17, 2023
@google-oss-prow
Copy link

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: chensun

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@connor-mccarthy connor-mccarthy merged commit 91abbea into kubeflow:master Apr 17, 2023
rd-pong pushed a commit to rd-pong/pipelines that referenced this pull request Apr 26, 2023
…e` decorator (kubeflow#9153)

* feat(sdk): support display_name and description in @dsl.pipeline decorator

* add release note

* test additional case
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants