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): expose IfPresentPlaceholder and ConcatPlaceholder to kfp.dsl #8145

Merged

Conversation

zichuan-scott-xu
Copy link
Contributor

Description of your changes:
This PR exposes IfPresentPlaceholder and ConcatPlaceholder to kfp.dsl and add examples to show how they could be used to author containerized components.

Checklist:

@google-oss-prow
Copy link

Hi @zichuan-scott-xu. Thanks for your PR.

I'm waiting for a kubeflow member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

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.

@zichuan-scott-xu zichuan-scott-xu changed the title expose IfPresentPlaceholder and ConcatPlaceholder to kfp.dsl feat(sdk): expose IfPresentPlaceholder and ConcatPlaceholder to kfp.dsl Aug 15, 2022
@zichuan-scott-xu zichuan-scott-xu changed the title feat(sdk): expose IfPresentPlaceholder and ConcatPlaceholder to kfp.dsl feat(sdk): Expose IfPresentPlaceholder and ConcatPlaceholder to kfp.dsl Aug 15, 2022
@zichuan-scott-xu zichuan-scott-xu changed the title feat(sdk): Expose IfPresentPlaceholder and ConcatPlaceholder to kfp.dsl feat(sdk): expose IfPresentPlaceholder and ConcatPlaceholder to kfp.dsl Aug 15, 2022
Copy link
Member

@connor-mccarthy connor-mccarthy left a comment

Choose a reason for hiding this comment

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

@zichuan-scott-xu, this looks really good. I'm curious if we can find a way to improve the way children of BaseModel are documented by our reference docs so that only the official user-facing methods and attributes are documented. Currently, methods like split_cel_concat_string and to_placeholder_string are getting documented. We don't want to promise the stability of anything other than the constructor API if we can help it. Plus, these helper methods add clutter to the docs.

Currently we use Sphinx automodule to automatically document the .dsl module. The source .rst file that specifies how to do this is here.

If you cd docs then run make clean html, then open _build/html/index.html, you can build and inspect the docs from source.

An easy approach to handling this would be to use an _ prefix to make the method hidden, but this involves changing quite a bit of code, down to the BaseModel methods. This is fine if we want to go this route, but I'm curious what you think and if there are any other approaches you like more.

@connor-mccarthy
Copy link
Member

/ok-to-test

@connor-mccarthy
Copy link
Member

Let's handle this documentation change in a separate PR.

/lgtm
/approve

@google-oss-prow
Copy link

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: connor-mccarthy

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

@zichuan-scott-xu
Copy link
Contributor Author

/retest

2 similar comments
@zichuan-scott-xu
Copy link
Contributor Author

/retest

@zichuan-scott-xu
Copy link
Contributor Author

/retest

@google-oss-prow google-oss-prow bot merged commit c7a90a3 into kubeflow:master Aug 15, 2022
jlyaoyuli pushed a commit to jlyaoyuli/pipelines that referenced this pull request Jan 5, 2023
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