Skip to content

Commit

Permalink
Changes after PR feedback
Browse files Browse the repository at this point in the history
  • Loading branch information
MMenchero committed Apr 9, 2024
1 parent 1635867 commit 0a545c2
Show file tree
Hide file tree
Showing 4 changed files with 27 additions and 1,132 deletions.
435 changes: 11 additions & 424 deletions nbs/docs/getting-started/1_getting_started_short.ipynb

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"An **API key** is a unique string of characters that serves as a key to authenticate your requests to `TimeGTP`. This tutorial will explain how to set up your token when using the Nixtla SDK. \n",
"An **API key** is a unique string of characters that serves as a key to authenticate your requests to `TimeGTP`. This tutorial will explain how to set up your API key when using the Nixtla SDK. \n",
"\n",
"Upon [registration](https://dashboard.nixtla.io/), you will recibe an email asking you to confirm your signup. After confirming, you will receive access to your dashboard. There, under `API Keys`, you will find your API key. To integrate your API key into your development workflow with the Nixtla SDK, you have two methods. "
]
Expand Down Expand Up @@ -62,18 +62,7 @@
"cell_type": "code",
"execution_count": null,
"metadata": {},
"outputs": [
{
"data": {
"text/plain": [
"True"
]
},
"execution_count": null,
"metadata": {},
"output_type": "execute_result"
}
],
"outputs": [],
"source": [
"#| hide\n",
"from dotenv import load_dotenv\n",
Expand Down Expand Up @@ -124,7 +113,7 @@
"source": [
"### b. Using a `.env` file\n",
"\n",
"For a more persistent solution that can be version-controlled if private, or for ease of use across different projects, place your token in a `.env` file.\n",
"For a more persistent solution that can be version-controlled if private, or for ease of use across different projects, place your API key in a `.env` file.\n",
"\n",
"``` bash\n",
"# Inside a file named .env\n",
Expand Down Expand Up @@ -181,25 +170,7 @@
"cell_type": "code",
"execution_count": null,
"metadata": {},
"outputs": [
{
"name": "stderr",
"output_type": "stream",
"text": [
"INFO:nixtlats.nixtla_client:Happy Forecasting! :), If you have questions or need support, please email [email protected]\n"
]
},
{
"data": {
"text/plain": [
"True"
]
},
"execution_count": null,
"metadata": {},
"output_type": "execute_result"
}
],
"outputs": [],
"source": [
"nixtla_client.validate_api_key()"
]
Expand Down
2 changes: 1 addition & 1 deletion nbs/docs/misc/0_faqs.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -262,7 +262,7 @@
"ApiError: status_code: 401, body: {'data': None, 'message': 'Invalid API key', 'details': 'Key not found', 'code': 'A12', 'requestID': 'E7F2BBTB2P', 'support': 'If you have questions or need support, please email [email protected]'}\n",
"```\n",
"\n",
"**Solution:** This error occurs when your `TimeGPT` token is either invalid or has not been set up correctly. Please use the `validate_api_key` method to verify it or make sure it was copied correctly from the `API Keys` section of your [dashboard](https://dashboard.nixtla.io/)."
"**Solution:** This error occurs when your `TimeGPT` API key is either invalid or has not been set up correctly. Please use the `validate_api_key` method to verify it or make sure it was copied correctly from the `API Keys` section of your [dashboard](https://dashboard.nixtla.io/)."
]
},
{
Expand Down
685 changes: 11 additions & 674 deletions nbs/docs/tutorials/9_cross_validation.ipynb

Large diffs are not rendered by default.

0 comments on commit 0a545c2

Please sign in to comment.