Skip to content

Commit 16c21e2

Browse files
authored
hotfix/user guide job example (#88)
2 parents 77577b6 + f9bc491 commit 16c21e2

File tree

2 files changed

+33
-26
lines changed

2 files changed

+33
-26
lines changed

docs/requirements.txt

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
-e .
21
autodoc
32
nbsphinx
43
sphinx

docs/source/user_guide/jobs/run_script.rst

Lines changed: 33 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -128,6 +128,10 @@ This example runs a job with CLI arguments:
128128

129129
.. code-block:: python3
130130
131+
from ads.jobs import Job
132+
from ads.jobs import DataScienceJob
133+
from ads.jobs import ScriptRuntime
134+
131135
job = Job()
132136
job.with_infrastructure(
133137
DataScienceJob()
@@ -161,9 +165,9 @@ You could create the preceding example job with the following YAML file:
161165

162166
.. code-block:: yaml
163167
164-
kind: job
165-
spec:
166-
infrastructure:
168+
kind: job
169+
spec:
170+
infrastructure:
167171
kind: infrastructure
168172
type: dataScienceJob
169173
spec:
@@ -177,14 +181,14 @@ You could create the preceding example job with the following YAML file:
177181
memoryInGBs: 16
178182
ocpus: 1
179183
blockStorageSize: 50
180-
runtime:
181-
kind: runtime
184+
runtime:
185+
kind: runtime
182186
type: python
183-
spec:
184-
args:
185-
- <first_argument>
186-
- <second_argument>
187-
scriptPathURI: job_script_argument.py
187+
spec:
188+
args:
189+
- <first_argument>
190+
- <second_argument>
191+
scriptPathURI: job_script_env.py
188192
189193
190194
Environment Variables
@@ -201,12 +205,16 @@ Suppose you want to run the following python script named ``job_script_env.py``:
201205
202206
import os
203207
import sys
204-
print("Hello " + os.environ["KEY1"] + " and " + os.environ["KEY2"])""")
208+
print("Hello " + os.environ["KEY1"] + " and " + os.environ["KEY2"])
205209
206210
This example runs a job with environment variables:
207211

208212
.. code-block:: python3
209213
214+
from ads.jobs import Job
215+
from ads.jobs import DataScienceJob
216+
from ads.jobs import ScriptRuntime
217+
210218
job = Job()
211219
job.with_infrastructure(
212220
DataScienceJob()
@@ -246,12 +254,12 @@ You could create the preceding example job with the following YAML file:
246254

247255
.. code-block:: yaml
248256
249-
kind: job
250-
spec:
251-
infrastructure:
252-
kind: infrastructure
257+
kind: job
258+
spec:
259+
infrastructure:
260+
kind: infrastructure
253261
type: dataScienceJob
254-
spec:
262+
spec:
255263
logGroupId: <log_group_ocid>
256264
logId: <log_ocid>
257265
compartmentId: <compartment_ocid>
@@ -262,16 +270,16 @@ You could create the preceding example job with the following YAML file:
262270
memoryInGBs: 16
263271
ocpus: 1
264272
blockStorageSize: 50
265-
runtime:
266-
kind: runtime
273+
runtime:
274+
kind: runtime
267275
type: python
268-
spec:
269-
env:
270-
- name: KEY1
271-
value: <first_value>
272-
- name: KEY2
273-
value: <second_value>
274-
scriptPathURI: job_script_env.py
276+
spec:
277+
env:
278+
- name: KEY1
279+
value: <first_value>
280+
- name: KEY2
281+
value: <second_value>
282+
scriptPathURI: job_script_env.py
275283
276284
277285

0 commit comments

Comments
 (0)