dpdispatcher.entrypoints package#
Entry points.
Submodules#
dpdispatcher.entrypoints.gui module#
DP-GUI entrypoint.
- dpdispatcher.entrypoints.gui.start_dpgui(*, port: int, bind_all: bool, **kwargs)[source]#
Host DP-GUI server.
- Parameters:
- portint
The port to serve DP-GUI on.
- bind_allbool
Serve on all public interfaces. This will expose your DP-GUI instance to the network on both IPv4 and IPv6 (where available).
- **kwargs
additional arguments
- Raises:
- ModuleNotFoundError
The dpgui package is not installed
dpdispatcher.entrypoints.run module#
Run PEP 723 script.
dpdispatcher.entrypoints.submission module#
- dpdispatcher.entrypoints.submission.handle_submission(*, submission_hash: str, download_terminated_log: bool = False, download_finished_task: bool = False, clean: bool = False, reset_fail_count: bool = False)[source]#
Handle terminated submission.
- Parameters:
- submission_hashstr
Submission hash to download.
- download_terminated_logbool, optional
Download log files of terminated tasks.
- download_finished_taskbool, optional
Download finished tasks.
- cleanbool, optional
Clean submission.
- reset_fail_countbool, optional
Reset fail count of all jobs to zero.
- Raises:
- ValueError
At least one action should be specified.
dpdispatcher.entrypoints.submit module#
Submit a submission from JSON file.
- dpdispatcher.entrypoints.submit.load_submission_from_json(json_path: str, allow_ref: bool = False) Submission[source]#
Load a Submission from a JSON file.
- Parameters:
- json_pathstr
Path to the JSON file.
- allow_refbool, default=False
Whether to allow loading external JSON/YAML snippets via
$ref. Disabled by default for security.
- Returns:
- Submission
Submission instance.
- dpdispatcher.entrypoints.submit.submission_args() Argument[source]#
Return the argument parser for submission JSON.
- Returns:
- Argument
submission argument
- dpdispatcher.entrypoints.submit.submit(*, filename: str, dry_run: bool = False, exit_on_submit: bool = False, allow_ref: bool = False) None[source]#
Submit a submission from a JSON file.
- Parameters:
- filenamestr
Path to the JSON file.
- dry_runbool
If True, only upload files without submitting.
- exit_on_submitbool
If True, exit after submitting without waiting for completion.
- allow_refbool, default=False
Whether to allow loading external JSON/YAML snippets via
$ref. Disabled by default for security.