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.

Sign up for GitHub

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): add pipeline job placholders for scheduled runs #8447

Merged
merged 3 commits into from
Nov 23, 2022
Merged

feat(sdk): add pipeline job placholders for scheduled runs #8447

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
62e3a52
add pipeline job placeholders
connor-mccarthy Nov 14, 2022
2d092fc
simplify example code in docs
connor-mccarthy Nov 14, 2022
4757567
add _PLACEHOLDER suffix to variable names
connor-mccarthy Nov 14, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 34 additions & 7 deletions sdk/python/kfp/dsl/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@
Example:
::

@dsl.pipeline(name='my-pipeline')
@dsl.pipeline
def my_pipeline():
print_op(
msg='Job name:',
Expand All @@ -100,7 +100,7 @@ def my_pipeline():
Example:
::

@dsl.pipeline(name='my-pipeline')
@dsl.pipeline
def my_pipeline():
print_op(
msg='Job resource name:',
Expand All @@ -114,7 +114,7 @@ def my_pipeline():
Example:
::

@dsl.pipeline(name='my-pipeline')
@dsl.pipeline
def my_pipeline():
print_op(
msg='Job ID:',
Expand All @@ -128,7 +128,7 @@ def my_pipeline():
Example:
::

@dsl.pipeline(name='my-pipeline')
@dsl.pipeline
def my_pipeline():
print_op(
msg='Task name:',
Expand All @@ -142,13 +142,40 @@ def my_pipeline():
Example:
::

@dsl.pipeline(name='my-pipeline')
@dsl.pipeline
def my_pipeline():
print_op(
msg='Task ID:',
value=dsl.PIPELINE_TASK_ID_PLACEHOLDER,
)
"""
PIPELINE_JOB_CREATE_TIME_UTC_PLACEHOLDER = '{{$.pipeline_job_create_time_utc}}'
"""A placeholder used to obtain the time that a pipeline job was created.

Example:
::

@dsl.pipeline
def my_pipeline():
print_op(
msg='Job created at:',
value=dsl.PIPELINE_JOB_CREATE_TIME_UTC,
)
"""
PIPELINE_JOB_SCHEDULE_TIME_UTC_PLACEHOLDER = '{{$.pipeline_job_schedule_time_utc}}'
"""A placeholder used to obtain the time for which a pipeline job is scheduled.

Example:
::

@dsl.pipeline
def my_pipeline():
print_op(
msg='Job scheduled at:',
value=dsl.PIPELINE_JOB_SCHEDULE_TIME_UTC,
)
"""

T = TypeVar('T')
Input = Annotated[T, InputAnnotation]
"""Type generic used to represent an input artifact of type ``T``, where ``T`` is an artifact class.
Expand All @@ -170,7 +197,7 @@ def artifact_producer(model: Output[Artifact]):
def artifact_consumer(model: Input[Artifact]):
print(model)

@dsl.pipeline(name='my-pipeline')
@dsl.pipeline
def my_pipeline():
producer_task = artifact_producer()
artifact_consumer(model=producer_task.output)
Expand All @@ -196,7 +223,7 @@ def artifact_producer(model: Output[Artifact]):
def artifact_consumer(model: Input[Artifact]):
print(model)

@dsl.pipeline(name='my-pipeline')
@dsl.pipeline
def my_pipeline():
producer_task = artifact_producer()
artifact_consumer(model=producer_task.output)
Expand Down