Modal Step Operator #2948

strickvl · 2024-08-25T15:22:56Z

Seeking an earlyish review before I write the docs (in case anything major changes). This probably isn't the most elegant way of doing this, but it works at least. It supports both CPU and GPU-based workloads, and specifying CPU and memory for the instance on which the step will run.

See Demo tenant for the run details. Screenshot from Modal dashboard:

A simple dev pipeline to test this:

from pathlib import Path

import zenml
from zenml import pipeline, step
from zenml.config import DockerSettings
from zenml.integrations.modal.flavors.modal_step_operator_flavor import (
    ModalStepOperatorSettings,
)

zenml_git_root = Path(zenml.__file__).parents[2]

docker_settings = DockerSettings(
    dockerfile=str(zenml_git_root / "docker" / "zenml-dev.Dockerfile"),
    build_context_root=str(zenml_git_root),
    python_package_installer="uv",
)

modal_settings = ModalStepOperatorSettings(gpu="H100")


@step
def hello_world() -> int:
    print("Hello world!")
    return 3


@step(
    step_operator="modal",
    settings={"step_operator.modal": modal_settings},
)
def hello_world_on_modal(some_number: int) -> int:
    manipulated_number = some_number * 3
    print(f"Hello I'm inside a container! {manipulated_number}")
    return manipulated_number


@step
def final_step(some_manipulated_number: int) -> None:
    print(f"Final number: {some_manipulated_number}")


@pipeline(settings={"docker": docker_settings}, enable_cache=False)
def hello_world_pipeline():
    some_val = hello_world()
    manipulated_number = hello_world_on_modal(some_val)
    final_step(manipulated_number)


if __name__ == "__main__":
    hello_world_pipeline()

Remaining tasks

Write docs
Update integrations page

Summary by CodeRabbit

New Features
- Introduced Modal integration for ZenML, enabling cloud-native step execution.
- Added new modules and functionality related to modal operations.
- Enhanced configuration and operational settings for Modal step operators.
Bug Fixes
- Improved error handling for Docker credentials and Modal application exits.
Documentation
- Updated documentation to reflect new Modal integration capabilities.

coderabbitai · 2024-08-25T15:23:01Z

Important

Review skipped

Auto reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

📝 Walkthrough

Walkthrough

The changes introduce a new integration for the Modal platform within the ZenML framework. This includes the addition of several modules and classes that facilitate the configuration and execution of tasks on Modal's infrastructure. Key components include the ModalIntegration, constants for the integration, and specific step operators designed to interact with Modal's capabilities. The overall structure of the existing files is preserved while enhancing integration options.

Changes

Files	Change Summary
`docs/mocked_libs.json`	Added entries for `"modal"`, `"modal.cli"`, and `"modal.cli.run"` to the array of module imports.
`src/zenml/integrations/__init__.py`	Imported `ModalIntegration` from `zenml.integrations.modal`.
`src/zenml/integrations/constants.py`	Introduced a new constant `MODAL` with the value `"modal"`.
`src/zenml/integrations/modal/__init__.py`	Created `ModalIntegration` class for Modal integration, including flavors method.
`src/zenml/integrations/modal/flavors/__init__.py`	Introduced modal integration flavors and specified the public interface.
`src/zenml/integrations/modal/flavors/modal_step_operator_flavor.py`	Defined `ModalStepOperatorSettings`, `ModalStepOperatorConfig`, and `ModalStepOperatorFlavor` classes.
`src/zenml/integrations/modal/step_operators/__init__.py`	Created module for modal step operators, exposing `ModalStepOperator`.
`src/zenml/integrations/modal/step_operators/modal_step_operator.py`	Implemented `ModalStepOperator` class for executing steps on Modal.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant ZenML
    participant ModalIntegration
    participant Modal

    User->>ZenML: Initiates workflow with Modal integration
    ZenML->>ModalIntegration: Configures integration settings
    ModalIntegration->>Modal: Validates required settings
    Modal->>ZenML: Returns configuration status
    ZenML->>User: Workflow execution begins
    ZenML->>Modal: Launches step on Modal
    Modal-->>ZenML: Executes step and returns results
    ZenML->>User: Delivers results of the workflow

