Vertex AI V1 API - Class Google::Cloud::AIPlatform::V1::CustomJobSpec (v0.24.0)

Reference documentation and code samples for the Vertex AI V1 API class Google::Cloud::AIPlatform::V1::CustomJobSpec.

Represents the spec of a CustomJob.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#base_output_directory

def base_output_directory() -> ::Google::Cloud::AIPlatform::V1::GcsDestination
Returns
  • (::Google::Cloud::AIPlatform::V1::GcsDestination) —

    The Cloud Storage location to store the output of this CustomJob or HyperparameterTuningJob. For HyperparameterTuningJob, the baseOutputDirectory of each child CustomJob backing a Trial is set to a subdirectory of name id under its parent HyperparameterTuningJob's baseOutputDirectory.

    The following Vertex AI environment variables will be passed to containers or python modules when this field is set:

    For CustomJob:

    • AIP_MODEL_DIR = <base_output_directory>/model/
    • AIP_CHECKPOINT_DIR = <base_output_directory>/checkpoints/
    • AIP_TENSORBOARD_LOG_DIR = <base_output_directory>/logs/

    For CustomJob backing a Trial of HyperparameterTuningJob:

    • AIP_MODEL_DIR = <base_output_directory>/<trial_id>/model/
    • AIP_CHECKPOINT_DIR = <base_output_directory>/<trial_id>/checkpoints/
    • AIP_TENSORBOARD_LOG_DIR = <base_output_directory>/<trial_id>/logs/

#base_output_directory=

def base_output_directory=(value) -> ::Google::Cloud::AIPlatform::V1::GcsDestination
Parameter
  • value (::Google::Cloud::AIPlatform::V1::GcsDestination) —

    The Cloud Storage location to store the output of this CustomJob or HyperparameterTuningJob. For HyperparameterTuningJob, the baseOutputDirectory of each child CustomJob backing a Trial is set to a subdirectory of name id under its parent HyperparameterTuningJob's baseOutputDirectory.

    The following Vertex AI environment variables will be passed to containers or python modules when this field is set:

    For CustomJob:

    • AIP_MODEL_DIR = <base_output_directory>/model/
    • AIP_CHECKPOINT_DIR = <base_output_directory>/checkpoints/
    • AIP_TENSORBOARD_LOG_DIR = <base_output_directory>/logs/

    For CustomJob backing a Trial of HyperparameterTuningJob:

    • AIP_MODEL_DIR = <base_output_directory>/<trial_id>/model/
    • AIP_CHECKPOINT_DIR = <base_output_directory>/<trial_id>/checkpoints/
    • AIP_TENSORBOARD_LOG_DIR = <base_output_directory>/<trial_id>/logs/
Returns
  • (::Google::Cloud::AIPlatform::V1::GcsDestination) —

    The Cloud Storage location to store the output of this CustomJob or HyperparameterTuningJob. For HyperparameterTuningJob, the baseOutputDirectory of each child CustomJob backing a Trial is set to a subdirectory of name id under its parent HyperparameterTuningJob's baseOutputDirectory.

    The following Vertex AI environment variables will be passed to containers or python modules when this field is set:

    For CustomJob:

    • AIP_MODEL_DIR = <base_output_directory>/model/
    • AIP_CHECKPOINT_DIR = <base_output_directory>/checkpoints/
    • AIP_TENSORBOARD_LOG_DIR = <base_output_directory>/logs/

    For CustomJob backing a Trial of HyperparameterTuningJob:

    • AIP_MODEL_DIR = <base_output_directory>/<trial_id>/model/
    • AIP_CHECKPOINT_DIR = <base_output_directory>/<trial_id>/checkpoints/
    • AIP_TENSORBOARD_LOG_DIR = <base_output_directory>/<trial_id>/logs/

#enable_dashboard_access

def enable_dashboard_access() -> ::Boolean
Returns

#enable_dashboard_access=

def enable_dashboard_access=(value) -> ::Boolean
Parameter
Returns

#enable_web_access

def enable_web_access() -> ::Boolean
Returns

#enable_web_access=

def enable_web_access=(value) -> ::Boolean
Parameter
  • value (::Boolean) — Optional. Whether you want Vertex AI to enable