Skip to content

Commit fa32b6a

Browse files
authored
Update Docs to link to Github for sample notebooks (#416)
1 parent fbc3677 commit fa32b6a

File tree

6 files changed

+21
-25
lines changed

6 files changed

+21
-25
lines changed

docs/source/user_guide/apachespark/dataflow-spark-magic.rst

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,8 @@ This section demonstrates how to run interactive Spark workloads on a long lasti
2323

2424
**Notebook Examples:**
2525

26-
* `Introduction to the Oracle Cloud Infrastructure Data Flow Studio <https://github.com/oracle-samples/oci-data-science-ai-samples/blob/master/notebook_examples/pyspark-data_flow_studio-introduction.ipynb>`__
27-
* `Spark NLP within Oracle Cloud Infrastructure Data Flow Studio <https://github.com/oracle-samples/oci-data-science-ai-samples/blob/master/notebook_examples/pyspark-data_flow_studio-spark_nlp.ipynb>`__
26+
* `Introduction to the Oracle Cloud Infrastructure Data Flow Studio <https://github.com/oracle-samples/oci-data-science-ai-samples/blob/main/notebook_examples/pyspark-data_flow_studio-introduction.ipynb>`_
27+
* `Spark NLP within Oracle Cloud Infrastructure Data Flow Studio <https://github.com/oracle-samples/oci-data-science-ai-samples/blob/main/notebook_examples/pyspark-data_flow_studio-spark_nlp.ipynb>`_
2828

2929
Prerequisite
3030
============
@@ -72,7 +72,7 @@ Data Flow Spark Magic is used for interactively working with remote Spark cluste
7272
7373
%load_ext dataflow.magics
7474
75-
Use the `%help` method to get a list of all the available commands, along with a list of their arguments and example calls.
75+
Use the ``%help`` method to get a list of all the available commands, along with a list of their arguments and example calls.
7676

7777
.. code-block:: python
7878
@@ -130,7 +130,7 @@ To help you save resources and reduce time on management, Spark `dynamic allocat
130130
131131
**Example command with third-party libraries**
132132

133-
The Data Flow Sessions support `custom dependencies <https://docs.oracle.com/iaas/data-flow/using/third-party-libraries.htm>`__ in the form of Python wheels or virtual environments. You might want to make native code or other assets available within your Spark runtime. The dependencies can be attached by using the `archiveUri` attribute.
133+
The Data Flow Sessions support `custom dependencies <https://docs.oracle.com/iaas/data-flow/using/third-party-libraries.htm>`__ in the form of Python wheels or virtual environments. You might want to make native code or other assets available within your Spark runtime. The dependencies can be attached by using the ``archiveUri`` attribute.
134134

135135
.. code-block:: python
136136
@@ -148,7 +148,7 @@ The Data Flow Sessions support `custom dependencies <https://docs.oracle.com/iaa
148148
149149
**Example command with the Data Catalog Hive Metastore**
150150

151-
The `Data Catalog Hive Metastore <https://docs.oracle.com/iaas/data-catalog/using/metastore.htm>`__ provides schema definitions for objects in structured and unstructured data assets. Use the `metastoreId` to access the Data Catalog Metastore.
151+
The `Data Catalog Hive Metastore <https://docs.oracle.com/iaas/data-catalog/using/metastore.htm>`__ provides schema definitions for objects in structured and unstructured data assets. Use the ``metastoreId`` to access the Data Catalog Metastore.
152152

153153
.. code-block:: python
154154
@@ -195,7 +195,7 @@ Example path : ``oci://<your-bucket>@<your-tenancy-namespace>/conda_environments
195195

196196
.. versionadded:: 2.8.7
197197

198-
The `Data Flow Pools <https://docs.oracle.com/en-us/iaas/data-flow/using/pools.htm>`__ achieve fast job startup, resource isolation, manage budgets, and prioritize your Spark workloads. Use the `poolId` to use the Pool resources.
198+
The `Data Flow Pools <https://docs.oracle.com/en-us/iaas/data-flow/using/pools.htm>`__ achieve fast job startup, resource isolation, manage budgets, and prioritize your Spark workloads. Use the ``poolId`` to use the Pool resources.
199199

200200
.. code-block:: python
201201
@@ -256,7 +256,7 @@ To re-activate the existing session, use the ``%activate_session`` magic command
256256
257257
Use Existing Session
258258
********************
259-
To connect to the existing session use the `%use_session` magic command.
259+
To connect to the existing session use the ``%use_session`` magic command.
260260

261261
.. code-block:: python
262262

docs/source/user_guide/configuration/authentication.rst

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ Within your notebook session, you can choose to use the resource principal to au
2727
API Keys
2828
========
2929

30-
This is the default method of authentication. You can also authenticate as your own personal IAM user by creating or uploading OCI configuration and API key files inside your notebook session environment. The OCI configuration file contains the necessary credentials to authenticate your user against the model catalog and other OCI services like Object Storage. The example notebook, `api_keys.ipynb` demonstrates how to create these files.
30+
This is the default method of authentication. You can also authenticate as your own personal IAM user by creating or uploading OCI configuration and API key files inside your notebook session environment. The OCI configuration file contains the necessary credentials to authenticate your user against the model catalog and other OCI services like Object Storage. To setup API Key refer to `Required Keys and OCIDs <https://docs.oracle.com/en-us/iaas/Content/API/Concepts/apisigningkey.htm>`_ and `SDK and CLI Configuration File <https://docs.oracle.com/en-us/iaas/Content/API/Concepts/sdkconfig.htm>`_.
3131

3232
The ``getting-started.ipynb`` notebook in the home directory of the notebook session environment demonstrates all the steps needed to create the configuration file and the keys. Follow the steps in that notebook before importing and using ADS in your notebooks.
3333

@@ -79,4 +79,3 @@ In the this example, the default authentication uses API keys specified with the
7979
os_auth = authutil.resource_principal() # use resource principal to as the preferred way to access object store
8080
8181
``AuthContext`` context class can also be used to specify the desired type of authentication. It supports API key configuration, resource principal, and instance principal authentication, as well as predefined signers, callable signers, or API keys configurations from specified locations. See `API Documentation <../../ads.common.html#ads.common.auth.AuthContext>`__ for more details.
82-

docs/source/user_guide/configuration/autonomous_database.rst

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ Use these steps to access Oracle ADB:
3333
3434
METHOD_DATA = (DIRECTORY="<path_to_wallet_folder>")
3535
36-
7. To find the location of the ``sqlnet.ora`` file, the ``TNS_ADMIN`` environment variable must point to that location. We suggest that you create a Python dictionary to store all of the connection information. In this example, this dictionary is called ``creds``. It is generally poor security practice to store credentials in your notebook. We recommend that you use the ``ads-examples/ADB_working_with.ipynb`` notebook example that demonstrates how to store them outside the notebook in a configuration file.
36+
7. To find the location of the ``sqlnet.ora`` file, the ``TNS_ADMIN`` environment variable must point to that location. We suggest that you create a Python dictionary to store all of the connection information. In this example, this dictionary is called ``creds``. It is generally poor security practice to store credentials in your notebook. We recommend that you use the `Bank Graph Example Notebook <https://github.com/oracle-samples/oci-data-science-ai-samples/blob/main/notebook_examples/graph_insight-autonomous_database.ipynb>`_ notebook example that demonstrates how to store them outside the notebook in a configuration file.
3737

3838
The environment variable should be set in your notebooks. For example:
3939

@@ -72,4 +72,3 @@ Messages similar to the following display if the connection is successful:
7272
:align: center
7373

7474
An introduction to loading data from ADB into ADS using ``cx_Oracle`` and ``SQLAlchemy`` is in :ref:`Loading Data <loading-data-10>`.
75-

docs/source/user_guide/configuration/configuration.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ Within your notebook session, you can choose to use the resource principal to au
3232
**2. Authenticating Using API Keys**
3333
---------------------------------------------------------------------------------------------
3434

35-
This is the default method of authentication. You can also authenticate as your own personal IAM user by creating or uploading OCI configuration and API key files inside your notebook session environment. The OCI configuration file contains the necessary credentials to authenticate your user against the model catalog and other OCI services like Object Storage. The example notebook, `api_keys.ipynb` demonstrates how to create these files.
35+
This is the default method of authentication. You can also authenticate as your own personal IAM user by creating or uploading OCI configuration and API key files inside your notebook session environment. The OCI configuration file contains the necessary credentials to authenticate your user against the model catalog and other OCI services like Object Storage. To setup API Key refer to `Required Keys and OCIDs <https://docs.oracle.com/en-us/iaas/Content/API/Concepts/apisigningkey.htm>`_ and `SDK and CLI Configuration File <https://docs.oracle.com/en-us/iaas/Content/API/Concepts/sdkconfig.htm>`_.
3636

3737
The ``getting-started.ipynb`` notebook in the home directory of the notebook session environment demonstrates all the steps needed to create the configuration file and the keys. Follow the steps in that notebook before importing and using ADS in your notebooks.
3838

@@ -117,7 +117,7 @@ Use these steps to access Oracle ADB:
117117
118118
METHOD_DATA = (DIRECTORY="<path_to_wallet_folder>")
119119
120-
7. To find the location of the ``sqlnet.ora`` file, the ``TNS_ADMIN`` environment variable must point to that location. We suggest that you create a Python dictionary to store all of the connection information. In this example, this dictionary is called ``creds``. It is generally poor security practice to store credentials in your notebook. We recommend that you use the ``ads-examples/ADB_working_with.ipynb`` notebook example that demonstrates how to store them outside the notebook in a configuration file.
120+
7. To find the location of the ``sqlnet.ora`` file, the ``TNS_ADMIN`` environment variable must point to that location. We suggest that you create a Python dictionary to store all of the connection information. In this example, this dictionary is called ``creds``. It is generally poor security practice to store credentials in your notebook. We recommend that you use the `Bank Graph Example Notebook <https://github.com/oracle-samples/oci-data-science-ai-samples/blob/main/notebook_examples/graph_insight-autonomous_database.ipynb>`_ notebook example that demonstrates how to store them outside the notebook in a configuration file.
121121

122122
The environment variable should be set in your notebooks. For example:
123123

@@ -440,11 +440,11 @@ dictionary. To store your secret, just modify the dictionary.
440440
'password': 'MySecretPassword',
441441
'database_type': 'oracle'}
442442
443-
Note, to connect to an Oracle database the `database_name` value should be its
443+
Note, to connect to an Oracle database the ``database_name`` value should be its
444444
connection identifier. You can find the connection identifier by extracting the
445-
credential wallet zip file and opening the `tnsnames.ora` file
445+
credential wallet zip file and opening the ``tnsnames.ora`` file
446446
(connection_identifier = (...)). Usually the connection identifier will
447-
end with `_high`, `_medium` or `_low` i.e. `'MyDatabaseName_high'`.
447+
end with ``_high``, ``_medium`` or ``_low`` i.e. ``'MyDatabaseName_high'``.
448448

