Job

Properties

  • status Status of this Job

Methods

wait_for_done

wait_for_done(
   blocking_time_increment: float = 1.0, attempts: int = 20
)

Description


wait_for_status

wait_for_status(
   statuses: Union[str, JobStatus, JobRunStatus, List[Union[str, JobStatus,
   JobRunStatus]]], blocking_time_increment: float = 1.0, attempts: int = 20
)

Description


update_job_run_with_status

update_job_run_with_status(
   status: JobRunStatus
)

Description


send_logging

send_logging(
   log: Union[str, list], part: str, final: bool = False, special: Union[str, bool,
   list] = False
)

Description

Send a logging experiment to the experiment .

Arguments

  • log (str) : Log content

  • part (str) : Logging Part

  • final (bool, optional) : True if Final line. Defaults to False.

  • special (bool, optional) : True if special log. Defaults to False.


start_logging_chapter

start_logging_chapter(
   name: str
)

Description

Print a log entry to the log .

Arguments

  • name (str) : Chapter name

start_logging_buffer

start_logging_buffer(
   length: int = 1
)

Description

Start logging buffer .

Arguments

  • length (int, optional) : Buffer length. Defaults to 1.

end_logging_buffer

end_logging_buffer()

Description

End the logging buffer .


store_logging_file

store_logging_file(
   path: Union[str, Path]
)

Description

Store a logging file for this experiment.

Examples

experiment.store_logging_file("logs.txt")

Arguments

  • path (str or Path) : path to the file or folder.

Raises

  • FileNotFoundException : No file found at the given path

Returns

Object name of logging file as string