Skip to content

Commit 5e796a9

Browse files
committed
ODSC-39272. Fix for links of See API documentation
- change model_framework to model.framework in links to API documentation for frameworks - added recent change to cli/authentication.rst, which was wrongly added into incorrect configuration/authentication.rst
1 parent 0151c23 commit 5e796a9

File tree

8 files changed

+11
-9
lines changed

8 files changed

+11
-9
lines changed

docs/source/user_guide/cli/authentication.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -138,4 +138,6 @@ More signers can be created using the ``create_signer()`` method. With the ``aut
138138
# Example 3. Create signer that uses instance principals with log requests enabled
139139
signer_callable = oci.auth.signers.InstancePrincipalsSecurityTokenSigner
140140
signer_kwargs = dict(log_requests=True) # will log the request url and response data when retrieving
141-
auth = ads.auth.create_signer(signer_callable=signer_callable, signer_kwargs=signer_kwargs)
141+
auth = ads.auth.create_signer(signer_callable=signer_callable, signer_kwargs=signer_kwargs)
142+
143+
``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.

docs/source/user_guide/model_registration/frameworks/huggingfacemodel.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ HuggingFacePipelineModel
55

66
.. versionadded:: 2.8.2
77

8-
See `API Documentation <../../../ads.model_framework.html#ads.model.framework.huggingface_model.HuggingFacePipelineModel>`__
8+
See `API Documentation <../../../ads.model.framework.html#ads.model.framework.huggingface_model.HuggingFacePipelineModel>`__
99

1010
Overview
1111
========
@@ -75,7 +75,7 @@ Prepare Model Artifact
7575
7676
Instantiate a ``HuggingFacePipelineModel()`` object with HuggingFace pipelines. All the pipelines related files are saved under the ``artifact_dir``.
7777

78-
For more detailed information on what parameters that ``HuggingFacePipelineModel`` takes, refer to the `API Documentation <../../../ads.model_framework.html#ads.model.framework.huggingface_model.HuggingFacePipelineModel>`__
78+
For more detailed information on what parameters that ``HuggingFacePipelineModel`` takes, refer to the `API Documentation <../../../ads.model.framework.html#ads.model.framework.huggingface_model.HuggingFacePipelineModel>`__
7979

8080

8181

docs/source/user_guide/model_registration/frameworks/lightgbmmodel.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
LightGBMModel
44
*************
55

6-
See `API Documentation <../../../ads.model_framework.html#ads.model.framework.lightgbm_model.LightGBMModel>`__
6+
See `API Documentation <../../../ads.model.framework.html#ads.model.framework.lightgbm_model.LightGBMModel>`__
77

88

99
Overview

docs/source/user_guide/model_registration/frameworks/pytorchmodel.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
PyTorchModel
44
************
55

6-
See `API Documentation <../../../ads.model_framework.html#ads.model.framework.pytorch_model.PyTorchModel>`__
6+
See `API Documentation <../../../ads.model.framework.html#ads.model.framework.pytorch_model.PyTorchModel>`__
77

88
Overview
99
========

docs/source/user_guide/model_registration/frameworks/sklearnmodel.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
SklearnModel
44
************
55

6-
See `API Documentation <../../../ads.model_framework.html#ads.model.framework.sklearn_model.SklearnModel>`__
6+
See `API Documentation <../../../ads.model.framework.html#ads.model.framework.sklearn_model.SklearnModel>`__
77

88

99
Overview

docs/source/user_guide/model_registration/frameworks/sparkpipelinemodel.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
SparkPipelineModel
44
*******************
55

6-
See `API Documentation <../../../ads.model_framework.html#ads.model.framework.spark_model.SparkPipelineModel>`__
6+
See `API Documentation <../../../ads.model.framework.html#ads.model.framework.spark_model.SparkPipelineModel>`__
77

88
Overview
99
========

docs/source/user_guide/model_registration/frameworks/tensorflowmodel.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
TensorFlowModel
44
***************
55

6-
See `API Documentation <../../../ads.model_framework.html#ads.model.framework.tensorflow_model.TensorFlowModel>`__
6+
See `API Documentation <../../../ads.model.framework.html#ads.model.framework.tensorflow_model.TensorFlowModel>`__
77

88
Overview
99
========

docs/source/user_guide/model_registration/frameworks/xgboostmodel.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
XGBoostModel
44
************
55

6-
See `API Documentation <../../../ads.model_framework.html#ads.model.framework.xgboost_model.XGBoostModel>`__
6+
See `API Documentation <../../../ads.model.framework.html#ads.model.framework.xgboost_model.XGBoostModel>`__
77

88
Overview
99
========

0 commit comments

Comments
 (0)