modal 1.1.2.dev12__tar.gz → 1.1.2.dev13__tar.gz

{modal-1.1.2.dev12 → modal-1.1.2.dev13}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: modal
-Version: 1.1.2.dev12
+Version: 1.1.2.dev13
 Summary: Python client library for Modal
 Author-email: Modal Labs <support@modal.com>
 License: Apache-2.0

{modal-1.1.2.dev12 → modal-1.1.2.dev13}/modal/_runtime/container_io_manager.py

@@ -39,7 +39,6 @@ from modal.exception import ClientClosed, InputCancellation, InvalidError, Seria
 from modal_proto import api_pb2
 
 if TYPE_CHECKING:
-    import modal._runtime.asgi
     import modal._runtime.user_code_imports
 
 

{modal-1.1.2.dev12 → modal-1.1.2.dev13}/modal/cli/launch.py

@@ -3,6 +3,8 @@ import asyncio
 import inspect
 import json
 import os
+import subprocess
+import tempfile
 from pathlib import Path
 from typing import Any, Optional
 
@@ -26,7 +28,9 @@ launch_cli = Typer(
 )
 
 
-def _launch_program(name: str, filename: str, detach: bool, args: dict[str, Any]) -> None:
+def _launch_program(
+    name: str, filename: str, detach: bool, args: dict[str, Any], *, description: Optional[str] = None
+) -> None:
     os.environ["MODAL_LAUNCH_ARGS"] = json.dumps(args)
 
     program_path = str(Path(__file__).parent / "programs" / filename)
