Skip to content

Commit c1161e2

Browse files
authored
Update user guide for Data Science Jobs (#94)
2 parents 888ad02 + a26f2bb commit c1161e2

36 files changed

+1987
-1414
lines changed

docs/source/ads.jobs.rst

Lines changed: 19 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,16 @@
11
ads.jobs package
22
================
33

4+
.. toctree::
5+
:maxdepth: 3
6+
7+
ads.jobs
8+
49
Subpackages
510
-----------
611

712
.. toctree::
8-
:maxdepth: 4
13+
:maxdepth: 1
914

1015
ads.jobs.builders
1116
ads.jobs.schema
@@ -15,52 +20,58 @@ Submodules
1520
----------
1621

1722
ads.jobs.ads\_job module
18-
------------------------
23+
~~~~~~~~~~~~~~~~~~~~~~~~
1924

2025
.. automodule:: ads.jobs.ads_job
2126
:members:
2227
:undoc-members:
2328
:show-inheritance:
29+
:inherited-members:
2430

2531
ads.jobs.cli module
26-
-------------------
32+
~~~~~~~~~~~~~~~~~~~
2733

2834
.. automodule:: ads.jobs.cli
2935
:members:
3036
:undoc-members:
3137
:show-inheritance:
38+
:inherited-members:
3239

3340
ads.jobs.env\_var\_parser module
34-
--------------------------------
41+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3542

3643
.. automodule:: ads.jobs.env_var_parser
3744
:members:
3845
:undoc-members:
3946
:show-inheritance:
47+
:inherited-members:
4048

4149
ads.jobs.extension module
42-
-------------------------
50+
~~~~~~~~~~~~~~~~~~~~~~~~~
4351

4452
.. automodule:: ads.jobs.extension
4553
:members:
4654
:undoc-members:
4755
:show-inheritance:
56+
:inherited-members:
4857

4958
ads.jobs.serializer module
50-
--------------------------
59+
~~~~~~~~~~~~~~~~~~~~~~~~~~
5160

5261
.. automodule:: ads.jobs.serializer
5362
:members:
5463
:undoc-members:
5564
:show-inheritance:
65+
:inherited-members:
5666

5767
ads.jobs.utils module
58-
---------------------
68+
~~~~~~~~~~~~~~~~~~~~~
5969

6070
.. automodule:: ads.jobs.utils
6171
:members:
6272
:undoc-members:
6373
:show-inheritance:
74+
:inherited-members:
6475

6576
Module contents
6677
---------------
@@ -69,3 +80,4 @@ Module contents
6980
:members:
7081
:undoc-members:
7182
:show-inheritance:
83+
:inherited-members:

docs/source/ads.tests.rst

Lines changed: 0 additions & 29 deletions
This file was deleted.

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

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
1-
++++++++++++++++++++++++++++++++++++++++++++
2-
Working with OCI Data Science Jobs Using CLI
3-
++++++++++++++++++++++++++++++++++++++++++++
1+
++++++++++++++++++++
2+
Working with the CLI
3+
++++++++++++++++++++
44

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/_template/runtime_types.rst

Lines changed: 0 additions & 4 deletions
This file was deleted.

0 commit comments

Comments
 (0)