Autodoc

AutoDocs

Interact with AutoDocs in the Driverless AI server.

create

create(experiment: Experiment, **config_overrides: Any) -> AutoDoc

Creates a new AutoDoc.

Parameters:

• experiment (Experiment) –

  The experiment to generate the document for.

• config_overrides (Any, default: {} ) –

  Configuration overrides to override configurations set for AutoDoc generation in Driverless AI server. Please refer AutoDoc Settings docs for available configuration options.

Returns:

• AutoDoc –

  Created AutoDoc.

create_async

create_async(experiment: Experiment, **config_overrides: Any) -> AutoDocJob

Launches creation of a new AutoDoc.

Parameters:

• experiment (Experiment) –

  The experiment to generate the document for.

• config_overrides (Any, default: {} ) –

  Configuration overrides to override configurations set for AutoDoc generation in Driverless AI server. Please refer AutoDoc Settings docs for available configuration options.

Returns:

• AutoDocJob –

  Started AutoDoc job.

AutoDocJob

Monitor the creation of an AutoDoc in the Driverless AI server.

key property

key: str

Universally unique key of the entity.

Returns:

• str –

   

name property

name: str

Name of the entity.

Returns:

• str –

   

is_complete

is_complete() -> bool

Whether the job has been completed successfully.

Returns:

• bool –

  True if the job has been completed successfully, otherwise False.

is_running

is_running() -> bool

Whether the job has been scheduled or is running, finishing, or syncing.

Returns:

• bool –

  True if the job has not completed yet, otherwise False.

result

result(silent: bool = False) -> AutoDoc

Awaits the job's completion before returning the created AutoDoc.

Parameters:

• silent (bool, default: False ) –

  Whether to display status updates or not.

Returns:

• AutoDoc –

  Created AutoDoc by the job.

status

status(verbose: int = 0) -> str

Returns the status of the job.

Parameters:

• verbose (int, default: 0 ) –
  • 0: A short description.
  • 1: A short description with a progress percentage.
  • 2: A detailed description with a progress percentage.

Returns:

• str –

  Current status of the job.

AutoDoc

An AutoDoc in the Driverless AI server.

creation_time property

creation_time: float

Creation timestamp of the AutoDoc in seconds since the epoch (POSIX timestamp).

Returns:

• float –

   

experiment property

experiment: Experiment

The experiment documented by the AutoDoc.

Returns:

• Experiment –

   

key property

key: str

Universally unique key of the entity.

Returns:

• str –

   

name property

name: str

Name of the entity.

Returns:

• str –

   

download

download(
    dst_dir: str = ".",
    dst_file: str | None = None,
    file_system: AbstractFileSystem | None = None,
    overwrite: bool = False,
    timeout: float = 30,
) -> str

Downloads the AutoDoc as in MS Word format (.docx).

Parameters:

• dst_dir (str, default: '.' ) –

  The path where the doc file will be saved.

• dst_file (str | None, default: None ) –

  The name of the doc file (overrides the default file name).

• file_system (AbstractFileSystem | None, default: None ) –

  FSSPEC-based file system to download to instead of the local file system.

• overwrite (bool, default: False ) –

  Whether to overwrite or not if a file already exists.

• timeout (float, default: 30 ) –

  Connection timeout in seconds.

Returns:

• str –

  Path to the downloaded doc file.