Update overview.rst, runtime_non_byoc.rst, and 12 more files...

Author: qiuosier

docs/source/user_guide/jobs/data_science_job.rst

@@ -6,7 +6,7 @@ Quick Start
   Before creating a job, ensure that you have policies configured for Data Science resources.
   See also: :doc:`policies` and  `About Data Science Policies <https://docs.oracle.com/en-us/iaas/data-science/using/policies.htm>`_.
 
-.. include:: ../jobs/components/toc_local.rst
+.. include:: ../jobs/toc_local.rst
 
 Define a Job
 ============
@@ -15,20 +15,21 @@ In ADS, a job is defined by :doc:`infra_and_runtime`.
 The Data Science Job infrastructure is configured through a :py:class:`~ads.jobs.DataScienceJob` instance.
 The runtime can be an instance of:
 
-.. include:: ../jobs/components/runtime_types.rst
+.. include:: ../jobs/runtime_types.rst
 
-Here is an example to define and run a Python :py:class:`~ads.jobs.Job` with the source code from an http
-`link <https://github.com/oracle-samples/oci-data-science-ai-samples/blob/432357b123b7401ef67b116fe19aec217ca920f0/jobs/python/job%2Bsamples/greeting-env-cmd.py>`_:
+Here is an example to define and run a Python :py:class:`~ads.jobs.Job`.
 
 .. include:: ../jobs/tabs/quick_start_job.rst
 
-The source code can be a script, a Jupyter notebook, a folder or a zip file.
-The source code location can be a local or remote, including OCI Object Storage.
-
 The :py:class:`~ads.jobs.PythonRuntime` is designed for :doc:`Running a Python Workload <run_python>`.
-You can also :doc:`run_notebook`, :doc:`run_script` and :doc:`run_git`
+The source code is specified by :py:meth:`~ads.jobs.PythonRuntime.with_source` (``path/to/script.py``).
+It can be a script, a Jupyter notebook, a folder or a zip file.
+The source code location can be a local or remote, including HTTP URL and OCI Object Storage.
+An `example Python script <https://github.com/oracle-samples/oci-data-science-ai-samples/blob/master/jobs/python/job%2Bsamples/greeting-env-cmd.py>`_
+is available on `Data Science AI Sample GitHub Repository <https://github.com/oracle-samples/oci-data-science-ai-samples>`_.
 
 For more details, see :doc:`infra_and_runtime` configurations.
+You can also :doc:`run_notebook`, :doc:`run_script` and :doc:`run_git`.
 
 
 YAML

docs/source/user_guide/jobs/index.rst

@@ -2,6 +2,19 @@
 Data Science Jobs
 #################
 
-.. include:: ../jobs/components/overview.rst
+.. include:: ../jobs/overview.rst
 
-.. include:: ../jobs/toc.rst
+.. toctree::
+  :maxdepth: 1
+
+  ../jobs/data_science_job
+  ../jobs/policies
+  ../jobs/infra_and_runtime
+  ../jobs/run_python
+  ../jobs/run_notebook
+  ../jobs/run_script
+  ../jobs/run_container
+  ../jobs/run_git
+  ../cli/opctl/_template/jobs
+  ../cli/opctl/_template/monitoring
+  ../cli/opctl/localdev/local_jobs

docs/source/user_guide/jobs/infra_and_runtime.rst

@@ -3,7 +3,7 @@ Infrastructure and Runtime
 
 This page describes the configurations of **Infrastructure** and **Runtime** defining a Data Science Job.
 
-.. include:: ../jobs/components/toc_local.rst
+.. include:: ../jobs/toc_local.rst
 
 Example
 =======
@@ -122,7 +122,7 @@ and other configurations for the environment to run the workload.
 Depending on the source code, ADS provides different types of *runtime* for defining a data science job,
 including:
 
-.. include:: ../jobs/components/runtime_types.rst
+.. include:: ../jobs/runtime_types.rst
 
 
 Environment Variables

docs/source/user_guide/jobs/components/overview.rst renamed to docs/source/user_guide/jobs/overview.rst

@@ -20,7 +20,8 @@ You can also sequence jobs and keep the state by writing state information to
 `Object Storage <https://docs.oracle.com/en-us/iaas/Content/Object/Concepts/objectstorageoverview.htm>`_
 
 For example, you may want to experiment with how different model classes perform on the same training data