Poem

🐇 In the garden of code, a new path we tread,
With Modal's embrace, our workflows are spread.
Hopping through steps, with joy and delight,
Each task on the cloud, a marvelous sight!
So let’s dance with the data, in harmony play,
For the magic of Modal is here to stay! ✨

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

strickvl · 2024-08-26T06:51:03Z

@coderabbitai review

coderabbitai · 2024-08-26T06:51:07Z

Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

coderabbitai · 2024-08-26T06:51:11Z

Note

Currently processing new changes in this PR. This may take a few minutes, please wait...

Commits

Files that changed from the base of the PR and between 647ac95 and c3173a3.

Files selected for processing (8)

docs/mocked_libs.json (1 hunks)
src/zenml/integrations/init.py (1 hunks)
src/zenml/integrations/constants.py (1 hunks)
src/zenml/integrations/modal/init.py (1 hunks)
src/zenml/integrations/modal/flavors/init.py (1 hunks)
src/zenml/integrations/modal/flavors/modal_step_operator_flavor.py (1 hunks)
src/zenml/integrations/modal/step_operators/init.py (1 hunks)
src/zenml/integrations/modal/step_operators/modal_step_operator.py (1 hunks)

_______________________________________________
< Optimization hinders evolution. - Alan Perlis >
-----------------------------------------------
 \
  \   (\__/)
      (•ㅅ•)
      / 　 づ

Tip

You can disable poems in the walkthrough.

Disable the reviews.poem setting in your project's settings in CodeRabbit to remove poems from the walkthrough.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai generate interesting stats about this repository and render them as a table.
- @coderabbitai show all the console.log statements in this repository.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

coderabbitai

Actionable comments posted: 1

Outside diff range, codebase verification and nitpick comments (1)

src/zenml/integrations/modal/step_operators/modal_step_operator.py (1)

112-208: Consider adding more comments for clarity.

The launch method is detailed and includes error handling, but additional comments could improve readability and maintainability.

Consider adding comments to explain the purpose of each major block of code within the method.

Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 647ac95 and c3173a3.

Files selected for processing (8)

docs/mocked_libs.json (1 hunks)
src/zenml/integrations/init.py (1 hunks)
src/zenml/integrations/constants.py (1 hunks)
src/zenml/integrations/modal/init.py (1 hunks)
src/zenml/integrations/modal/flavors/init.py (1 hunks)
src/zenml/integrations/modal/flavors/modal_step_operator_flavor.py (1 hunks)
src/zenml/integrations/modal/step_operators/init.py (1 hunks)
src/zenml/integrations/modal/step_operators/modal_step_operator.py (1 hunks)

Files skipped from review due to trivial changes (2)

src/zenml/integrations/constants.py
src/zenml/integrations/modal/step_operators/init.py

Additional context used

Path-based instructions (5)

src/zenml/integrations/modal/flavors/__init__.py (1)

Pattern src/zenml/**/*.py: Review the Python code for conformity with Python best practices.

src/zenml/integrations/modal/__init__.py (1)

Pattern src/zenml/**/*.py: Review the Python code for conformity with Python best practices.

src/zenml/integrations/__init__.py (1)

Pattern src/zenml/**/*.py: Review the Python code for conformity with Python best practices.

src/zenml/integrations/modal/flavors/modal_step_operator_flavor.py (1)

Pattern src/zenml/**/*.py: Review the Python code for conformity with Python best practices.

src/zenml/integrations/modal/step_operators/modal_step_operator.py (1)

Pattern src/zenml/**/*.py: Review the Python code for conformity with Python best practices.

Additional comments not posted (12)

src/zenml/integrations/modal/flavors/__init__.py (2)

1-14: LGTM!

The license header and docstring are correctly formatted.

The code changes are approved.

16-26: LGTM!

The import statements and __all__ declaration are correctly implemented.

The code changes are approved.

src/zenml/integrations/modal/__init__.py (4)

1-18: LGTM!

The license header and docstring are correctly formatted.

The code changes are approved.

19-25: LGTM!

The import statements and constant declaration are correctly implemented.

The code changes are approved.

28-43: LGTM!

