xlml/apis/gcp_config.py

# Copyright 2023 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#      http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

"""Config file for Google Cloud Project (GCP)."""

import dataclasses

from dags.common.vm_resource import Project
from xlml.apis import metric_config


@dataclasses.dataclass
class GCPConfig:
  """This is a class to set up configs of GCP.

  Attributes:
    project_name: Name of a project to provision resource and run a test job.
    zone: The zone to provision resource and run a test job.
    dataset_name: The option of dataset for metrics.
    dataset_project: The name of a project that hosts the dataset.
    composer_project: The name of a project that hosts the composer env.
  """

  project_name: str
  zone: str
  dataset_name: metric_config.DatasetOption
  dataset_project: str = Project.CLOUD_ML_AUTO_SOLUTIONS.value
  composer_project: str = Project.CLOUD_ML_AUTO_SOLUTIONS.value