Merge pull request #2 from oracle/docs_update_video_links

Update demo links in the documentaion.

Author: mrDzurb

docs/source/conf.py

@@ -33,21 +33,21 @@
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
 extensions = [
+    "sphinx.ext.napoleon",
     "sphinx.ext.autodoc",
+    "sphinx.ext.doctest",
+    "sphinx.ext.ifconfig",
+    "sphinx.ext.todo",
+    "sphinx.ext.extlinks",
+    "sphinx.ext.intersphinx",
     "nbsphinx",
     "sphinx_code_tabs",
-    "sphinx_rtd_theme",
+    "sphinx_copybutton",
     "sphinx.ext.duration",
-    "sphinx.ext.doctest",
-    "sphinx.ext.autodoc",
     "sphinx.ext.autosummary",
     "sphinx.ext.intersphinx",
     "sphinx.ext.viewcode",
-    "sphinx.ext.napoleon",
-    "sphinx_copybutton",
-    "sphinx.ext.todo",
-    "sphinx_design",
-    "sphinx.ext.extlinks",
+    "sphinx_autorun",
 ]
 
 intersphinx_mapping = {
@@ -83,6 +83,10 @@
 html_theme = "furo"
 language = "en"
 
+# Disable the generation of the various indexes
+html_use_modindex = False
+html_use_index = False
+
 html_theme_options = {
     "light_logo": "logo-light-mode.png",
     "dark_logo": "logo-dark-mode.png",

docs/source/demos_examples.rst

@@ -14,36 +14,36 @@ Please note that the demo videos shared below may not represent Oracle's officia
     * - Demo
       - Description
 
-    * - `Run MLflow project on the local environment <https://objectstorage.us-ashburn-1.oraclecloud.com/p/vv1bNIvcMnbvbM5TUW5NDVSoisL4BAS54l9bGFDmyiNkTPZ4q6NtAmOdemNr8lTv/n/ociodscdev/b/oci-mlflow/o/beta/demos/mlflow_project_on_local_environment.mp4>`__
+    * - `Run MLflow project on the local environment <https://youtu.be/krLGjS4E8HI>`__
       - | 1. `Installing <https://docs.oracle.com/en-us/iaas/data-science/using/conda_understand_environments.htm">`__ `GML for CPUs` conda environment
         | 2. Introduction to the `MLflow projects <https://mlflow.org/docs/latest/projects.html>`__
         | 3. Running `sklearn_elasticnet_wine <https://github.com/mlflow/mlflow/tree/master/examples/sklearn_elasticnet_wine>`__ example
         | 4. Checking the experiment's result
 
-    * - `Run MLflow project on the OCI DSC Jobs <https://objectstorage.us-ashburn-1.oraclecloud.com/p/vv1bNIvcMnbvbM5TUW5NDVSoisL4BAS54l9bGFDmyiNkTPZ4q6NtAmOdemNr8lTv/n/ociodscdev/b/oci-mlflow/o/beta/demos/mlflow_project_on_datascience_job.mp4>`__
+    * - `Run MLflow project on the OCI DSC Jobs <https://youtu.be/24p3wIyVFbE>`__
       - | 1. `OCI Data Science Jobs <https://accelerated-data-science.readthedocs.io/en/latest/user_guide/jobs/index.html>`__
         | 2. `Publishing <https://docs.oracle.com/en-us/iaas/data-science/using/conda_publishs_object.htm>`__ `GML for CPUs`  conda environment
         | 3. Preparing :ref:`configuration files </project.rst#data-science-config>`
         | 4. Running `sklearn_elasticnet_wine <https://github.com/mlflow/mlflow/tree/master/examples/sklearn_elasticnet_wine>`__ example
         | 5. Checking the experiment's result
 
-    * - `Run MLflow project on the DSC Jobs with BYOC <https://objectstorage.us-ashburn-1.oraclecloud.com/p/vv1bNIvcMnbvbM5TUW5NDVSoisL4BAS54l9bGFDmyiNkTPZ4q6NtAmOdemNr8lTv/n/ociodscdev/b/oci-mlflow/o/beta/demos/mlflow_project_on_datascience_job_byoc.mp4>`__
+    * - `Run MLflow project on the DSC Jobs with BYOC <https://youtu.be/QGfjtYV7yFs>`__
       - | 1. `OCI Data Science Jobs <https://accelerated-data-science.readthedocs.io/en/latest/user_guide/jobs/index.html>`__
         | 2. `Bring Your Own Container <https://docs.oracle.com/en-us/iaas/data-science/using/jobs-byoc.htm>`__
         | 3. `Publishing a container image <https://docs.oracle.com/en-us/iaas/Content/Registry/Tasks/registrypushingimagesusingthedockercli.htm#Pushing_Images_Using_the_Docker_CLI>`__ to the OCR
         | 4. Preparing :ref:`configuration files </project.rst#data-science-config>`
         | 5. Running `docker <https://github.com/mlflow/mlflow/tree/master/examples/docker>`__ project example
         | 6. Checking the experiment's result
 
-    * - `Run MLflow project on the Data Flow service <https://objectstorage.us-ashburn-1.oraclecloud.com/p/vv1bNIvcMnbvbM5TUW5NDVSoisL4BAS54l9bGFDmyiNkTPZ4q6NtAmOdemNr8lTv/n/ociodscdev/b/oci-mlflow/o/beta/demos/mlflow_project_on_dataflow_application.mp4>`__
+    * - `Run MLflow project on the Data Flow service <https://youtu.be/uacKsipfCyY>`__
       - | 1. `Running Spark Application on OCI Data Flow <https://accelerated-data-science.readthedocs.io/en/latest/user_guide/apachespark/dataflow.html>`__
         | 2. `Publishing <https://docs.oracle.com/en-us/iaas/data-science/using/conda_publishs_object.htm>`__ `PySpark 3.2 and Data Flow` conda environment
         | 3. Preparing :ref:`configuration files </project.rst#running-mlflow-project-within-dataflowruntime>`
         | 4. `Allowing Data Flow to Access a Private Network <https://docs.oracle.com/en-us/iaas/data-flow/using/pe-allowing.htm>`__
         | 5. Running `pyspark_ml_autologging <https://github.com/mlflow/mlflow/tree/master/examples/pyspark_ml_autologging>`__ project example
         | 6. Checking the experiment's result
 
-    * - `Deploy MLflow model on OCI Data Science <https://objectstorage.us-ashburn-1.oraclecloud.com/p/vv1bNIvcMnbvbM5TUW5NDVSoisL4BAS54l9bGFDmyiNkTPZ4q6NtAmOdemNr8lTv/n/ociodscdev/b/oci-mlflow/o/beta/demos/mlflow_deployment_prebuilt_conda.mp4#t=0.5>`__
+    * - `Deploy MLflow model on OCI Data Science <https://youtu.be/PPpiz3Yd5VY>`__
       - | 1. `Deploy Model on OCI Data Science <https://accelerated-data-science.readthedocs.io/en/latest/user_guide/model_registration/introduction.html#deploying-model>`__
         | 2. `Publishing <https://docs.oracle.com/en-us/iaas/data-science/using/conda_publishs_object.htm>`__ `GML for CPUs` conda environment
         | 3. Preparing :ref:`configuration files </model_deployment.rst#deployment-specification>`

docs/source/index.rst

@@ -1,6 +1,16 @@
-======================================
+==================
 OCI MLflow Plugins
-======================================
+==================
+
+The OCI MLflow plugins allow to utilize Oracle Cloud Infrastructure (OCI) resources to run MLflow experiments.
+
+|PyPI|_ |Python|_
+
+.. |PyPI| image:: https://img.shields.io/pypi/v/oci-mlflow.svg?style=for-the-badge&logo=pypi&logoColor=white
+..  _PyPI: https://pypi.org/project/oci-mlflow/
+.. |Python| image:: https://img.shields.io/pypi/pyversions/oci-mlflow.svg?style=for-the-badge&logo=pypi&logoColor=white
+..  _Python: https://pypi.org/project/oci-mlflow/
+
 
 .. toctree::
     :maxdepth: 2