@@ -35,7 +39,7 @@ def _launch_program(name: str, filename: str, detach: bool, args: dict[str, Any]
     entrypoint = module.main
 
     app = _get_runnable_app(entrypoint)
-    app.set_description(base_cmd)
+    app.set_description(description if description else base_cmd)
 
     # `launch/` scripts must have a `local_entrypoint()` with no args, for simplicity here.
     func = entrypoint.info.raw_f
@@ -108,3 +112,75 @@ def vscode(
         "volume": volume,
     }
     _launch_program("vscode", "vscode.py", detach, args)
+
+
+@launch_cli.command(name="machine", help="Start an instance on Modal, with direct SSH access.")
+def machine(
+    name: str,  # Name of the machine App.
+    cpu: int = 8,  # Reservation of CPU cores (can burst above this value).
+    memory: int = 32768,  # Reservation of memory in MiB (can burst above this value).
+    gpu: Optional[str] = None,  # GPU type and count, e.g. "t4" or "h100:2".
+    image: Optional[str] = None,  # Image tag to use from registry. Defaults to the notebook base image.
+    timeout: int = 3600 * 24,  # Timeout in seconds for the instance.
+    volume: str = "machine-vol",  # Attach a persisted `modal.Volume` at /workspace (created if missing).
+):
+    tempdir = Path(tempfile.gettempdir())
+    key_path = tempdir / "modal-machine-keyfile.pem"
+    # Generate a new SSH key pair for this machine instance.
+    if not key_path.exists():
+        subprocess.run(
+            ["ssh-keygen", "-t", "ed25519", "-f", str(key_path), "-N", ""],
+            check=True,
+            stdout=subprocess.DEVNULL,
+        )
+    # Add the key with expiry 1d to ssh agent.
+    subprocess.run(
+        ["ssh-add", "-t", "1d", str(key_path)],
+        check=True,
+        stdout=subprocess.DEVNULL,
+        stderr=subprocess.DEVNULL,
+    )
+
+    os.environ["SSH_PUBLIC_KEY"] = Path(str(key_path) + ".pub").read_text()
+    os.environ["MODAL_LOGS_TIMEOUT"] = "0"  # hack to work with --detach
+
+    args = {
+        "cpu": cpu,
+        "memory": memory,
+        "gpu": gpu,
+        "image": image,
+        "timeout": timeout,
+        "volume": volume,
+    }
+    _launch_program(
+        "machine",
+        "launch_instance_ssh.py",
+        True,
+        args,
+        description=name,
+    )
+
+
+@launch_cli.command(name="marimo", help="Start a remote Marimo notebook on Modal.")
+def marimo(
+    cpu: int = 8,
+    memory: int = 32768,
+    gpu: Optional[str] = None,
+    image: str = "debian:12",
+    timeout: int = 3600,
+    add_python: Optional[str] = "3.12",
+    mount: Optional[str] = None,  # Create a `modal.Mount` from a local directory.
+    volume: Optional[str] = None,  # Attach a persisted `modal.Volume` by name (creating if missing).
+    detach: bool = False,  # Run the app in "detached" mode to persist after local client disconnects
+):
+    args = {
+        "cpu": cpu,
+        "memory": memory,
+        "gpu": gpu,
+        "timeout": timeout,
+        "image": image,
+        "add_python": add_python,
+        "mount": mount,
+        "volume": volume,
+    }
+    _launch_program("marimo", "run_marimo.py", detach, args)

modal-1.1.2.dev13/modal/cli/programs/launch_instance_ssh.py

@@ -0,0 +1,94 @@
+# Copyright Modal Labs 2023
+# type: ignore
+import json
+import os
+import sys
+from typing import Any
+
+import rich
+import rich.panel
+import rich.rule
+
+import modal
+import modal.experimental
+
+# Passed by `modal launch` locally via CLI.
+args: dict[str, Any] = json.loads(os.environ.get("MODAL_LAUNCH_ARGS", "{}"))
+
+app = modal.App()
+
+image: modal.Image
+if args.get("image"):
+    image = modal.Image.from_registry(args.get("image"))
+else:
+    # Must be set to the same image builder version as the notebook base image.
+    os.environ["MODAL_IMAGE_BUILDER_VERSION"] = "2024.10"
+    image = modal.experimental.notebook_base_image(python_version="3.12")
+
+volume = (
+    modal.Volume.from_name(
+        args.get("volume"),
+        create_if_missing=True,
+    )
+    if args.get("volume")
+    else None
+)
+volumes = {"/workspace": volume} if volume else {}
+
+
+startup_script = """
+set -eu
+mkdir -p /run/sshd
+
+# Check if sshd is installed, install if not
+test -x /usr/sbin/sshd || (apt-get update && apt-get install -y openssh-server)
+
+# Change default working directory to /workspace
+echo "cd /workspace" >> /root/.profile
+
+mkdir -p /root/.ssh
+echo "$SSH_PUBLIC_KEY" >> /root/.ssh/authorized_keys
+/usr/sbin/sshd -D -e
+"""
+
+
+@app.local_entrypoint()
+def main():
+    if not os.environ.get("SSH_PUBLIC_KEY"):
+        raise ValueError("SSH_PUBLIC_KEY environment variable is not set")
+
+    sb = modal.Sandbox.create(
+        *("sh", "-c", startup_script),
+        app=app,
+        image=image,
+        cpu=args.get("cpu"),
+        memory=args.get("memory"),
+        gpu=args.get("gpu"),
+        timeout=args.get("timeout"),
+        volumes=volumes,
+        unencrypted_ports=[22],  # Forward SSH port
+        secrets=[modal.Secret.from_dict({"SSH_PUBLIC_KEY": os.environ.get("SSH_PUBLIC_KEY")})],
+    )
+    hostname, port = sb.tunnels()[22].tcp_socket
+    connection_cmd = f"ssh -A -p {port} root@{hostname}"
+
+    rich.print(
+        rich.rule.Rule(style="yellow"),
+        rich.panel.Panel(
+            f"""Your instance is ready! You can SSH into it using the following command:
+
+  [dim gray]>[/dim gray] [bold cyan]{connection_cmd}[/bold cyan]
+
+[italic]Details:[/italic]
+  • Name:    [magenta]{app.description}[/magenta]
+  • CPU:     [yellow]{args.get("cpu")} cores[/yellow]
+  • Memory:  [yellow]{args.get("memory")} MiB[/yellow]
+  • Timeout: [yellow]{args.get("timeout")} seconds[/yellow]
+  • GPU:     [green]{(args.get("gpu") or "N/A").upper()}[/green]""",
+            title="SSH Connection",
+            expand=False,
+        ),
+        rich.rule.Rule(style="yellow"),
+    )
+
+    sys.exit(0)  # Exit immediately to prevent "Timed out waiting for final apps log."

modal-1.1.2.dev13/modal/cli/programs/run_marimo.py

@@ -0,0 +1,95 @@
+# Copyright Modal Labs 2025
+# type: ignore
+import json
+import os
+import secrets
+import socket
+import subprocess
+import threading
+import time
+import webbrowser
+from typing import Any
+
+from modal import App, Image, Queue, Secret, Volume, forward
+
+# Args injected by `modal launch` CLI.
+args: dict[str, Any] = json.loads(os.environ.get("MODAL_LAUNCH_ARGS", "{}"))
+
+app = App()
+
+image = Image.from_registry(args.get("image"), add_python=args.get("add_python")).uv_pip_install("marimo")
+
+# Optional host-filesystem mount (read-only snapshot of your project, useful for editing)
+if args.get("mount"):
+    image = image.add_local_dir(args["mount"], remote_path="/root/marimo/mount")
+
+# Optional persistent Modal volume
+volume = Volume.from_name(args["volume"], create_if_missing=True) if args.get("volume") else None
+volumes = {"/root/marimo/volume": volume} if volume else {}
+
+
+def _wait_for_port(url: str, q: Queue) -> None:
+    start = time.monotonic()
+    while True:
+        try:
+            with socket.create_connection(("localhost", 8888), timeout=30):
+                break
+        except OSError as exc:
+            if time.monotonic() - start > 30:
+                raise TimeoutError("marimo server did not start within 30 s") from exc
+            time.sleep(0.05)
+    q.put(url)
+
+
+@app.function(
+    image=image,
+    cpu=args.get("cpu"),
+    memory=args.get("memory"),
+    gpu=args.get("gpu"),
+    timeout=args.get("timeout"),
+    secrets=[Secret.from_dict({"MODAL_LAUNCH_ARGS": json.dumps(args)})],
+    volumes=volumes,
+    max_containers=1 if volume else None,
+)
+def run_marimo(q: Queue):
+    os.makedirs("/root/marimo", exist_ok=True)
+
+    # marimo supports token-based auth; generate one so only you can connect
+    token = secrets.token_urlsafe(12)
+
+    with forward(8888) as tunnel:
+        url = f"{tunnel.url}/?access_token={token}"
+        threading.Thread(target=_wait_for_port, args=(url, q), daemon=True).start()
+
+        print("\nmarimo on Modal, opening in browser …")
+        print(f"   -> {url}\n")
+
+        # Launch the headless edit server
+        subprocess.run(
+            [
+                "marimo",
+                "edit",
+                "--headless",  # don't open browser in container
+                "--host",
+                "0.0.0.0",  # bind all interfaces
+                "--port",
+                "8888",
+                "--token-password",
+                token,  # enable session-based auth
+                "--skip-update-check",
+                "/root/marimo",  # workspace directory
+            ],
+            env={**os.environ, "SHELL": "/bin/bash"},
+        )
+
+    q.put("done")
+
+
+@app.local_entrypoint()
+def main():
+    with Queue.ephemeral() as q:
+        run_marimo.spawn(q)
+        url = q.get()  # first message = connect URL
+        time.sleep(1)  # give server a heartbeat
+        webbrowser.open(url)
+        assert q.get() == "done"

{modal-1.1.2.dev12 → modal-1.1.2.dev13}/modal/client.pyi

@@ -33,7 +33,7 @@ class _Client:
         server_url: str,
         client_type: int,
         credentials: typing.Optional[tuple[str, str]],
-        version: str = "1.1.2.dev12",
+        version: str = "1.1.2.dev13",
     ):
         """mdmd:hidden
         The Modal client object is not intended to be instantiated directly by users.
@@ -164,7 +164,7 @@ class Client:
         server_url: str,
         client_type: int,
         credentials: typing.Optional[tuple[str, str]],
-        version: str = "1.1.2.dev12",
+        version: str = "1.1.2.dev13",
     ):
         """mdmd:hidden
         The Modal client object is not intended to be instantiated directly by users.

