docs: tutorial on reusing fine-tuned models (#579)

Nixtla · Jan 2, 2025 · 8975d60 · 8975d60
1 parent f19b968
commit 8975d60
Show file tree

Hide file tree

Showing 5 changed files with 900 additions and 10 deletions.
diff --git a/nbs/docs/reference/01_nixtla_client.ipynb b/nbs/docs/reference/01_nixtla_client.ipynb
@@ -101,7 +101,12 @@
        "\n",
        ">      NixtlaClient.validate_api_key (log:bool=True)\n",
        "\n",
-       "*Returns True if your api_key is valid.*"
+       "*Check API key status.*\n",
+       "\n",
+       "|    | **Type** | **Default** | **Details** |\n",
+       "| -- | -------- | ----------- | ----------- |\n",
+       "| log | bool | True | Show the endpoint's response. |\n",
+       "| **Returns** | **bool** |  | **Whether API key is valid.** |"
       ],
       "text/plain": [
        "---\n",
@@ -110,7 +115,12 @@
        "\n",
        ">      NixtlaClient.validate_api_key (log:bool=True)\n",
        "\n",
-       "*Returns True if your api_key is valid.*"
+       "*Check API key status.*\n",
+       "\n",
+       "|    | **Type** | **Default** | **Details** |\n",
+       "| -- | -------- | ----------- | ----------- |\n",
+       "| log | bool | True | Show the endpoint's response. |\n",
+       "| **Returns** | **bool** |  | **Whether API key is valid.** |"
       ]
      },
      "execution_count": null,
@@ -623,18 +633,28 @@
        "\n",
        "## NixtlaClient.finetuned_models\n",
        "\n",
-       ">      NixtlaClient.finetuned_models ()\n",
+       ">      NixtlaClient.finetuned_models (as_df:bool=False)\n",
        "\n",
-       "*List fine-tuned models*"
+       "*List fine-tuned models*\n",
+       "\n",
+       "|    | **Type** | **Default** | **Details** |\n",
+       "| -- | -------- | ----------- | ----------- |\n",
+       "| as_df | bool | False | Return the fine-tuned models as a pandas dataframe |\n",
+       "| **Returns** | **Union** |  | **List of available fine-tuned models.** |"
       ],
       "text/plain": [
        "---\n",
        "\n",
        "## NixtlaClient.finetuned_models\n",
        "\n",
-       ">      NixtlaClient.finetuned_models ()\n",
+       ">      NixtlaClient.finetuned_models (as_df:bool=False)\n",
        "\n",
-       "*List fine-tuned models*"
+       "*List fine-tuned models*\n",
+       "\n",
+       "|    | **Type** | **Default** | **Details** |\n",
+       "| -- | -------- | ----------- | ----------- |\n",
+       "| as_df | bool | False | Return the fine-tuned models as a pandas dataframe |\n",
+       "| **Returns** | **Union** |  | **List of available fine-tuned models.** |"
       ]
      },
      "execution_count": null,