Update infrastructure config example code.

qiuosier · qiuosier · commit 654542edcb61 · 2023-03-01T13:37:23.000-05:00
diff --git a/docs/source/user_guide/jobs/infra_and_runtime.rst b/docs/source/user_guide/jobs/infra_and_runtime.rst
@@ -18,23 +18,7 @@ Infrastructure
 The Data Science Job infrastructure is defined by a :py:class:`~ads.jobs.DataScienceJob` instance.
 For example:
 
-.. code-block:: python3
-
-    from ads.jobs import DataScienceJob
-
-    infrastructure = (
-        DataScienceJob()
-        .with_compartment_id("<compartment_ocid>")
-        .with_project_id("<project_ocid>")
-        .with_subnet_id("<subnet_ocid>")
-        .with_shape_name("VM.Standard.E3.Flex")
-        # Shape config details are applicable only for the flexible shapes.
-        .with_shape_config_details(memory_in_gbs=16, ocpus=1)
-        # Minimum block storage size is 50 (GB)
-        .with_block_storage_size(50)
-        .with_log_group_id("<log_group_ocid>")
-        .with_log_id("<log_ocid>")
-    )
+.. include:: ../jobs/tabs/infra_config.rst
 
 When creating a :py:class:`~ads.jobs.DataScienceJob` instance, the following configurations are required:
 
@@ -55,11 +39,21 @@ Using Configurations from Notebook
 
 If you are creating a job from an OCI Data Science
 `Notebook Session <https://docs.oracle.com/en-us/iaas/data-science/using/manage-notebook-sessions.htm>`_,
-the same infrastructure configurations from the notebook session will be used as defaults.
+the same infrastructure configurations from the notebook session will be used as defaults, including:
+
+* Compartment ID
+* Project ID
+* Subnet ID
+* Compute Shape
+* Block Storage Size
+
 You can initialize the :py:class:`~ads.jobs.DataScienceJob`
 with the logging configurations and override the other options as needed. For example:
 
-.. code-block:: python3
+.. tabs::
+
+  .. code-tab:: python
+    :caption: Python
 
     from ads.jobs import DataScienceJob
 
@@ -69,11 +63,22 @@ with the logging configurations and override the other options as needed. For ex
         .with_log_id("<log_ocid>")
         # Use a GPU shape for the job,
         # regardless of the shape used by the notebook session
-        .with_shape_name("VM.GPU2.1")
+        .with_shape_name("VM.GPU3.1")
         # compartment ID, project ID, subnet ID and block storage will be
         # the same as the ones set in the notebook session
     )
 
+  .. code-tab:: yaml
+    :caption: YAML
+
+    kind: infrastructure
+    type: dataScienceJob
+    spec:
+      logGroupId: <log_group_ocid>
+      logId: <log_ocid>
+      shapeName: VM.GPU3.1
+
+
 Compute Shapes
 --------------
 
@@ -136,7 +141,7 @@ Environment variables enclosed by ``${...}`` will be substituted. For example:
 
 .. include:: ../jobs/tabs/runtime_envs.rst
 
-.. code-block:: python3
+.. code-block:: python
 
   for k, v in runtime.environment_variables.items():
       print(f"{k}: {v}")
