Skip to content

dlgforge.distributed.bootstrap

Distributed bootstrap orchestration for generation runs.

RunBootstrap(config_path, cfg)

Manage distributed bootstrap lifecycle around a generation run.

Parameters:

Name Type Description Default
config_path str | Path

Path to a configuration file.

required
cfg Dict[str, Any]

Configuration mapping that controls runtime behavior.

required

Raises:

Type Description
Exception

Construction may raise when required dependencies or inputs are invalid.

Side Effects / I/O: - May perform network, model, or distributed runtime operations. - May read environment variables or mutate process-level runtime state.

Preconditions / Invariants: - Instantiate and use through documented public methods.

Examples:

>>> from dlgforge.distributed.bootstrap import RunBootstrap
>>> RunBootstrap(...)

run(cfg) async

Provision runtime dependencies and execute the configured run.

Parameters:

Name Type Description Default
cfg Dict[str, Any]

Configuration mapping that controls runtime behavior.

required

Returns:

Name Type Description
None None

No value is returned.

Raises:

Type Description
RuntimeError

Raised when validation or runtime requirements are not met.

Side Effects / I/O: - May perform network, model, or distributed runtime operations. - May read environment variables or mutate process-level runtime state.

Preconditions / Invariants: - Callers should provide arguments matching annotated types and expected data contracts.

Examples:

>>> from dlgforge.distributed.bootstrap import RunBootstrap
>>> instance = RunBootstrap(...)
>>> instance.run(...)

run_bootstrap(config_path, cfg)

Run bootstrap.

Parameters:

Name Type Description Default
config_path str | Path

Path to a configuration file.

required
cfg Dict[str, Any]

Configuration mapping that controls runtime behavior.

required

Returns:

Name Type Description
None None

No value is returned.

Raises:

Type Description
Exception

Propagates unexpected runtime errors from downstream calls.

Side Effects / I/O: - May perform network, model, or distributed runtime operations. - May read environment variables or mutate process-level runtime state.

Preconditions / Invariants: - Callers should provide arguments matching annotated types and expected data contracts.

Examples:

>>> from dlgforge.distributed.bootstrap import run_bootstrap
>>> run_bootstrap(...)