-by using the [ADSTuner](https://accelerated-data-science.readthedocs.io/en/latest/user_guide/model_training/ads_tuner.html) to perform hyperparameter tuning on each model class.
+by using the `ADSTuner <https://accelerated-data-science.readthedocs.io/en/latest/user_guide/model_training/ads_tuner.html>`_
+to perform hyperparameter tuning on each model class.
 You could do this in parallel by having a different job run for each class of models.
 For a given job run, you could pass an environment variable that identifies the model class that you want to use.
 Each model can write its results to the Logging service or Object Storage.

docs/source/user_guide/jobs/run_python.rst

@@ -6,7 +6,7 @@ You can configure the environment variables, command line arguments and conda en
 as described in :doc:`infra_and_runtime`. This section shows the additional enhancements provided by
 :py:class:`~ads.jobs.PythonRuntime`.
 
-.. include:: ../jobs/components/toc_local.rst
+.. include:: ../jobs/toc_local.rst
 
 Here is an example to define and run a job using :py:class:`~ads.jobs.PythonRuntime`:
 

docs/source/user_guide/jobs/components/runtime_non_byoc.rst renamed to docs/source/user_guide/jobs/runtime_non_byoc.rst

@@ -1,11 +1,11 @@
 * :py:class:`~ads.jobs.PythonRuntime`
   for Python code stored locally, OCI object storage, or other remote location supported by
-  `fsspec <https://filesystem-spec.readthedocs.io/en/latest/>`_. See :doc:`run_python`.
+  `fsspec <https://filesystem-spec.readthedocs.io/en/latest/>`_. See :doc:`../jobs/run_python`.
 * :py:class:`~ads.jobs.GitPythonRuntime`
-  for Python code from a Git repository. See :doc:`run_git`.
+  for Python code from a Git repository. See :doc:`../jobs/run_git`.
 * :py:class:`~ads.jobs.NotebookRuntime`
   for a single Jupyter notebook stored locally, OCI object storage, or other remote location supported by
-  `fsspec <https://filesystem-spec.readthedocs.io/en/latest/>`_. See :doc:`run_notebook`.
+  `fsspec <https://filesystem-spec.readthedocs.io/en/latest/>`_. See :doc:`../jobs/run_notebook`.
 * :py:class:`~ads.jobs.ScriptRuntime`
   for bash or shell scripts stored locally, OCI object storage, or other remote location supported by
-  `fsspec <https://filesystem-spec.readthedocs.io/en/latest/>`_. See :doc:`run_script`.
+  `fsspec <https://filesystem-spec.readthedocs.io/en/latest/>`_. See :doc:`../jobs/run_script`.

docs/source/user_guide/jobs/components/runtime_types.rst renamed to docs/source/user_guide/jobs/runtime_types.rst

@@ -1,3 +1,3 @@
-.. include:: ../jobs/components/runtime_non_byoc.rst
+.. include:: ../jobs/runtime_non_byoc.rst
 
 * :py:class:`~ads.jobs.ContainerRuntime` for container images.

docs/source/user_guide/jobs/toc.rst

@@ -93,7 +93,7 @@ When constructing a Custom Scrip step ``infrastructure``, you specify the Comput
 
 A Custom Script step can have different types of ``runtime`` depending on the source code you run:
 
-.. include:: ../jobs/components/runtime_non_byoc.rst
+.. include:: ../jobs/runtime_non_byoc.rst
 
 All of these runtime options allow you to configure a `Data Science Conda Environment <https://docs.oracle.com/iaas/data-science/using/conda_understand_environments.htm>`__ for running your code. 
 
@@ -182,7 +182,7 @@ To define a Custom Script step with ``PythonRuntime`` you can use:
 	kind: runtime
 	spec:
 	  conda:
-		slug: pytorch19_p37_cpu_v1
+		slug: pytorch110_p38_cpu_v1
 		type: service
 	  entrypoint: zip_or_dir/my_package/entry.py
 	  outputDir: output
@@ -200,7 +200,7 @@ To define a Custom Script step with ``PythonRuntime`` you can use:
 
     runtime = (
         PythonRuntime()
-        .with_service_conda("pytorch19_p37_cpu_v1")
+        .with_service_conda("pytorch110_p38_cpu_v1")
         # The job artifact directory is named "zip_or_dir"
         .with_source("local/path/to/zip_or_dir", entrypoint="zip_or_dir/my_package/entry.py")
         # Change the working directory to be inside the job artifact directory