Feedback Edit

OutputDirectory Class

  • Reference

Output directory for the job.

All required parameters must be populated in order to send to Azure.

Inheritance
Model
OutputDirectory

Constructor

OutputDirectory(*, id: str, path_prefix: str, path_suffix: Optional[str] = None, **kwargs)

Parameters

id
str
Required

Required. The ID of the output directory. The job can use AZ_BATCHAIOUTPUT <id> environment variable to find the directory path, where <id> is the value of id attribute.

path_prefix
str
Required

Required. The prefix path where the output directory will be created. Note, this is an absolute path to prefix. E.g. $AZ_BATCHAI_MOUNT_ROOT/MyNFS/MyLogs. The full path to the output directory by combining pathPrefix, jobOutputDirectoryPathSegment (reported by get job) and pathSuffix.

path_suffix
str
Required

The suffix path where the output directory will be created. E.g. models. You can find the full path to the output directory by combining pathPrefix, jobOutputDirectoryPathSegment (reported by get job) and pathSuffix.