Update documentation URLs with /docs as root directory

Author: gustavocidornelas

docs/source/reference/authentication.rst

@@ -6,7 +6,7 @@ Authentication
 .. currentmodule:: openlayer
 
 Openlayer uses API keys for client authentication. You can find your workspace API key on
-your `Account settings <https://docs.openlayer.com/documentation/how-to-guides/find-your-api-key>`_.
+your `Account settings <https://docs.openlayer.com/docs/how-to-guides/find-your-api-key>`_.
 
 The authentication step happens when the ``OpenlayerClient`` is instantiated.
 

docs/source/reference/development.rst

@@ -15,7 +15,7 @@ To use these methods, you must have:
 
 2. Created a project, using :obj:`openlayer.OpenlayerClient.create_project`
 
-**Related guide**: `How to upload datasets and models for development <https://docs.openlayer.com/documentation/how-to-guides/upload-datasets-and-models>`_.
+**Related guide**: `How to upload datasets and models for development <https://docs.openlayer.com/docs/how-to-guides/upload-datasets-and-models>`_.
 
 
 Staging area

docs/source/reference/monitoring.rst

@@ -16,7 +16,7 @@ To use these methods, you must have:
 
 2. Created a project, using :obj:`openlayer.OpenlayerClient.create_project`
 
-**Related guide**: `How to set up monitoring <https://docs.openlayer.com/documentation/how-to-guides/set-up-monitoring>`_.
+**Related guide**: `How to set up monitoring <https://docs.openlayer.com/docs/how-to-guides/set-up-monitoring>`_.
 
 
 Creating and loading inference pipelines

docs/source/reference/projects.rst

@@ -10,7 +10,7 @@ A project is the logical unit on the Openlayer platform that houses models, data
 and goals. You can create projects for any of the task types defined
 in :class:`tasks.TaskType`.
 
-**Related guide**: `How to create and load projects <https://docs.openlayer.com/documentation/how-to-guides/creating-and-loading-projects>`_.
+**Related guide**: `How to create and load projects <https://docs.openlayer.com/docs/how-to-guides/creating-and-loading-projects>`_.
 
 Project creation and loading
 ----------------------------

examples/monitoring/llms/monitoring-llms.ipynb

@@ -10,7 +10,7 @@
                 "\n",
                 "# <a id=\"top\">Monitoring LLMs</a>\n",
                 "\n",
-                "This notebook illustrates a typical monitoring flow for LLMs using Openlayer. For more details, refer to the [How to set up monitoring guide](https://docs.openlayer.com/documentation/how-to-guides/set-up-monitoring) from the documentation.\n",
+                "This notebook illustrates a typical monitoring flow for LLMs using Openlayer. For more details, refer to the [How to set up monitoring guide](https://docs.openlayer.com/docs/how-to-guides/set-up-monitoring) from the documentation.\n",
                 "\n",
                 "\n",
                 "## <a id=\"toc\">Table of contents</a>\n",

openlayer/__init__.py

@@ -59,15 +59,15 @@ class OpenlayerClient(object):
     ----------
     api_key : str
         Your API key. You can find your workspace API key in your
-        `account settings <https://docs.openlayer.com/documentation/how-to-guides/find-your-api-key>`_
+        `account settings <https://docs.openlayer.com/docs/how-to-guides/find-your-api-key>`_
         settings page.
     verbose : bool, default True
         Whether to print out success messages to the console. E.g., when data is
         successfully uploaded, a resource is staged, etc.
 
     Examples
     --------
-    **Relevant guide**: `How to find your API keys <https://docs.openlayer.com/documentation/how-to-guides/find-your-api-key>`_.
+    **Relevant guide**: `How to find your API keys <https://docs.openlayer.com/docs/how-to-guides/find-your-api-key>`_.
 
     Instantiate a client with your api key:
 
