Skip to content

Commit 5c26ba3

Browse files
committed
Update infrastructure.rst
1 parent 937e79d commit 5c26ba3

File tree

1 file changed

+14
-10
lines changed

1 file changed

+14
-10
lines changed

docs/source/user_guide/jobs/infrastructure.rst

Lines changed: 14 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
Infrastructure
22
**************
33

4-
The Data Science Job infrastructure is defined by a
5-
:py:class:`~ads.jobs.builders.infrastructure.dsc_job.DataScienceJob` instance. For example:
4+
The Data Science Job infrastructure is defined by a :py:class:`~ads.jobs.DataScienceJob` instance.
5+
For example:
66

77

88
.. code-block:: python3
@@ -23,14 +23,14 @@ The Data Science Job infrastructure is defined by a
2323
.with_log_id("<log_ocid>")
2424
)
2525
26-
When creating a :py:class:`~ads.jobs.builders.infrastructure.dsc_job.DataScienceJob` instance,
27-
the following configurations are required:
26+
When creating a :py:class:`~ads.jobs.DataScienceJob` instance, the following configurations are required:
2827

2928
* Compartment ID
3029
* Project ID
3130
* Compute Shape
3231

3332
The following configurations are optional:
33+
3434
* Block Storage Size, defaults to 50 (GB)
3535
* Log Group ID
3636
* Log ID
@@ -41,7 +41,7 @@ Using Configurations from Notebook
4141
If you are creating a job from an OCI Data Science
4242
`Notebook Session <https://docs.oracle.com/en-us/iaas/data-science/using/manage-notebook-sessions.htm>`_,
4343
the same infrastructure configurations from the notebook session will be used as defaults.
44-
You can initialize the :py:class:`~ads.jobs.builders.infrastructure.dsc_job.DataScienceJob`
44+
You can initialize the :py:class:`~ads.jobs.DataScienceJob`
4545
with the logging configurations and override the other options as needed. For example:
4646

4747
.. code-block:: python3
@@ -62,9 +62,13 @@ with the logging configurations and override the other options as needed. For ex
6262
Compute Shapes
6363
==============
6464

65-
You can get a list of currently supported compute shapes by calling ``DataScienceJob.instance_shapes()``.
66-
Additionally, you can get a list of shapes are available for fast launch by calling ``DataScienceJob.fast_launch_shapes()``
67-
Specifying a fast launch shape will allow your job to start as fast as possible.
65+
The :py:class:`~ads.jobs.DataScienceJob` class provides two static methods to obtain the support compute shapes:
66+
67+
* You can get a list of currently supported compute shapes by calling
68+
:py:meth:`~ads.jobs.DataScienceJob.instance_shapes`.
69+
* can get a list of shapes are available for fast launch by calling
70+
:py:meth:`~ads.jobs.DataScienceJob.fast_launch_shapes`.
71+
Specifying a fast launch shape will allow your job to start as fast as possible.
6872

6973
Networking
7074
==========
@@ -77,7 +81,7 @@ You can control the network access through the subnet and security lists.
7781
If you specified a subnet ID, your job will be configured to have custom networking.
7882
Otherwise, default networking will be used. Note that when you are in a Data Science Notebook Session,
7983
the same networking configuration is be used by default.
80-
You can specify the networking manually by calling ``with_job_infrastructure_type()``.
84+
You can specify the networking manually by calling :py:meth:`~ads.jobs.DataScienceJob.with_job_infrastructure_type()`.
8185

8286
Logging
8387
=======
@@ -86,7 +90,7 @@ Logging is not required to create the job.
8690
However, it is highly recommended to enable logging for debugging and monitoring purpose.
8791

8892
In the preceding example, both the log OCID and corresponding log group OCID are specified
89-
with the ``DataScienceJob`` instance.
93+
with the :py:class:`~ads.jobs.DataScienceJob` instance.
9094
If your administrator configured the permission for you to search for logging resources,
9195
you can skip specifying the log group OCID because ADS can automatically retrieve it.
9296

0 commit comments

Comments
 (0)