449449
**Create a Vault**
450450

docs/source/user_guide/data_flow/dataflow.rst

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -791,7 +791,7 @@ You can work with different compression formats within Data Flow. For example, s
791791
792792
Other compression formats that Data Flow supports include snappy Parquet, and Gzip on both CSV and Parquet.
793793

794-
You might have query that you want to run in Data Flow from previous explorations, review the `dataflow.ipynb` notebook example that shows you how to submit a job to Data Flow.
794+
You might have query that you want to run in Data Flow from previous explorations.
795795

796796
.. code-block:: python3
797797
@@ -1025,12 +1025,11 @@ The required variables to set up are:
10251025
that the secret is the credential needed to access a database. This
10261026
notebook is designed so that any secret can be stored as long as it
10271027
is in the form of a dictionary. To store your secret, just modify the
1028-
dictionary, see the ``vault.ipynb`` example notebook for detailed
1029-
steps to generate this OCID.
1028+
dictionary.
10301029
2. ``tnsname``: A TNS name valid for the database.
10311030
3. ``wallet_path``: The local path to your wallet ZIP file, see the
1032-
``autonomous_database.ipynb`` example notebook for instructions on
1033-
accessing the wallet file.
1031+
`Loading Data from Different Sources Using Pandas and Dask <https://github.com/oracle-samples/oci-data-science-ai-samples/blob/main/notebook_examples/load_data-object_storage-hive-autonomous-database.ipynb>`_
1032+
example notebook for instructions on accessing the wallet file.
10341033