@@ -112,7 +112,7 @@ def create_project(
 
         Examples
         --------
-        **Related guide**: `How to create and load projects <https://docs.openlayer.com/documentation/how-to-guides/creating-and-loading-projects>`_.
+        **Related guide**: `How to create and load projects <https://docs.openlayer.com/docs/how-to-guides/creating-and-loading-projects>`_.
 
         Instantiate the client and create the project:
 
@@ -194,7 +194,7 @@ def load_project(self, name: str) -> Project:
 
         Examples
         --------
-        **Related guide**: `How to create and load projects <https://docs.openlayer.com/documentation/how-to-guides/creating-and-loading-projects>`_.
+        **Related guide**: `How to create and load projects <https://docs.openlayer.com/docs/how-to-guides/creating-and-loading-projects>`_.
 
         Instantiate the client and load the project:
 
@@ -255,7 +255,7 @@ def create_or_load_project(
 
         Examples
         --------
-        **Related guide**: `How to create and load projects <https://docs.openlayer.com/documentation/how-to-guides/creating-and-loading-projects>`_.
+        **Related guide**: `How to create and load projects <https://docs.openlayer.com/docs/how-to-guides/creating-and-loading-projects>`_.
 
         Instantiate the client and create or load the project:
 

openlayer/inference_pipelines.py

@@ -63,7 +63,7 @@ def upload_reference_dataset(
             .. admonition:: What's in the dataset config?
 
                 The dataset configuration depends on the :obj:`TaskType`.
-                Refer to the `How to write dataset configs guides <https://docs.openlayer.com/documentation/how-to-guides/write-dataset-configs>`_
+                Refer to the `How to write dataset configs guides <https://docs.openlayer.com/docs/how-to-guides/write-dataset-configs>`_
                 for details.
 
         dataset_config_file_path : str
@@ -73,7 +73,7 @@ def upload_reference_dataset(
             .. admonition:: What's in the dataset config file?
 
                 The dataset configuration YAML depends on the :obj:`TaskType`.
-                Refer to the `How to write dataset configs guides <https://docs.openlayer.com/documentation/how-to-guides/write-dataset-configs>`_
+                Refer to the `How to write dataset configs guides <https://docs.openlayer.com/docs/how-to-guides/write-dataset-configs>`_
                 for details.
 
         Notes
@@ -83,7 +83,7 @@ def upload_reference_dataset(
 
         Examples
         --------
-        **Related guide**: `How to set up monitoring <https://docs.openlayer.com/documentation/how-to-guides/set-up-monitoring>`_.
+        **Related guide**: `How to set up monitoring <https://docs.openlayer.com/docs/how-to-guides/set-up-monitoring>`_.
 
         First, instantiate the client and retrieve an existing inference pipeline:
 
@@ -163,7 +163,7 @@ def upload_reference_dataframe(
             .. admonition:: What's in the dataset config?
 
                 The dataset configuration depends on the :obj:`TaskType`.
-                Refer to the `How to write dataset configs guides <https://docs.openlayer.com/documentation/how-to-guides/write-dataset-configs>`_
+                Refer to the `How to write dataset configs guides <https://docs.openlayer.com/docs/how-to-guides/write-dataset-configs>`_
                 for details.
 
         dataset_config_file_path : str
@@ -173,7 +173,7 @@ def upload_reference_dataframe(
             .. admonition:: What's in the dataset config file?
 
                 The dataset configuration YAML depends on the :obj:`TaskType`.
-                Refer to the `How to write dataset configs guides <https://docs.openlayer.com/documentation/how-to-guides/write-dataset-configs>`_
+                Refer to the `How to write dataset configs guides <https://docs.openlayer.com/docs/how-to-guides/write-dataset-configs>`_
                 for details.
 
         Notes
@@ -183,7 +183,7 @@ def upload_reference_dataframe(
 
         Examples
         --------
-        **Related guide**: `How to set up monitoring <https://docs.openlayer.com/documentation/how-to-guides/set-up-monitoring>`_.
+        **Related guide**: `How to set up monitoring <https://docs.openlayer.com/docs/how-to-guides/set-up-monitoring>`_.
 
         First, instantiate the client and retrieve an existing inference pipeline:
 
@@ -329,7 +329,7 @@ def publish_batch_data(self, *args, **kwargs):
             .. admonition:: What's in the config?
 
                 The configuration for a batch of data depends on the :obj:`TaskType`.
-                Refer to the `How to write dataset configs guides <https://docs.openlayer.com/documentation/how-to-guides/write-dataset-configs>`_
+                Refer to the `How to write dataset configs guides <https://docs.openlayer.com/docs/how-to-guides/write-dataset-configs>`_
                 for details. These configurations are
                 the same for development and batches of production data.
 
@@ -340,7 +340,7 @@ def publish_batch_data(self, *args, **kwargs):
             .. admonition:: What's in the config file?
 
                 The configuration for a batch of data depends on the :obj:`TaskType`.
-                Refer to the `How to write dataset configs guides <https://docs.openlayer.com/documentation/how-to-guides/write-dataset-configs>`_
+                Refer to the `How to write dataset configs guides <https://docs.openlayer.com/docs/how-to-guides/write-dataset-configs>`_
                 for details. These configurations are
                 the same for development and batches of production data.
 
@@ -360,7 +360,7 @@ def publish_batch_data(self, *args, **kwargs):
 
         Examples
         --------
-        **Related guide**: `How to set up monitoring <https://docs.openlayer.com/documentation/how-to-guides/set-up-monitoring>`_.
+        **Related guide**: `How to set up monitoring <https://docs.openlayer.com/docs/how-to-guides/set-up-monitoring>`_.
 
         First, instantiate the client and retrieve an existing inference pipeline:
 
@@ -415,7 +415,7 @@ def publish_ground_truths(self, *args, **kwargs):
 
         Examples
         --------
-        **Related guide**: `How to set up monitoring <https://docs.openlayer.com/documentation/how-to-guides/set-up-monitoring>`_.
+        **Related guide**: `How to set up monitoring <https://docs.openlayer.com/docs/how-to-guides/set-up-monitoring>`_.
 
         Let's say you have a batch of production data already published to the
         Openlayer platform (with the method :obj:`publish_batch_data`). Now, you want

openlayer/projects.py

@@ -47,7 +47,7 @@ def add_model(
         This is the method for every model upload, regardless of whether you want to add a shell model,
         a full model, or a direct-to-API model (for LLMs-only).
 
-        Refer to the `Knowledge base guide on model upload <https://docs.openlayer.com/knowledge-base/development/versioning#adding-models>`_ to
+        Refer to the `Knowledge base guide on model upload <https://docs.openlayer.com/docs/knowledge-base/development/versioning#adding-models>`_ to
         learn more about the differences between these options.
 
         Parameters
@@ -59,7 +59,7 @@ def add_model(
             .. admonition:: What's in the model config dict?
 
                 The model configuration depends on the project's :obj:`tasks.TaskType`.
-                Refer to the `How to write model configs <https://docs.openlayer.com/documentation/how-to-guides/write-model-configs>`_
+                Refer to the `How to write model configs <https://docs.openlayer.com/docs/how-to-guides/write-model-configs>`_
                 guide for details.
 
         model_config_file_path : str
@@ -69,7 +69,7 @@ def add_model(
             .. admonition:: What's in the model config file?
 
                 The model configuration YAML depends on the project's :obj:`tasks.TaskType`.
-                Refer to the `How to write model configs <https://docs.openlayer.com/documentation/how-to-guides/write-model-configs>`_
+                Refer to the `How to write model configs <https://docs.openlayer.com/docs/how-to-guides/write-model-configs>`_
                 guide for details.
 
         model_package_dir : str, default None
@@ -108,7 +108,7 @@ def add_model(
 
         Examples
         --------
-        **Related guide**: `How to upload datasets and models for development <https://docs.openlayer.com/documentation/how-to-guides/upload-datasets-and-models>`_.
+        **Related guide**: `How to upload datasets and models for development <https://docs.openlayer.com/docs/how-to-guides/upload-datasets-and-models>`_.
 
         First, instantiate the client:
 
@@ -158,7 +158,7 @@ def add_model(
         .. admonition:: What's in the model config?
 
                 The model configuration depends on the project's :obj:`tasks.TaskType`.
-                Refer to the `How to write model configs guides <https://docs.openlayer.com/documentation/how-to-guides/write-model-configs>`_
+                Refer to the `How to write model configs guides <https://docs.openlayer.com/docs/how-to-guides/write-model-configs>`_
                 for details.
 
         Then, you can add the model to the project with:
@@ -225,7 +225,7 @@ def add_dataset(
             .. admonition:: What's in the dataset config?
 
                 The dataset configuration depends on the project's :obj:`tasks.TaskType`.
-                Refer to the `How to write dataset configs guides <https://docs.openlayer.com/documentation/how-to-guides/write-dataset-configs>`_
+                Refer to the `How to write dataset configs guides <https://docs.openlayer.com/docs/how-to-guides/write-dataset-configs>`_
                 for details.
 
         dataset_config_file_path : str
@@ -235,7 +235,7 @@ def add_dataset(
             .. admonition:: What's in the dataset config file?
 
                 The dataset configuration YAML depends on the project's :obj:`tasks.TaskType`.
-                Refer to the `How to write dataset configs guides <https://docs.openlayer.com/documentation/how-to-guides/write-dataset-configs>`_
+                Refer to the `How to write dataset configs guides <https://docs.openlayer.com/docs/how-to-guides/write-dataset-configs>`_
                 for details.
 
         force : bool
@@ -251,7 +251,7 @@ def add_dataset(
 
         Examples
         --------
-        **Related guide**: `How to upload datasets and models for development <https://docs.openlayer.com/documentation/how-to-guides/upload-datasets-and-models>`_.
+        **Related guide**: `How to upload datasets and models for development <https://docs.openlayer.com/docs/how-to-guides/upload-datasets-and-models>`_.
 
         First, instantiate the client:
 
@@ -296,7 +296,7 @@ def add_dataset(
         .. admonition:: What's in the dataset config?
 
                 The dataset configuration depends on the project's :obj:`tasks.TaskType`.
-                Refer to the `How to write dataset configs guides <https://docs.openlayer.com/documentation/how-to-guides/write-dataset-configs>`_
+                Refer to the `How to write dataset configs guides <https://docs.openlayer.com/docs/how-to-guides/write-dataset-configs>`_
                 for details.
 
         You can now add this dataset to your project with:
@@ -334,7 +334,7 @@ def add_dataframe(self, *args, **kwargs):
             .. admonition:: What's in the dataset config?
 
                 The dataset configuration depends on the project's :obj:`tasks.TaskType`.
-                Refer to the `How to write dataset configs guides <https://docs.openlayer.com/documentation/how-to-guides/write-dataset-configs>`_
+                Refer to the `How to write dataset configs guides <https://docs.openlayer.com/docs/how-to-guides/write-dataset-configs>`_
                 for details.
 
         dataset_config_file_path : str
@@ -344,7 +344,7 @@ def add_dataframe(self, *args, **kwargs):
             .. admonition:: What's in the dataset config file?
 
                 The dataset configuration YAML depends on the project's :obj:`tasks.TaskType`.
-                Refer to the `How to write dataset configs guides <https://docs.openlayer.com/documentation/how-to-guides/write-dataset-configs>`_
+                Refer to the `How to write dataset configs guides <https://docs.openlayer.com/docs/how-to-guides/write-dataset-configs>`_
                 for details.
 
         force : bool
@@ -360,7 +360,7 @@ def add_dataframe(self, *args, **kwargs):
 
         Examples
         --------
-        **Related guide**: `How to upload datasets and models for development <https://docs.openlayer.com/documentation/how-to-guides/upload-datasets-and-models>`_.
+        **Related guide**: `How to upload datasets and models for development <https://docs.openlayer.com/docs/how-to-guides/upload-datasets-and-models>`_.
 
         First, instantiate the client:
 
@@ -404,7 +404,7 @@ def add_dataframe(self, *args, **kwargs):
         .. admonition:: What's in the dataset config?
 
                 The dataset configuration depends on the project's :obj:`tasks.TaskType`.
-                Refer to the `How to write dataset configs guides <https://docs.openlayer.com/documentation/how-to-guides/write-dataset-configs>`_
+                Refer to the `How to write dataset configs guides <https://docs.openlayer.com/docs/how-to-guides/write-dataset-configs>`_
                 for details.
 
         You can now add this dataset to your project with:
@@ -448,7 +448,7 @@ def commit(self, *args, **kwargs):
 
         Examples
         --------
-        **Related guide**: `How to upload datasets and models for development <https://docs.openlayer.com/documentation/how-to-guides/upload-datasets-and-models>`_.
+        **Related guide**: `How to upload datasets and models for development <https://docs.openlayer.com/docs/how-to-guides/upload-datasets-and-models>`_.
 
         A commit message is associated with a project version. The commit message is
         supposed to be a short description of the changes made from one version to
@@ -485,7 +485,7 @@ def push(self, *args, **kwargs):
 
         Examples
         --------
-        **Related guide**: `How to upload datasets and models for development <https://docs.openlayer.com/documentation/how-to-guides/upload-datasets-and-models>`_.
+        **Related guide**: `How to upload datasets and models for development <https://docs.openlayer.com/docs/how-to-guides/upload-datasets-and-models>`_.
 
         Let's say you have a project with a model and a dataset staged and committed.
         You can confirm these resources are indeed in the staging area using the
@@ -541,7 +541,7 @@ def status(self, *args, **kwargs):
 
         Examples
         --------
-        **Related guide**: `How to upload datasets and models for development <https://docs.openlayer.com/documentation/how-to-guides/upload-datasets-and-models>`_.
+        **Related guide**: `How to upload datasets and models for development <https://docs.openlayer.com/docs/how-to-guides/upload-datasets-and-models>`_.
 
         You can use the :obj:`status` method to check the state of the staging area.
 
@@ -576,7 +576,7 @@ def restore(self, *args, **kwargs):
 
         Examples
         --------
-        **Related guide**: `How to upload datasets and models for development <https://docs.openlayer.com/documentation/how-to-guides/upload-datasets-and-models>`_.
+        **Related guide**: `How to upload datasets and models for development <https://docs.openlayer.com/docs/how-to-guides/upload-datasets-and-models>`_.
 
         Let's say you have initially used the :obj:`add_model` method to add a model to the
         staging area.
@@ -642,7 +642,7 @@ def create_inference_pipeline(self, *args, **kwargs):
 
         Examples
         --------
-        **Related guide**: `How to set up monitoring <https://docs.openlayer.com/documentation/how-to-guides/set-up-monitoring>`_.
+        **Related guide**: `How to set up monitoring <https://docs.openlayer.com/docs/how-to-guides/set-up-monitoring>`_.
 
         Instantiate the client and retrieve an existing project:
 
@@ -693,7 +693,7 @@ def load_inference_pipeline(self, *args, **kwargs):
 
         Examples
         --------
-        **Related guide**: `How to set up monitoring <https://docs.openlayer.com/documentation/how-to-guides/set-up-monitoring>`_.
+        **Related guide**: `How to set up monitoring <https://docs.openlayer.com/docs/how-to-guides/set-up-monitoring>`_.
 
         Instantiate the client and load a project: