Skip to content

Commit 534a944

Browse files
jopemachineclaude
andcommitted
docs(BA-5982): correct ExecutionData docstring (not all 'hooks')
Calling the three fields "execution-time hooks" was misleading — ``startup_command`` is the container's main entry command (replacing the image CMD) and ``bootstrap_script`` is a pre-launch init script; only ``callback_url`` is an actual event-callback hook. The previous "user-supplied vs resolver-produced" split rationale was also wrong: ``environ`` on ``ModelRuntimeConfigData`` is just as user-supplied, merged from preset / request / deployment-config sources. Rewrite the class docstring to describe the three fields by what they actually do (container entry command, pre-startup setup script, lifecycle event webhook), and add per-field comments explaining the ``None`` semantics. Keep the sibling-of-ModelRuntimeConfigData framing, restated as a packaging convenience for downstream consumers rather than a lifecycle distinction that does not really exist. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
1 parent 7bd7e6a commit 534a944

1 file changed

Lines changed: 14 additions & 8 deletions

File tree

  • src/ai/backend/manager/data/deployment

src/ai/backend/manager/data/deployment/types.py

Lines changed: 14 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -890,18 +890,24 @@ class ModelMountConfigData:
890890

891891
@dataclass
892892
class ExecutionData:
893-
"""Execution-time hooks frozen on the persisted revision.
894-
895-
Sibling of ``ModelRuntimeConfigData`` (which carries the runtime
896-
variant + environ + inference runtime knobs). Split out because these
897-
three fields have a different lifecycle: they are user-supplied
898-
overrides layered on top of preset / deployment-config / model-
899-
definition resolution, while runtime variant + environ are produced
900-
by the resolver pipeline.
893+
"""Container-execution overrides frozen on the persisted revision:
894+
what command runs in the model container, what setup script runs
895+
before it, and where deployment lifecycle events get POSTed.
896+
897+
Sibling of ``ModelRuntimeConfigData`` (runtime variant / environ /
898+
inference runtime knobs); kept separate so the schedulers and draft
899+
builders can pass these straight to the kernel spec without picking
900+
them out of the runtime config bag.
901901
"""
902902

903+
# Replaces the image ``CMD`` when starting the model container.
904+
# ``None`` keeps whatever the image baked in.
903905
startup_command: str | None
906+
# Shell script run once at container startup, before
907+
# ``startup_command``. ``None`` for revisions that do no extra setup.
904908
bootstrap_script: str | None
909+
# Webhook the manager POSTs to on deployment lifecycle events
910+
# (provisioning, ready, failure, …); ``None`` disables callbacks.
905911
callback_url: yarl.URL | None
906912

907913

0 commit comments

Comments
 (0)