Skip to content

Commit 073a661

Browse files
committed
Update jobs.rst, data_science_job.rst, and 2 more files...
1 parent 1f97dc3 commit 073a661

File tree

4 files changed

+13
-13
lines changed

4 files changed

+13
-13
lines changed

docs/source/user_guide/cli/opctl/_template/jobs.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,14 @@ Working with the CLI
55
Prerequisite
66
------------
77

8-
.. include:: jobs_local_prerequisite.rst
8+
:doc:`Install ADS CLI <../../quickstart>`
99

1010
Running a Pre Defined Job
1111
-------------------------
1212

1313
.. code-block:: shell
1414
15-
aads opctl run -j <job ocid>
15+
ads opctl run -j <job ocid>
1616
1717
Delete Job or Job Run
1818
---------------------

docs/source/user_guide/jobs/data_science_job.rst

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
11
Quick Start
22
***********
33

4-
.. admonition:: OCI Data Science Policies
4+
.. admonition:: Prerequisite
55

66
Before creating a job, ensure that you have policies configured for Data Science resources.
7-
See also: :doc:`policies` and `About Data Science Policies <https://docs.oracle.com/en-us/iaas/data-science/using/policies.htm>`_.
7+
8+
See :doc:`policies` and `About Data Science Policies <https://docs.oracle.com/en-us/iaas/data-science/using/policies.htm>`_.
89

910
.. include:: ../jobs/toc_local.rst
1011

@@ -79,10 +80,6 @@ to create the job on OCI. To start a job run, you can call the :py:meth:`~ads.jo
7980
which returns a :py:class:`~ads.jobs.DataScienceJobRun` instance.
8081
Once the job or job run is created, the job OCID can be accessed through ``job.id`` or ``run.id``.
8182

82-
The :py:meth:`~ads.jobs.DataScienceJobRun.watch` method is useful to monitor the progress of the job run.
83-
It will stream the logs to terminal and return once the job is finished.
84-
Logging configurations are required for this method to show logs.
85-
8683
.. code-block:: python
8784
8885
# Create the job on OCI Data Science
@@ -92,7 +89,9 @@ Logging configurations are required for this method to show logs.
9289
# Stream the job run outputs
9390
run.watch()
9491
95-
Here is an example of the logs:
92+
The :py:meth:`~ads.jobs.DataScienceJobRun.watch` method is useful to monitor the progress of the job run.
93+
It will stream the logs to terminal and return once the job is finished.
94+
Logging configurations are required for this method to show logs. Here is an example of the logs:
9695

9796
.. code-block:: text
9897

docs/source/user_guide/jobs/infra_and_runtime.rst

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -113,6 +113,8 @@ If you specify only the log group OCID and no log OCID,
113113
a new Log resource is automatically created within the log group to store the logs,
114114
see also `ADS Logging <../logging/logging.html>`_.
115115

116+
With logging configured, you can call :py:meth:`~ads.jobs.DataScienceJobRun.watch` method to stream the logs.
117+
116118
Runtime
117119
=======
118120

@@ -217,10 +219,9 @@ Here are a few more examples:
217219
Conda Environment
218220
-----------------
219221

220-
Except for :py:class:`~ads.jobs.ContainerRuntime`,
221-
all the other runtime options allow you to configure a
222+
You can configure a
222223
`Conda Environment <https://docs.oracle.com/en-us/iaas/data-science/using/conda_understand_environments.htm>`_
223-
for your workload. You can use the slug name to specify a
224+
for running your workload. You can use the slug name to specify a
224225
`conda environment provided by the data science service
225226
<https://docs.oracle.com/en-us/iaas/data-science/using/conda_viewing.htm#conda-dsenvironments>`_.
226227
For example, to use the TensorFlow conda environment:

docs/source/user_guide/jobs/run_python.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ Run a Python Workload
22
*********************
33

44
The :py:class:`~ads.jobs.PythonRuntime` is designed for running a Python workload.
5-
You can configure the environment variables, command line arguments and conda environment
5+
You can configure the environment variables, command line arguments, and conda environment
66
as described in :doc:`infra_and_runtime`. This section shows the additional enhancements provided by
77
:py:class:`~ads.jobs.PythonRuntime`.
88

0 commit comments

Comments
 (0)