Oracle Cloud Infrastructure Documentation

Starting a Job Run

Use Data Science job runs to apply various use cases to created jobs.

Job creation sets the infrastructure and the actual use case artifact, but the job run runs the job with the specified parameters. Job runs provision the specified infrastructure, run the job artifact, and then deprovision and destroy the used resources when the job run ends.

  • Using the Console to Start Single Node Job Runs

    Using the Console to Start Single Node Job Runs

    1. From the jobs list page, select the name of the job to work with. If you need help finding the list of jobs, see Listing Jobs.
    2. Select Start a job run.
    3. (Optional) Select a different compartment for the job run.
    4. (Optional) Enter a name for the job run (limit of 255 characters). If you don't provide a name, a name is automatically generated.

      For example, jobrun20210808222435.

    5. (Optional) Override the default job configuration that was defined when the job was created by using these options:
      Enter or select any of the following values:
      Custom environment variable key

      The environment variables that control the job.

      Value

      The value for the custom environment variable key.

      You can select Additional custom environment key to specify more variables.

      Command line arguments

      The command line arguments that you want to use for running the job.

      Maximum runtime (in minutes)

      The maximum number of minutes that the job can run. The service cancels the job run if its runtime exceeds the specified value. The maximum runtime is 30 days (43,200 minutes). We recommend that you configure a maximum runtime on all job runs to prevent runaway job runs.

    6. (Optional) Enter a value for the maximum runtime override (in minutes).
    7. Override the networking resource configuration, that was defined when the job was created.
      The network type can't be changed.
      • If Default Networking is configured, nothing can be overridden.
      • If Custom Networking is configured, you have the option to change the selected VCN and subnet.
    8. (Optional) Change the Compute shape by selecting Change shape. Then, follow these steps in the Select compute panel.
      1. Select an instance type.
      2. Select a shape series.
      3. Select one of the supported Compute shapes in the series.
      4. Select the shape that best suits how you want to use the resource.

        For each OCPU, select up to 64 GB of memory and a maximum total of 512 GB. The minimum amount of memory allowed is either 1 GB or a value matching the number of OCPUs, whichever is greater.

      5. If using burstable VMs, toggle Burstable.
        In Baseline utilization per OCPU select the percentage of OCPUs that you usually want to use. The supported values are 12.5% and 50%.
      6. Select Select shape.
    9. (Optional) Override the Storage configuration.
      Enter the amount of block storage to use between 50 GB and 10, 240 GB (10 TB). You can change the value by 1 GB increments.
    10. Override the environment configuration, that was defined when the job was created, by using these options:
      1. In Environment configuration. select Select. The Set your BYOC environment panel is displayed.
      2. In Repository select a repository from the list. If the repository is in a different compartment, select Change compartment.
      3. In Image select an image from the list.
      4. (Optional) In Entrypoint enter an entry point. To add another, select +Add parameter.
      5. (Optional) In CMD enter a CMD. To add another, select +Add parameter.
        Note

        Use CMD as arguments to the ENTRYPOINT or the only command to run in the absence of an ENTRYPOINT.
      6. (Optional) In Image digest enter an image digest.
      7. (Optional) In Signature ID, if using signature verification, enter the OCID of the image signature. For example, ocid1.containerimagesignature.oc1.iad.aaaaaaaaab....
      8. Select Select.
    11. (Optional) Override the Logging configuration.
      1. Select a log group from the list. You can change to a different compartment to specify a log group in a different compartment from the job.
      2. Select one of the following to store all stdout and stderr messages:
        Enable automatic log creation

        Data Science automatically creates a log when the job starts.

        Select a log

        Select a log to use.

    12. (Optional) Override the start up probe.
      1. Enter a command.
      2. (Optional) To add another command, select +Add command and repeat step a.
      3. (Optional) Enter a value for the initial delay (in seconds).
      4. (Optional) Enter a value of the period.
      5. (Optional) Enter a value for the failure threshold.
      6. Select Save.
    13. (Optional) Select Show advanced options to add tags to the job run.
    14. (Optional) In the Tags section, add one or more tags to the job run. If you have permissions to create a job run, then you also have permissions to apply free-form tags to that job run. To apply a defined tag, you must have permissions to use the tag namespace. For more information about tagging, see Resource Tags. If you're not sure whether to apply tags, skip this option or ask an administrator. You can apply tags later.
    15. Select Start.
    Using the Console to Start Multi Node Job Runs

    Using the Console to Start Multi Node Job Runs

    1. From the jobs list page, select the name of the job to work with. If you need help finding the list of jobs, see Listing Jobs.
    2. Select Start a job run.
    3. (Optional) Select a different compartment for the job run.
    4. (Optional) Enter a name for the job run (limit of 255 characters). If you don't provide a name, a name is automatically generated.

      For example, jobrun20210808222435.

    5. (Optional) Enter a value for the maximum runtime override (in minutes).
    6. Override the networking resource configuration, that was defined when the job was created.
      The network type can't be changed.
      • If Default Networking is configured, nothing can be overridden.
      • If Custom Networking is configured, you have the option to change the selected VCN and subnet.
    7. (Optional) Override the node group configuration, that was defined when the job was created.

      Each node group's configurations can be individually overridden by clicking on the Actions menu (three dots) for the node group and selecting Edit.

      1. (Optional) Override the number of replicas.
      2. (Optional) Override the minimum number of replicas that must succeed.
      3. (Optional) Override the Storage. Enter the amount of block storage to use between 50 GB and 10, 240 GB (10 TB). You can change the value by 1 GB increments.

      4. (Optional) Override the default job configuration using these options:

        Enter or select any of the following values:
        Custom environment variable key

        The environment variables that control the job.

        Value

        The value for the custom environment variable key.

        You can select Additional custom environment key to specify more variables.

        Command line arguments

        The command line arguments that you want to use for running the job.

      5. Change the Compute shape by selecting Change shape. Then, follow these steps in the Select compute panel.
        1. Select an instance type.
        2. Select a shape series.
        3. Select one of the supported Compute shapes in the series.
        4. Select the shape that best suits how you want to use the resource.

          For each OCPU, select up to 64 GB of memory and a maximum total of 512 GB. The minimum amount of memory allowed is either 1 GB or a value matching the number of OCPUs, whichever is greater.

        5. If using burstable VMs, toggle Burstable.
          In Baseline utilization per OCPU select the percentage of OCPUs that you usually want to use. The supported values are 12.5% and 50%.
        6. Select Select shape.
      6. (Optional) Override the Probes configuration:
        1. Enter a command.
        2. (Optional) To add another command, select +Add command and repeat step a.
        3. (Optional) Enter a value for the initial delay (in seconds).
        4. (Optional) Enter a value of the period.
        5. (Optional) Enter a value for the failure threshold.
        6. Select Save.
    8. (Optional) Override the Logging configuration.
      1. Select a log group from the list. You can change to a different compartment to specify a log group in a different compartment from the job.
      2. Select one of the following to store all stdout and stderr messages:
        Enable automatic log creation

        Data Science automatically creates a log when the job starts.

        Select a log

        Select a log to use.

    9. (Optional) Select Show advanced options to add tags to the job run.
    10. (Optional) In the Tags section, add one or more tags to the job run. If you have permissions to create a job run, then you also have permissions to apply free-form tags to that job run. To apply a defined tag, you must have permissions to use the tag namespace. For more information about tagging, see Resource Tags. If you're not sure whether to apply tags, skip this option or ask an administrator. You can apply tags later.
    11. Select Start.

  • These environment variables control the job.

    Use the Data Science CLI to start job runs as in this example:

    1. Start a job run with: 
      oci data-science job-run create \