diff --git a/docs/source/user_guide/jobs/tabs/container_runtime.rst b/docs/source/user_guide/jobs/tabs/container_runtime.rst
@@ -6,30 +6,32 @@
     from ads.jobs import Job, DataScienceJob, ContainerRuntime
 
     job = (
-      Job(name="My Job")
-      .with_infrastructure(
-        DataScienceJob()
-        .with_log_group_id("<log_group_ocid>")
-        .with_log_id("<log_ocid>")
-        # The following infrastructure configurations are optional
-        # if you are in an OCI data science notebook session.
-        # The configurations of the notebook session will be used as defaults.
-        .with_compartment_id("<compartment_ocid>")
-        .with_project_id("<project_ocid>")
-        # For default networking, no need to specify subnet ID
-        .with_subnet_id("<subnet_ocid>")
-        .with_shape_name("VM.Standard.E3.Flex")
-        # Shape config details are applicable only for the flexible shapes.
-        .with_shape_config_details(memory_in_gbs=16, ocpus=1)
-        .with_block_storage_size(50)
-      )
-      .with_runtime(
-        ContainerRuntime()
-        .with_image("<region>.ocir.io/<your_tenancy>/<your_image>")
-        .with_environment_variable(GREETINGS="Welcome to OCI Data Science")
-        .with_entrypoint(["/bin/sh", "-c"])
-        .with_cmd("sleep 5 && echo $GREETINGS")
-      )
+        Job(name="My Job")
+        .with_infrastructure(
+            DataScienceJob()
+            # Configure logging for getting the job run outputs.
+            .with_log_group_id("<log_group_ocid>")
+            # Log resource will be auto-generated if log ID is not specified.
+            .with_log_id("<log_ocid>")
+            # If you are in an OCI data science notebook session,
+            # the following configurations are not required.
+            # Configurations from the notebook session will be used as defaults.
+            .with_compartment_id("<compartment_ocid>")
+            .with_project_id("<project_ocid>")
+            .with_subnet_id("<subnet_ocid>")
+            .with_shape_name("VM.Standard.E3.Flex")
+            # Shape config details are applicable only for the flexible shapes.
+            .with_shape_config_details(memory_in_gbs=16, ocpus=1)
+            # Minimum/Default block storage size is 50 (GB).
+            .with_block_storage_size(50)
+        )
+        .with_runtime(
+            ContainerRuntime()
+            .with_image("<region>.ocir.io/<your_tenancy>/<your_image>")
+            .with_environment_variable(GREETINGS="Welcome to OCI Data Science")
+            .with_entrypoint(["/bin/sh", "-c"])
+            .with_cmd("sleep 5 && echo $GREETINGS")
+        )
     )
 
   .. code-tab:: yaml
@@ -45,7 +47,6 @@
           blockStorageSize: 50
           compartmentId: <compartment_ocid>
           jobInfrastructureType: STANDALONE
-          jobType: DEFAULT
           logGroupId: <log_group_ocid>
           logId: <log_ocid>
           projectId: <project_ocid>
