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

Add vertex runner #429

Merged
merged 4 commits into from
Sep 15, 2023
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
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
2 changes: 1 addition & 1 deletion .github/workflows/pipeline.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ jobs:
runs-on: ubuntu-latest
strategy:
matrix:
python-version: ['3.8', '3.9', '3.10', '3.11']
python-version: ['3.8', '3.9', '3.10']
steps:
- uses: actions/checkout@v2
- name: Set up Python ${{ matrix.python-version }}
Expand Down
5 changes: 3 additions & 2 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ classifiers = [
]

[tool.poetry.dependencies]
python = ">= 3.8 < 3.12"
python = ">= 3.8 < 3.11"
dask = {extras = ["dataframe"], version = ">= 2023.4.1"}
importlib-resources = { version = ">= 1.3", python = "<3.9" }
jsonschema = ">= 4.18"
Expand All @@ -53,13 +53,14 @@ s3fs = { version = ">= 2023.4.0", optional = true }
adlfs = { version = ">= 2023.4.0", optional = true }
kfp = { version = "2.0.1", optional = true }
pandas = { version = ">= 1.3.5", optional = true }
google-cloud-aiplatform = { version = "1.32.0", optional = true}

[tool.poetry.extras]
aws = ["fsspec", "s3fs"]
azure = ["fsspec", "adlfs"]
gcp = ["fsspec", "gcsfs"]
kfp = ["kfp"]
vertex = ["kfp"]
vertex = ["kfp", "google-cloud-aiplatform"]

[tool.poetry.group.test.dependencies]
pre-commit = "^3.1.1"
Expand Down
33 changes: 33 additions & 0 deletions src/fondant/runner.py
Original file line number Diff line number Diff line change
Expand Up @@ -85,3 +85,36 @@ def get_name_from_spec(self, input_spec: str):
with open(input_spec) as f:
spec = yaml.safe_load(f)
return spec["pipelineInfo"]["name"]


class VertexRunner(Runner):
def __resolve_imports(self):
import google.cloud.aiplatform as aip

self.aip = aip

def __init__(self, project_id: str, project_region: str, service_account: str = ""):
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
def __init__(self, project_id: str, project_region: str, service_account: str = ""):
def __init__(self, project_id: str, project_region: str, service_account: t.Optional[str]=None):

https://github.com/googleapis/python-aiplatform/blob/0fa47aea08b635159e9c6dc64f7d330f047dfb5d/google/cloud/aiplatform/preview/jobs.py#L232

self.__resolve_imports()

self.aip.init(
project=project_id,
location=project_region,
)
self.service_account = service_account

def run(self, input_spec: str, *args, **kwargs):
job = self.aip.PipelineJob(
display_name=self.get_name_from_spec(input_spec),
template_path=input_spec,
enable_caching=False,
)
if self.service_account:
job.submit(service_account=self.service_account)
else:
job.submit()
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
if self.service_account:
job.submit(service_account=self.service_account)
else:
job.submit()
job.submit(service_account=self.service_account)

with the above suggestion, since the service account defined in submit() can be optional

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

updated


def get_name_from_spec(self, input_spec: str):
"""Get the name of the pipeline from the spec."""
with open(input_spec) as f:
spec = yaml.safe_load(f)
return spec["pipelineInfo"]["name"]
19 changes: 18 additions & 1 deletion tests/test_runner.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
from unittest import mock

import pytest
from fondant.runner import DockerRunner, KubeflowRunner
from fondant.runner import DockerRunner, KubeflowRunner, VertexRunner

VALID_PIPELINE = Path("./tests/example_pipelines/compiled_pipeline/")

Expand Down Expand Up @@ -79,3 +79,20 @@ def test_kfp_import():
sys.modules["kfp"] = None
with pytest.raises(ImportError):
_ = KubeflowRunner(host="some_host")


def test_vertex_runner():
input_spec_path = str(VALID_PIPELINE / "kubeflow_pipeline.yml")
with mock.patch("google.cloud.aiplatform.init", return_value=None), mock.patch(
"google.cloud.aiplatform.PipelineJob",
):
runner = VertexRunner(project_id="some_project", project_region="some_region")
runner.run(input_spec=input_spec_path)

# test with service account
runner2 = VertexRunner(
project_id="some_project",
project_region="some_region",
service_account="some_account",
)
runner2.run(input_spec=input_spec_path)