{modal-1.1.2.dev12 → modal-1.1.2.dev13}/modal/experimental/__init__.py

@@ -1,5 +1,6 @@
 # Copyright Modal Labs 2025
 import os
+import shlex
 from dataclasses import dataclass
 from pathlib import Path
 from typing import Literal, Optional, Union
@@ -212,6 +213,109 @@ async def raw_registry_image(
     )
 
 
+@synchronizer.create_blocking
+async def notebook_base_image(*, python_version: Optional[str] = None, force_build: bool = False) -> _Image:
+    """Default image used for Modal notebook kernels, with common libraries.
+
+    This can be used to bootstrap development workflows quickly. We don't
+    recommend using this image for production Modal Functions though, as it may
+    change at any time in the future.
+    """
+    # Include several common packages, as well as kernelshim dependencies (except 'modal').
+    # These packages aren't pinned, so they may change over time with builds.
+    #
+    # We plan to use `--exclude-newer` in the future, with date-specific image builds.
+    base_image = _Image.debian_slim(python_version=python_version)
+
+    environment_packages: list[str] = [
+        "accelerate",
+        "aiohttp",
+        "altair",
+        "anthropic",
+        "asyncpg",
+        "beautifulsoup4",
+        "bokeh",
+        "boto3[crt]",
+        "click",
+        "diffusers[torch,flax]",
+        "dm-sonnet",
+        "flax",
+        "ftfy",
+        "h5py",
+        "urllib3",
+        "httpx",
+        "huggingface-hub",
+        "ipywidgets",
+        "jax[cuda12]",
+        "keras",
+        "matplotlib",
+        "nbformat",
+        "numba",
+        "numpy",
+        "openai",
+        "optax",
+        "pandas",
+        "plotly[express]",
+        "polars",
+        "psycopg2",
+        "requests",
+        "safetensors",
+        "scikit-image",
+        "scikit-learn",
+        "scipy",
+        "seaborn",
+        "sentencepiece",
+        "sqlalchemy",
+        "statsmodels",
+        "sympy",
+        "tabulate",
+        "tensorboard",
+        "toml",
+        "transformers",
+        "triton",
+        "typer",
+        "vega-datasets",
+        "watchfiles",
+        "websockets",
+    ]
+
+    # Kernelshim dependencies. (see NOTEBOOK_KERNELSHIM_DEPENDENCIES)
+    kernelshim_packages: list[str] = [
+        "authlib>=1.3",
+        "basedpyright>=1.28",
+        "fastapi>=0.100",
+        "ipykernel>=6",
+        "pydantic>=2",
+        "pyzmq>=26",
+        "ruff>=0.11",
+        "uvicorn>=0.32",
+    ]
+
+    commands: list[str] = [
+        "apt-get update",
+        "apt-get install -y libpq-dev pkg-config cmake git curl wget unzip zip libsqlite3-dev openssh-server",
+        # Install uv since it's faster than pip for installing packages.
+        "pip install uv",
+        # https://github.com/astral-sh/uv/issues/11480
+        "pip install torch torchvision torchaudio --index-url https://download.pytorch.org/whl/cu126",
+        f"uv pip install --system {shlex.join(sorted(environment_packages))}",
+        f"uv pip install --system {shlex.join(sorted(kernelshim_packages))}",
+    ]
+
+    # TODO: Also install the CUDA Toolkit, so `nvcc` is available.
+    # https://github.com/charlesfrye/cuda-modal/blob/7fef8db12402986cf42d9c8cca8c63d1da6d7700/cuda/use_cuda.py#L158-L188
+
+    def build_dockerfile(version: ImageBuilderVersion) -> DockerfileSpec:
+        return DockerfileSpec(commands=["FROM base", *(f"RUN {cmd}" for cmd in commands)], context_files={})
+
+    return _Image._from_args(
+        base_images={"base": base_image},
+        dockerfile_function=build_dockerfile,
+        force_build=force_build,
+        _namespace=api_pb2.DEPLOYMENT_NAMESPACE_GLOBAL,
+    )
+
+
 @synchronizer.create_blocking
 async def update_autoscaler(
     obj: Union[_Function, _Obj],

{modal-1.1.2.dev12 → modal-1.1.2.dev13}/modal/functions.pyi

@@ -433,7 +433,7 @@ class Function(
 
     _call_generator: ___call_generator_spec[typing_extensions.Self]
 
-    class __remote_spec(typing_extensions.Protocol[P_INNER, ReturnType_INNER, SUPERSELF]):
+    class __remote_spec(typing_extensions.Protocol[ReturnType_INNER, P_INNER, SUPERSELF]):
         def __call__(self, /, *args: P_INNER.args, **kwargs: P_INNER.kwargs) -> ReturnType_INNER:
             """Calls the function remotely, executing it with the given arguments and returning the execution's result."""
             ...
@@ -442,7 +442,7 @@ class Function(
             """Calls the function remotely, executing it with the given arguments and returning the execution's result."""
             ...
 
-    remote: __remote_spec[modal._functions.P, modal._functions.ReturnType, typing_extensions.Self]
+    remote: __remote_spec[modal._functions.ReturnType, modal._functions.P, typing_extensions.Self]
 
     class __remote_gen_spec(typing_extensions.Protocol[SUPERSELF]):
         def __call__(self, /, *args, **kwargs) -> typing.Generator[typing.Any, None, None]:
@@ -469,7 +469,7 @@ class Function(
         """
         ...
 
-    class ___experimental_spawn_spec(typing_extensions.Protocol[P_INNER, ReturnType_INNER, SUPERSELF]):
+    class ___experimental_spawn_spec(typing_extensions.Protocol[ReturnType_INNER, P_INNER, SUPERSELF]):
         def __call__(self, /, *args: P_INNER.args, **kwargs: P_INNER.kwargs) -> FunctionCall[ReturnType_INNER]:
             """[Experimental] Calls the function with the given arguments, without waiting for the results.
 
@@ -493,7 +493,7 @@ class Function(
             ...
 
     _experimental_spawn: ___experimental_spawn_spec[
-        modal._functions.P, modal._functions.ReturnType, typing_extensions.Self
+        modal._functions.ReturnType, modal._functions.P, typing_extensions.Self
     ]
 
     class ___spawn_map_inner_spec(typing_extensions.Protocol[P_INNER, SUPERSELF]):
@@ -502,7 +502,7 @@ class Function(
 
     _spawn_map_inner: ___spawn_map_inner_spec[modal._functions.P, typing_extensions.Self]
 
-    class __spawn_spec(typing_extensions.Protocol[P_INNER, ReturnType_INNER, SUPERSELF]):
+    class __spawn_spec(typing_extensions.Protocol[ReturnType_INNER, P_INNER, SUPERSELF]):
         def __call__(self, /, *args: P_INNER.args, **kwargs: P_INNER.kwargs) -> FunctionCall[ReturnType_INNER]:
             """Calls the function with the given arguments, without waiting for the results.
 
@@ -523,7 +523,7 @@ class Function(
             """
             ...
 
-    spawn: __spawn_spec[modal._functions.P, modal._functions.ReturnType, typing_extensions.Self]
+    spawn: __spawn_spec[modal._functions.ReturnType, modal._functions.P, typing_extensions.Self]
 
     def get_raw_f(self) -> collections.abc.Callable[..., typing.Any]:
         """Return the inner Python object wrapped by this Modal Function."""

{modal-1.1.2.dev12 → modal-1.1.2.dev13}/modal.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: modal
-Version: 1.1.2.dev12
+Version: 1.1.2.dev13
 Summary: Python client library for Modal
 Author-email: Modal Labs <support@modal.com>
 License: Apache-2.0

{modal-1.1.2.dev12 → modal-1.1.2.dev13}/modal.egg-info/SOURCES.txt

@@ -154,7 +154,9 @@ modal/cli/token.py
 modal/cli/utils.py
 modal/cli/volume.py
 modal/cli/programs/__init__.py
+modal/cli/programs/launch_instance_ssh.py
 modal/cli/programs/run_jupyter.py
+modal/cli/programs/run_marimo.py
 modal/cli/programs/vscode.py
 modal/experimental/__init__.py
 modal/experimental/flash.py

{modal-1.1.2.dev12 → modal-1.1.2.dev13}/modal_version/__init__.py

@@ -1,4 +1,4 @@
 # Copyright Modal Labs 2025
 """Supplies the current version of the modal client library."""
 
-__version__ = "1.1.2.dev12"
+__version__ = "1.1.2.dev13"