diff --git a/docs/source/user_guide/jobs/tabs/git_notebook.rst b/docs/source/user_guide/jobs/tabs/git_notebook.rst
@@ -9,18 +9,20 @@
         Job(name="My Job")
         .with_infrastructure(
             DataScienceJob()
+            # Configure logging for getting the job run outputs.
             .with_log_group_id("<log_group_ocid>")
+            # Log resource will be auto-generated if log ID is not specified.
             .with_log_id("<log_ocid>")
-            # The following infrastructure configurations are optional
-            # if you are in an OCI data science notebook session.
-            # The configurations of the notebook session will be used as defaults.
+            # If you are in an OCI data science notebook session,
+            # the following configurations are not required.
+            # Configurations from the notebook session will be used as defaults.
             .with_compartment_id("<compartment_ocid>")
             .with_project_id("<project_ocid>")
-            # For default networking, no need to specify subnet ID
             .with_subnet_id("<subnet_ocid>")
             .with_shape_name("VM.Standard.E3.Flex")
             # Shape config details are applicable only for the flexible shapes.
             .with_shape_config_details(memory_in_gbs=16, ocpus=1)
+            # Minimum/Default block storage size is 50 (GB).
             .with_block_storage_size(50)
         )
         .with_runtime(
@@ -47,7 +49,6 @@
           blockStorageSize: 50
           compartmentId: <compartment_ocid>
           jobInfrastructureType: STANDALONE
-          jobType: DEFAULT
           logGroupId: <log_group_ocid>
           logId: <log_ocid>
           projectId: <project_ocid>
diff --git a/docs/source/user_guide/jobs/tabs/git_runtime.rst b/docs/source/user_guide/jobs/tabs/git_runtime.rst
@@ -9,18 +9,20 @@
         Job(name="My Job")
         .with_infrastructure(
             DataScienceJob()
+            # Configure logging for getting the job run outputs.
             .with_log_group_id("<log_group_ocid>")
+            # Log resource will be auto-generated if log ID is not specified.
             .with_log_id("<log_ocid>")
-            # The following infrastructure configurations are optional
-            # if you are in an OCI data science notebook session.
-            # The configurations of the notebook session will be used as defaults.
+            # If you are in an OCI data science notebook session,
+            # the following configurations are not required.
+            # Configurations from the notebook session will be used as defaults.
             .with_compartment_id("<compartment_ocid>")
             .with_project_id("<project_ocid>")
-            # For default networking, no need to specify subnet ID
             .with_subnet_id("<subnet_ocid>")
             .with_shape_name("VM.Standard.E3.Flex")
             # Shape config details are applicable only for the flexible shapes.
             .with_shape_config_details(memory_in_gbs=16, ocpus=1)
+            # Minimum/Default block storage size is 50 (GB).
             .with_block_storage_size(50)
         )
         .with_runtime(
@@ -54,7 +56,6 @@
           blockStorageSize: 50
           compartmentId: <compartment_ocid>
           jobInfrastructureType: STANDALONE
-          jobType: DEFAULT
           logGroupId: <log_group_ocid>
           logId: <log_ocid>
           projectId: <project_ocid>
diff --git a/docs/source/user_guide/jobs/tabs/infra_config.rst b/docs/source/user_guide/jobs/tabs/infra_config.rst
@@ -0,0 +1,42 @@
+.. tabs::
+
+  .. code-tab:: python
+    :caption: Python
+
+    from ads.jobs import Job, DataScienceJob, GitPythonRuntime
+
+    infrastructure = (
+        DataScienceJob()
+        # Configure logging for getting the job run outputs.
+        .with_log_group_id("<log_group_ocid>")
+        # Log resource will be auto-generated if log ID is not specified.
+        .with_log_id("<log_ocid>")
+        # If you are in an OCI data science notebook session,
+        # the following configurations are not required.
+        # Configurations from the notebook session will be used as defaults.
+        .with_compartment_id("<compartment_ocid>")
+        .with_project_id("<project_ocid>")
+        .with_subnet_id("<subnet_ocid>")
+        .with_shape_name("VM.Standard.E3.Flex")
+        # Shape config details are applicable only for the flexible shapes.
+        .with_shape_config_details(memory_in_gbs=16, ocpus=1)
+        # Minimum/Default block storage size is 50 (GB).
+        .with_block_storage_size(50)
+    )
+
+  .. code-tab:: yaml
+    :caption: YAML
+
+    kind: infrastructure
+    type: dataScienceJob
+    spec:
+      blockStorageSize: 50
+      compartmentId: <compartment_ocid>
+      logGroupId: <log_group_ocid>
+      logId: <log_ocid>
+      projectId: <project_ocid>
+      shapeConfigDetails:
+        memoryInGBs: 16
+        ocpus: 1
+      shapeName: VM.Standard.E3.Flex
+      subnetId: <subnet_ocid>
diff --git a/docs/source/user_guide/jobs/tabs/name_substitution.rst b/docs/source/user_guide/jobs/tabs/name_substitution.rst
@@ -36,7 +36,6 @@
         type: dataScienceJob
         spec:
           compartmentId: <compartment_ocid>
-          jobType: DEFAULT
           logGroupId: <log_group_ocid>
           logId: <log_ocid>
           projectId: <project_ocid>
diff --git a/docs/source/user_guide/jobs/tabs/notebook_runtime.rst b/docs/source/user_guide/jobs/tabs/notebook_runtime.rst
@@ -9,18 +9,20 @@
         Job(name="My Job")
         .with_infrastructure(
             DataScienceJob()
+            # Configure logging for getting the job run outputs.
             .with_log_group_id("<log_group_ocid>")
+            # Log resource will be auto-generated if log ID is not specified.
             .with_log_id("<log_ocid>")
-            # The following infrastructure configurations are optional
-            # if you are in an OCI data science notebook session.
-            # The configurations of the notebook session will be used as defaults.
+            # If you are in an OCI data science notebook session,
+            # the following configurations are not required.
+            # Configurations from the notebook session will be used as defaults.
             .with_compartment_id("<compartment_ocid>")
             .with_project_id("<project_ocid>")
-            # For default networking, no need to specify subnet ID
             .with_subnet_id("<subnet_ocid>")
             .with_shape_name("VM.Standard.E3.Flex")
             # Shape config details are applicable only for the flexible shapes.
             .with_shape_config_details(memory_in_gbs=16, ocpus=1)
+            # Minimum/Default block storage size is 50 (GB).
             .with_block_storage_size(50)
         )
         .with_runtime(
@@ -49,7 +51,6 @@
           blockStorageSize: 50
           compartmentId: <compartment_ocid>
           jobInfrastructureType: STANDALONE
-          jobType: DEFAULT
           logGroupId: <log_group_ocid>
           logId: <log_ocid>
           projectId: <project_ocid>
diff --git a/docs/source/user_guide/jobs/tabs/python_runtime.rst b/docs/source/user_guide/jobs/tabs/python_runtime.rst
@@ -9,18 +9,20 @@
         Job(name="My Job")
         .with_infrastructure(
             DataScienceJob()
+            # Configure logging for getting the job run outputs.
             .with_log_group_id("<log_group_ocid>")
+            # Log resource will be auto-generated if log ID is not specified.
             .with_log_id("<log_ocid>")
-            # The following infrastructure configurations are optional
-            # if you are in an OCI data science notebook session.
-            # The configurations of the notebook session will be used as defaults.
+            # If you are in an OCI data science notebook session,
+            # the following configurations are not required.
+            # Configurations from the notebook session will be used as defaults.
             .with_compartment_id("<compartment_ocid>")
             .with_project_id("<project_ocid>")
-            # For default networking, no need to specify subnet ID
             .with_subnet_id("<subnet_ocid>")
             .with_shape_name("VM.Standard.E3.Flex")
             # Shape config details are applicable only for the flexible shapes.
             .with_shape_config_details(memory_in_gbs=16, ocpus=1)
+            # Minimum/Default block storage size is 50 (GB).
             .with_block_storage_size(50)
         )
         .with_runtime(
@@ -61,7 +63,6 @@
           blockStorageSize: 50
           compartmentId: <compartment_ocid>
           jobInfrastructureType: STANDALONE
-          jobType: DEFAULT
           logGroupId: <log_group_ocid>
           logId: <log_ocid>
           projectId: <project_ocid>
diff --git a/docs/source/user_guide/jobs/tabs/quick_start_job.rst b/docs/source/user_guide/jobs/tabs/quick_start_job.rst
@@ -9,18 +9,20 @@
         Job(name="My Job")
         .with_infrastructure(
             DataScienceJob()
+            # Configure logging for getting the job run outputs.
             .with_log_group_id("<log_group_ocid>")
+            # Log resource will be auto-generated if log ID is not specified.
             .with_log_id("<log_ocid>")
-            # The following infrastructure configurations are optional
-            # if you are in an OCI data science notebook session.
-            # The configurations of the notebook session will be used as defaults.
+            # If you are in an OCI data science notebook session,
+            # the following configurations are not required.
+            # Configurations from the notebook session will be used as defaults.
             .with_compartment_id("<compartment_ocid>")
             .with_project_id("<project_ocid>")
-            # For default networking, no need to specify subnet ID
             .with_subnet_id("<subnet_ocid>")
             .with_shape_name("VM.Standard.E3.Flex")
             # Shape config details are applicable only for the flexible shapes.
             .with_shape_config_details(memory_in_gbs=16, ocpus=1)
+            # Minimum/Default block storage size is 50 (GB).
             .with_block_storage_size(50)
         )
         .with_runtime(
@@ -49,7 +51,6 @@
           blockStorageSize: 50
           compartmentId: <compartment_ocid>
           jobInfrastructureType: STANDALONE
-          jobType: DEFAULT
           logGroupId: <log_group_ocid>
           logId: <log_ocid>
           projectId: <project_ocid>
diff --git a/docs/source/user_guide/jobs/tabs/script_runtime.rst b/docs/source/user_guide/jobs/tabs/script_runtime.rst
@@ -9,18 +9,20 @@
         Job(name="My Job")
         .with_infrastructure(
             DataScienceJob()
+            # Configure logging for getting the job run outputs.
             .with_log_group_id("<log_group_ocid>")
+            # Log resource will be auto-generated if log ID is not specified.
             .with_log_id("<log_ocid>")
-            # The following infrastructure configurations are optional
-            # if you are in an OCI data science notebook session.
-            # The configurations of the notebook session will be used as defaults.
+            # If you are in an OCI data science notebook session,
+            # the following configurations are not required.
+            # Configurations from the notebook session will be used as defaults.
             .with_compartment_id("<compartment_ocid>")
             .with_project_id("<project_ocid>")
-            # For default networking, no need to specify subnet ID
             .with_subnet_id("<subnet_ocid>")
             .with_shape_name("VM.Standard.E3.Flex")
             # Shape config details are applicable only for the flexible shapes.
             .with_shape_config_details(memory_in_gbs=16, ocpus=1)
+            # Minimum/Default block storage size is 50 (GB).
             .with_block_storage_size(50)
         )
         .with_runtime(
@@ -53,7 +55,6 @@
           blockStorageSize: 50
           compartmentId: <compartment_ocid>
           jobInfrastructureType: STANDALONE
-          jobType: DEFAULT
           logGroupId: <log_group_ocid>
           logId: <log_ocid>
           projectId: <project_ocid>
diff --git a/docs/source/user_guide/jobs/tabs/training_job.rst b/docs/source/user_guide/jobs/tabs/training_job.rst