The class definition and methods are correctly implemented.

The code changes are approved.

46-46: LGTM!

The installation check is correctly implemented.

The code changes are approved.

src/zenml/integrations/__init__.py (1)

49-49: LGTM!

The import statement for ModalIntegration is correctly implemented.

The code changes are approved.

src/zenml/integrations/modal/flavors/modal_step_operator_flavor.py (3)

26-51: LGTM!

The ModalStepOperatorSettings class is well-defined with comprehensive docstrings. The attributes cover essential configurations for the Modal step operator.

The code changes are approved.

54-70: LGTM!

The ModalStepOperatorConfig class is well-structured and the is_remote property is correctly implemented. The docstring provides clear explanations.

The code changes are approved.

73-130: LGTM!

The ModalStepOperatorFlavor class is well-implemented with correctly defined properties and informative docstrings. The class follows Python best practices.

The code changes are approved.

docs/mocked_libs.json (1)

254-257: LGTM!

The additions of modal, modal.cli, and modal.cli.run expand the library's capabilities. The overall structure of the JSON remains unchanged.

The code changes are approved.

src/zenml/integrations/modal/step_operators/modal_step_operator.py (1)

44-49: LGTM!

The ModalStepOperator class is well-implemented with a clear purpose and structure. The docstring provides a good overview.

The code changes are approved.

src/zenml/integrations/modal/step_operators/modal_step_operator.py

src/zenml/integrations/modal/flavors/modal_step_operator_flavor.py

src/zenml/integrations/modal/step_operators/modal_step_operator.py

schustmi · 2024-08-26T08:45:04Z

Some answers for your general questions/comments:

The settings should be visible on the DAG visualizer in the Stack card. Can you point me to a run with some settings so I can verify that it's not showing up.
How is the orchestrator url related to this PR? It's just a step operator right, and there is no code in your step operator that would even set this metadata right?

I would suggest the following:

We introduce another metadata constant:
METADATA_STEP_OPERATOR_URL = "step_operator_url"
We implement the get_step_run_metadata(...) method in the modal step operator and include the modal URL for the constant above. We can then later expose this on the dashboard and also implement it for other step operators

strickvl · 2024-08-26T12:06:01Z

Some answers for your general questions/comments:

The settings should be visible on the DAG visualizer in the Stack card. Can you point me to a run with some settings so I can verify that it's not showing up.

How is the orchestrator url related to this PR? It's just a step operator right, and there is no code in your step operator that would even set this metadata right?

I would suggest the following:

We introduce another metadata constant:
METADATA_STEP_OPERATOR_URL = "step_operator_url"

We implement the get_step_run_metadata(...) method in the modal step operator and include the modal URL for the constant above. We can then later expose this on the dashboard and also implement it for other step operators

Ah yes you're right. Actually because of the way their CLI works (and the fact that we're now using subprocess), it's even a bit harder to get the URL for the specific run. Since we don't yet have it for other step operators, I think we can just leave it for now maybe.

avishniakov

LGTM, just a tiny nit which can be ignored

src/zenml/integrations/modal/__init__.py

…ml into feature/modal-step-operator

github-actions · 2024-10-14T07:12:05Z

LLM Finetuning template updates in examples/llm_finetuning have been pushed.

github-actions · 2024-10-14T07:17:34Z

Classification template updates in examples/mlops_starter have been pushed.

github-actions · 2024-10-14T07:19:16Z

E2E template updates in examples/e2e have been pushed.

strickvl added 10 commits August 21, 2024 19:45

add init file

5717262

initial scaffold

11fb146

add a flavor

c387b9d

first attempt

8a753ed

add docstrings

1b2e5e8

add modal to integrations properly

7fb45d5

update flavor and working step operator code

4f6ca3e

refactorings

01f041c

add support for settings

9bf9a15

update docsting on settings

de8eb01

strickvl added enhancement New feature or request internal To filter out internal PRs and issues labels Aug 25, 2024

strickvl requested review from schustmi and safoinme August 25, 2024 15:22

strickvl and others added 5 commits August 25, 2024 17:23

Merge branch 'develop' into feature/modal-step-operator

094df25

make additions for API docs build

