ads.opctl package

Subpackages

• ads.opctl.backend package
  • Submodules
  • ads.opctl.backend.ads_dataflow module
    • DataFlowBackend
      • DataFlowBackend.apply()
      • DataFlowBackend.cancel()
      • DataFlowBackend.delete()
      • DataFlowBackend.init()
      • DataFlowBackend.run()
      • DataFlowBackend.watch()
    • DataFlowRuntimeFactory
  • ads.opctl.backend.ads_ml_job module
    • JobRuntimeFactory
    • MLJobBackend
      • MLJobBackend.apply()
      • MLJobBackend.cancel()
      • MLJobBackend.delete()
      • MLJobBackend.init()
      • MLJobBackend.init_operator()
      • MLJobBackend.run()
      • MLJobBackend.watch()
    • MLJobDistributedBackend
      • MLJobDistributedBackend.DIAGNOSTIC_COMMAND
      • MLJobDistributedBackend.generate_worker_name()
      • MLJobDistributedBackend.prepare_job_config()
      • MLJobDistributedBackend.run()
      • MLJobDistributedBackend.run_diagnostics()
  • ads.opctl.backend.ads_ml_pipeline module
    • PipelineBackend
      • PipelineBackend.apply()
      • PipelineBackend.cancel()
      • PipelineBackend.delete()
      • PipelineBackend.init()
      • PipelineBackend.run()
      • PipelineBackend.watch()
  • ads.opctl.backend.base module
    • Backend
      • Backend.activate()
      • Backend.apply()
      • Backend.cancel()
      • Backend.deactivate()
      • Backend.delete()
      • Backend.init()
      • Backend.predict()
      • Backend.run()
      • Backend.run_diagnostics()
      • Backend.watch()
    • RuntimeFactory
      • RuntimeFactory.get_runtime()
    • UnsupportedRuntime
  • ads.opctl.backend.local module
  • Module contents
• ads.opctl.conda package
  • Submodules
  • ads.opctl.conda.cli module
  • ads.opctl.conda.cmds module
    • create()
    • install()
    • publish()
  • ads.opctl.conda.multipart_uploader module
    • MultiPartUploader
      • MultiPartUploader.upload()
  • ads.opctl.conda.pack module
  • Module contents
• ads.opctl.config package
  • Subpackages
    • ads.opctl.config.diagnostics package
      • Module contents
    • ads.opctl.config.yaml_parsers package
      • Subpackages
      • Submodules
      • ads.opctl.config.yaml_parsers.base module
      • Module contents
  • Submodules
  • ads.opctl.config.base module
    • ConfigProcessor
      • ConfigProcessor.process()
      • ConfigProcessor.step()
  • ads.opctl.config.merger module
    • ConfigMerger
      • ConfigMerger.process()
  • ads.opctl.config.resolver module
    • ConfigResolver
      • ConfigResolver.process()
  • ads.opctl.config.utils module
    • CondaPackInfoNotProvided
    • NotSupportedError
    • OperatorNotFound
    • convert_notebook()
    • read_from_ini()
  • ads.opctl.config.validator module
    • ConfigValidator
      • ConfigValidator.process()
  • ads.opctl.config.versioner module
    • ConfigVersioner
      • ConfigVersioner.process()
  • Module contents
• ads.opctl.diagnostics package
  • Submodules
  • ads.opctl.diagnostics.check_distributed_job_requirements module
  • ads.opctl.diagnostics.check_requirements module
  • ads.opctl.diagnostics.requirement_exception module
    • RequirementException
  • Module contents
• ads.opctl.distributed package
  • Subpackages
    • ads.opctl.distributed.common package
      • Submodules
      • ads.opctl.distributed.common.abstract_cluster_provider module
      • ads.opctl.distributed.common.abstract_framework_spec_builder module
      • ads.opctl.distributed.common.cluster_config_helper module
      • ads.opctl.distributed.common.cluster_provider_factory module
      • ads.opctl.distributed.common.cluster_runner module
      • ads.opctl.distributed.common.framework_factory module
      • Module contents
  • Submodules
  • ads.opctl.distributed.certificates module
    • download_certificates()
  • ads.opctl.distributed.cli module
  • ads.opctl.distributed.cmds module
  • Module contents
• ads.opctl.spark package
  • Submodules
  • ads.opctl.spark.cli module
  • ads.opctl.spark.cmds module
    • core_site()
    • generate_core_site_properties()
    • generate_core_site_properties_str()
  • Module contents
• ads.opctl.spec package
  • Submodules
  • ads.opctl.spec.abstract_operator_spec module
  • ads.opctl.spec.operator_spec_factory module
  • ads.opctl.spec.utils module
  • Module contents

Submodules

ads.opctl.cli module

ads.opctl.cmds module

ads.opctl.constants module

class ads.opctl.constants.BACKEND_NAME(value)

Bases: ExtendedEnum

An enumeration.

DATAFLOW = 'dataflow'

JOB = 'job'

LOCAL = 'local'

MODEL_DEPLOYMENT = 'deployment'

PIPELINE = 'pipeline'

class ads.opctl.constants.RESOURCE_TYPE(value)

Bases: ExtendedEnum

An enumeration.

DATAFLOW = 'dataflow'

JOB = 'job'

MODEL_DEPLOYMENT = 'deployment'

PIPELINE = 'pipeline'

class ads.opctl.constants.RUNTIME_TYPE(value)

Bases: ExtendedEnum

An enumeration.

CONDA = 'conda'

CONTAINER = 'container'

DATAFLOW = 'dataFlow'

DATAFLOWNOTEBOOK = 'dataFlowNotebook'

GITPYTHON = 'gitPython'

NOTEBOOK = 'notebook'

OPERATOR = 'operator'

PYTHON = 'python'

SCRIPT = 'script'

ads.opctl.utils module

ads.opctl.utils.build_image(image_type: str, gpu: bool = False, source_folder: str | None = None, dst_image: str | None = None) → None

Build an image for opctl.

Parameters:

• image_type (str) – specify the image to build, can take ‘job-local’ or ‘ads-ops-base’, former for running job with conda pack locally, latter for running operators

• gpu (bool) – whether to use gpu version of image

• source_folder (str) – source folder when building custom operator, to be included in custom image

• dst_image (str) – image to save as when building custom operator

Return type:

None

ads.opctl.utils.get_docker_client() → docker.client.DockerClient

ads.opctl.utils.get_namespace(auth: dict) → str

ads.opctl.utils.get_oci_region(auth: dict) → str

ads.opctl.utils.get_region_key(auth: dict) → str

ads.opctl.utils.get_service_pack_prefix() → Dict

ads.opctl.utils.is_in_notebook_session()

ads.opctl.utils.list_ads_operators() → dict

ads.opctl.utils.parse_conda_uri(uri: str) → Tuple[str, str, str, str]

ads.opctl.utils.publish_image(image: str, registry: str | None = None) → None

Publish an image.

Parameters:

• image (str) – image name

• registry (str) – registry to push to

Return type:

None

ads.opctl.utils.run_command(cmd: str | List[str], cwd: str | None = None, shell: bool = False) → Popen

ads.opctl.utils.run_container(image: str, bind_volumes: Dict, env_vars: Dict, command: str = None, entrypoint: str = None, verbose: bool = False)

ads.opctl.utils.suppress_traceback(debug: bool = True) → None

Decorator to suppress traceback when in debug mode.

Parameters:

debug (bool) – turn on debug mode or not

Return type:

None

Module contents

ads.opctl.set_log_level(level)