Skip to content

Commit 9b4c130

Browse files
committed
Update _test_and_submit.rst to show the --yaml option.
1 parent e2a8e3e commit 9b4c130

File tree

1 file changed

+8
-5
lines changed

1 file changed

+8
-5
lines changed

docs/source/user_guide/model_training/distributed_training/_test_and_submit.rst

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
**Test Locally:**
22

33
Before submitting the workload to jobs, you can run it locally to test your code, dependencies, configurations etc.
4-
With ``-b local`` flag, it uses a local backend. Further when you need to run this workload on odsc jobs, simply use ``-b job`` flag instead.
4+
With ``-b local`` flag, it uses a local backend. Further when you need to run this workload on OCI data science jobs, simply use ``-b job`` flag instead.
55

66
.. code-block:: bash
77
@@ -13,6 +13,9 @@ If your code requires to use any oci services (like object bucket), you need to
1313
1414
oci_key_mnt = ~/.oci:/home/oci_dist_training/.oci
1515
16+
Note that the local backend requires the source code for your workload is available locally in the source folder specified in the ``config.ini`` file.
17+
If you specified Git repository or OCI object storage location as source code location in your workflow YAML, please make sure you have a local copy available for local testing.
18+
1619
**Submit the workload:**
1720

1821
.. code-block:: bash
@@ -22,7 +25,7 @@ If your code requires to use any oci services (like object bucket), you need to
2225
**Note:**: This will automatically push the docker image to the
2326
OCI `container registry repo <https://docs.oracle.com/en-us/iaas/Content/Registry/Concepts/registryoverview.htm>`_ .
2427

25-
Once running, you will see on the terminal an output similar to the below
28+
Once running, you will see on the terminal outputs similar to the below
2629

2730
.. code-block:: yaml
2831
:caption: info.yaml
@@ -36,9 +39,9 @@ Once running, you will see on the terminal an output similar to the below
3639
- workerJobRunIdName_2: oci.xxxx.<job_run_ocid>
3740
- workerJobRunIdName_3: oci.xxxx.<job_run_ocid>
3841
39-
Note that this yaml can be used as input to ``ads opctl distributed-training show-config -f <info.yaml>``.
40-
You can use ``tee`` to both save and see the job run info, for example:
42+
This information can be saved as YAML file and used as input to ``ads opctl distributed-training show-config -f <info.yaml>``.
43+
You can use ``--yaml`` to save the job run info into YAML, for example:
4144

4245
.. code-block:: bash
4346
44-
ads opctl run -f train.yaml | tee info.yaml
47+
ads opctl run -f train.yaml --yaml info.yaml

0 commit comments

Comments
 (0)