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

Jump to bottom

Fix overriding of loader_args task resolver in papermill plugin #2660

Merged
merged 3 commits into from
Aug 8, 2024
Merged

Fix overriding of loader_args task resolver in papermill plugin #2660

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
88178a7
Add repro test case
eapolinario Aug 7, 2024
ec80a58
Restore loader_args in papermill plugin
eapolinario Aug 7, 2024
f25c2b5
Add unit tests
eapolinario Aug 7, 2024
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
10 changes: 8 additions & 2 deletions plugins/flytekit-papermill/flytekitplugins/papermill/task.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -202,15 +202,21 @@ def get_container(self, settings: SerializationSettings) -> task_models.Containe
# Always extract the module from the notebook task, no matter what _config_task_instance is.
_, m, t, _ = extract_task_module(self)
loader_args = ["task-module", m, "task-name", t]
previous_loader_args = self._config_task_instance.task_resolver.loader_args
self._config_task_instance.task_resolver.loader_args = lambda ss, task: loader_args
return self._config_task_instance.get_container(settings)
container = self._config_task_instance.get_container(settings)
self._config_task_instance.task_resolver.loader_args = previous_loader_args
return container

def get_k8s_pod(self, settings: SerializationSettings) -> task_models.K8sPod:
# Always extract the module from the notebook task, no matter what _config_task_instance is.
_, m, t, _ = extract_task_module(self)
loader_args = ["task-module", m, "task-name", t]
previous_loader_args = self._config_task_instance.task_resolver.loader_args
self._config_task_instance.task_resolver.loader_args = lambda ss, task: loader_args
return self._config_task_instance.get_k8s_pod(settings)
k8s_pod = self._config_task_instance.get_k8s_pod(settings)
self._config_task_instance.task_resolver.loader_args = previous_loader_args
return k8s_pod

def get_config(self, settings: SerializationSettings) -> typing.Dict[str, str]:
return {**super().get_config(settings), **self._config_task_instance.get_config(settings)}
Expand Down
178 changes: 172 additions & 6 deletions plugins/flytekit-papermill/tests/test_task.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,10 @@
import tempfile
import typing
from unittest import mock
import pytest

import pandas as pd
from flytekit.core.pod_template import PodTemplate
from click.testing import CliRunner
from flytekitplugins.awsbatch import AWSBatchConfig
from flytekitplugins.papermill import NotebookTask
Expand Down Expand Up @@ -147,16 +149,27 @@ def generate_por_spec_for_task():
return pod_spec