20b3acd

add missing docstrings

bd6a4ac

mypy fix

adbe393

mypy fixes

c3173a3

coderabbitai bot reviewed Aug 26, 2024

View reviewed changes

src/zenml/integrations/modal/step_operators/modal_step_operator.py Outdated Show resolved Hide resolved

schustmi requested changes Aug 26, 2024

View reviewed changes

switch pkg_resources for importlib

015bd40

strickvl added 2 commits August 26, 2024 14:06

PR comment fixes

18ff055

add docs

2177272

Merge branch 'develop' into feature/modal-step-operator

58f8804

avishniakov approved these changes Aug 29, 2024

View reviewed changes

src/zenml/integrations/modal/__init__.py Show resolved Hide resolved

strickvl and others added 9 commits August 29, 2024 17:15

update mocked_libs

f2797d1

Merge branch 'feature/modal-step-operator' of github.com:zenml-io/zen…

27c6bc2

…ml into feature/modal-step-operator

Merge branch 'develop' into feature/modal-step-operator

c0fff24

fixes from modal team

ab5ceab

Merge branch 'feature/modal-step-operator' of github.com:zenml-io/zen…

e86cd2c

…ml into feature/modal-step-operator

add timeout

9e4335d

update app name

8243cd9

Merge branch 'develop' into feature/modal-step-operator

f37ac32

Auto-update of LLM Finetuning template

8d77b33

Auto-update of Starter template

c441b0c

Auto-update of E2E template

963181b

Merge branch 'develop' into feature/modal-step-operator

3ce90db

This comment was marked as off-topic.

Sign in to view

formatting

131ef95

strickvl removed the run-slow-ci label Nov 27, 2024

strickvl and others added 6 commits November 27, 2024 17:09

update TOC

750176a

update step operators page

b858a23

update to most recent syntax

0af7a8a

Merge branch 'develop' into feature/modal-step-operator

2202256

small docs fix

a819d91

remove file

ea452ca

strickvl added the run-slow-ci label Nov 27, 2024

fixes for mypy

b57cf69

strickvl merged commit eb12a64 into develop Nov 27, 2024
70 checks passed

strickvl deleted the feature/modal-step-operator branch November 27, 2024 19:05

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Modal Step Operator #2948

Modal Step Operator #2948

strickvl commented Aug 25, 2024 •

edited

Loading

coderabbitai bot commented Aug 25, 2024 •

edited

Loading

Review skipped

Walkthrough

Changes

Sequence Diagram(s)

Poem

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

Documentation and Community

strickvl commented Aug 26, 2024

coderabbitai bot commented Aug 26, 2024

coderabbitai bot commented Aug 26, 2024

Chat

CodeRabbit Commands (invoked as PR comments)

Documentation and Community

coderabbitai bot left a comment

schustmi commented Aug 26, 2024

strickvl commented Aug 26, 2024

avishniakov left a comment

github-actions bot commented Oct 14, 2024

github-actions bot commented Oct 14, 2024

github-actions bot commented Oct 14, 2024

This comment was marked as off-topic.

Modal Step Operator #2948

Modal Step Operator #2948

Conversation

strickvl commented Aug 25, 2024 • edited Loading

Remaining tasks

Summary by CodeRabbit

coderabbitai bot commented Aug 25, 2024 • edited Loading

Review skipped

Walkthrough

Changes

Sequence Diagram(s)

Poem

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

Documentation and Community

strickvl commented Aug 26, 2024

coderabbitai bot commented Aug 26, 2024

coderabbitai bot commented Aug 26, 2024

Chat

CodeRabbit Commands (invoked as PR comments)

Documentation and Community

coderabbitai bot left a comment

Choose a reason for hiding this comment

schustmi commented Aug 26, 2024

strickvl commented Aug 26, 2024

avishniakov left a comment

Choose a reason for hiding this comment

github-actions bot commented Oct 14, 2024

github-actions bot commented Oct 14, 2024

github-actions bot commented Oct 14, 2024

This comment was marked as off-topic.

strickvl commented Aug 25, 2024 •

edited

Loading

coderabbitai bot commented Aug 25, 2024 •

edited

Loading