--display-name <job_run_name> \
--compartment-id <compartment_ocid> \
--project-id <project_ocid> \
--job-id <job_ocid> \
--configuration-override-details file://<optional_job_run_configuration_override_json_file> \
--log-configuration-override-details file://<optional_job_run_logging_configuration_override_json_file>
    2. (Optional) Use this job run configuration override JSON file to override the configurations defined on the parent job: 
      jobEnvironmentConfigurationDetails: {
  jobEnvironmentType: "OCIR_CONTAINER",
    image: "iad.ocir.io/axoxdievda5j/odsc-byod-hello-wrld:0.1.3",
    imageDigest: "sha256",
  cmd: ["ls", "-h"],
  entrypoint: ["-l"],
    imageSignatureId: "ocid1.containerimagesignature.oc1.iad.0.ociodscdev.aaaaaaaaccutw5qdz6twjzkpgmbojdck3qotqqsbn7ph6xcumu4s32o6v5gq",
},
    jobConfigurationDetails: {
        jobType: "DEFAULT",
        environmentVariables: <envar-list-object>},
    ...
}
    3. (Optional) Use this job run logging configuration override JSON file to override the logging configuration defined on the parent job: 
      {
  "enableLogging": true,
  "enableAutoLogCreation": true,
  "logGroupId": "<log_group_ocid>"
}

  • The ADS SDK is also a publicly available Python library that you can install with this command:

    pip install oracle-ads

    It provides the wrapper that makes starting job runs from notebooks or on your client machine easy.

    Use the ADS SDK to start job runs.