nb = NotebookTask(
nb_pod = NotebookTask(
name="test",
task_config=Pod(pod_spec=generate_por_spec_for_task(), primary_container_name="primary"),
notebook_path=_get_nb_path("nb-simple", abs=False),
inputs=kwtypes(h=str, n=int, w=str),
outputs=kwtypes(h=str, w=PythonNotebook, x=X),
)
nb_pod_template = NotebookTask(
name="test",
pod_template=PodTemplate(pod_spec=generate_por_spec_for_task(), primary_container_name="primary"),
notebook_path=_get_nb_path("nb-simple", abs=False),
inputs=kwtypes(h=str, n=int, w=str),
outputs=kwtypes(h=str, w=PythonNotebook, x=X),
)


def test_notebook_pod_task():
@pytest.mark.parametrize("nb_task", [
nb_pod,
nb_pod_template,
])
def test_notebook_pod_task(nb_task):
serialization_settings = flytekit.configuration.SerializationSettings(
project="project",
domain="domain",
Expand All @@ -165,13 +178,93 @@ def test_notebook_pod_task():
image_config=ImageConfig(Image(name="name", fqn="image", tag="name")),
)

assert nb.get_container(serialization_settings) is None
assert nb.get_config(serialization_settings)["primary_container_name"] == "primary"
assert nb_task.get_container(serialization_settings) is None
assert nb_task.get_config(serialization_settings)["primary_container_name"] == "primary"
assert (
nb.get_command(serialization_settings)
== nb.get_k8s_pod(serialization_settings).pod_spec["containers"][0]["args"]
nb_task.get_command(serialization_settings)
== nb_task.get_k8s_pod(serialization_settings).pod_spec["containers"][0]["args"]
)


@pytest.mark.parametrize("nb_task, name", [
(nb_pod, "nb_pod"),
(nb_pod_template, "nb_pod_template"),
])
def test_notebook_pod_override(nb_task, name):
serialization_settings = flytekit.configuration.SerializationSettings(
project="project",
domain="domain",
version="version",
env=None,
image_config=ImageConfig(Image(name="name", fqn="image", tag="name")),
)

@task
def t1():
...

assert t1.get_container(serialization_settings).args == [
"pyflyte-execute",
"--inputs",
"{{.input}}",
"--output-prefix",
"{{.outputPrefix}}",
"--raw-output-data-prefix",
"{{.rawOutputDataPrefix}}",
"--checkpoint-path",
"{{.checkpointOutputPrefix}}",
"--prev-checkpoint",
"{{.prevCheckpointPrefix}}",
"--resolver",
"flytekit.core.python_auto_container.default_task_resolver",
"--",
"task-module",
"tests.test_task",
"task-name",
"t1",
]
assert nb_task.get_k8s_pod(serialization_settings).pod_spec["containers"][0]["args"] == [
"pyflyte-execute",
"--inputs",
"{{.input}}",
"--output-prefix",
"{{.outputPrefix}}",
"--raw-output-data-prefix",
"{{.rawOutputDataPrefix}}",
"--checkpoint-path",
"{{.checkpointOutputPrefix}}",
"--prev-checkpoint",
"{{.prevCheckpointPrefix}}",
"--resolver",
"flytekit.core.python_auto_container.default_task_resolver",
"--",
"task-module",
"tests.test_task",
"task-name",
f"{name}",
]
assert t1.get_container(serialization_settings).args == [
"pyflyte-execute",
"--inputs",
"{{.input}}",
"--output-prefix",
"{{.outputPrefix}}",
"--raw-output-data-prefix",
"{{.rawOutputDataPrefix}}",
"--checkpoint-path",
"{{.checkpointOutputPrefix}}",
"--prev-checkpoint",
"{{.prevCheckpointPrefix}}",
"--resolver",
"flytekit.core.python_auto_container.default_task_resolver",
"--",
"task-module",
"tests.test_task",
"task-name",
# Confirm that task name is correctly pointing to t1
"t1",
]


nb_batch = NotebookTask(
name="simple-nb",
Expand Down Expand Up @@ -210,6 +303,79 @@ def test_notebook_batch_task():
]


def test_overriding_task_resolver_loader_args():
serialization_settings = flytekit.configuration.SerializationSettings(
project="project",
domain="domain",
version="version",
env=None,
image_config=ImageConfig(Image(name="name", fqn="image", tag="name")),
)

@task
def t1():
...

assert t1.get_container(serialization_settings).args == [
"pyflyte-execute",
"--inputs",
"{{.input}}",
"--output-prefix",
"{{.outputPrefix}}",
"--raw-output-data-prefix",
"{{.rawOutputDataPrefix}}",
"--checkpoint-path",
"{{.checkpointOutputPrefix}}",
"--prev-checkpoint",
"{{.prevCheckpointPrefix}}",
"--resolver",
"flytekit.core.python_auto_container.default_task_resolver",
"--",
"task-module",
"tests.test_task",
"task-name",
"t1",
]
assert nb_batch.get_container(serialization_settings).args == [
"pyflyte-execute",
"--inputs",
"{{.input}}",
"--output-prefix",
"{{.outputPrefix}}/0",
"--raw-output-data-prefix",
"{{.rawOutputDataPrefix}}",
"--resolver",
"flytekit.core.python_auto_container.default_task_resolver",
"--",
"task-module",
"tests.test_task",
"task-name",
"nb_batch",
]
assert t1.get_container(serialization_settings).args == [
"pyflyte-execute",
"--inputs",
"{{.input}}",
"--output-prefix",
"{{.outputPrefix}}",
"--raw-output-data-prefix",
"{{.rawOutputDataPrefix}}",
"--checkpoint-path",
"{{.checkpointOutputPrefix}}",
"--prev-checkpoint",
"{{.prevCheckpointPrefix}}",
"--resolver",
"flytekit.core.python_auto_container.default_task_resolver",
"--",
"task-module",
"tests.test_task",
"task-name",
# Confirm that task name is correctly pointing to t1
"t1",
]



def test_flyte_types():
@task
def create_file() -> FlyteFile:
Expand Down
Loading