nvflare.recipe.run module

class Run(exec_env: ExecEnv, job_id: str)[source]

Bases: object

abort()[source]

Abort the running job.

get_job_id() → str[source]
get_result(timeout: float = 0.0) → str | None[source]

Get the result workspace of the run.

Parameters:

timeout (float, optional) – The timeout for the job to complete. Defaults to 0.0, means never timeout.

Returns:

The result workspace path if job completed, None if still running or stopped early.

Return type:

Optional[str]

get_status() → str | None[source]

Get the status of the run.

Returns:

The status of the run, or None if called in a simulation environment.

Return type:

Optional[str]