10351034
.. code-block:: python3
10361035
@@ -1137,4 +1136,3 @@ This notebook creates a table in your database with the name specified with ``ta
11371136
)
11381137
else:
11391138
print("Skipping as it appears that you do not have tnsname specified.")
1140-

docs/source/user_guide/model_training/ads_tuner.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -341,7 +341,7 @@ space is being used for your model class when ``strategy`` is
341341
``perfunctory`` or ``detailed`` use the ``search_space()`` method to see
342342
the details.
343343

344-
The ``adstuner_search_space_update.ipynb`` notebook has detailed
344+
The `Introduction to ADSTuner <https://github.com/oracle-samples/oci-data-science-ai-samples/blob/main/notebook_examples/hyperparameter_tuning.ipynb>`_ notebook has detailed
345345
examples about how to work with and update the search space.
346346

347347
The next cell displaces the search strategy and the search space.
@@ -363,7 +363,7 @@ parameter. When it is set to ``False``, the tuning process runs
363363
asynchronously so it runs in the background and allows you to continue
364364
your work in the notebook. When ``synchronous`` is set to ``True``, the
365365
notebook is blocked until ``tune()`` finishes running. The
366-
``adntuner_sync_and_async.ipynb`` notebook illustrates this feature in a
366+
`Introduction to ADSTuner <https://github.com/oracle-samples/oci-data-science-ai-samples/blob/main/notebook_examples/hyperparameter_tuning.ipynb>`_ notebook illustrates this feature in a
367367
more detailed way.
368368

369369
The ``ADSTuner`` object needs to know when to stop tuning. The
@@ -739,7 +739,7 @@ You can change the search space in the following three ways:
739739
hyperparameter or make any changes to a hyperparameter that is based on
740740
a categorical distribution. You need to initiate a new ``ADSTuner``
741741
object for those cases. For more detailed information, review the
742-
``adstuner_search_space_update.ipynb`` notebook.
742+
`Introduction to ADSTuner <https://github.com/oracle-samples/oci-data-science-ai-samples/blob/main/notebook_examples/hyperparameter_tuning.ipynb>`_ notebook.
743743

744744
The next cell switches to a ``detailed`` strategy. All previous values
745745
set for ``C``, ``solver``, and ``max_iter`` are kept, and ``ADSTuner``

0 commit comments

Comments
 (0)