Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: tutorial on reusing fine-tuned models #579

Merged
merged 4 commits into from
Jan 2, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 26 additions & 6 deletions nbs/docs/reference/01_nixtla_client.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand All @@ -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,
Expand Down Expand Up @@ -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,
Expand Down
Loading
Loading