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

a few updates to getting started #344

Merged
merged 4 commits into from
May 10, 2024
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
46 changes: 35 additions & 11 deletions nbs/docs/getting-started/2_quickstart.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -58,10 +58,18 @@
"* Go to [dashboard.nixtla.io](https://dashboard.nixtla.io/team/1245738/usage)\n",
"* Sign in with Google, GitHub or your email\n",
"* Create your API key by going to 'API Keys' in the menu and clicking on 'Create New API Key'\n",
"* Refresh the page and your API key will be there\n",
"* Your new key will appear. Copy the API key using the button on the right.\n",
" "
]
},
{
"cell_type": "markdown",
"id": "aa3705dd-6133-4eb0-8c53-8a8ff65ee455",
"metadata": {},
"source": [
"<img src=\"https://github.com/Nixtla/nixtla/blob/main/nbs/img/dashboard.png?raw=true\" alt=\"Dashboard for TimeGPT API keys. Keys is in the middle, with trash and copy buttons on the right.\" width=\"700\" />"
]
},
{
"cell_type": "markdown",
"id": "5f30be1a-3eaf-4133-8254-680e8f7cda72",
Expand All @@ -70,12 +78,20 @@
"## Step 2: Install Nixtla"
]
},
{
"cell_type": "markdown",
"id": "73ad0fc4-bcf1-4b7e-8e6c-5969982e1b78",
"metadata": {},
"source": [
"In your favorite Python development environment:"
]
},
{
"cell_type": "markdown",
"id": "d9c35e70",
"metadata": {},
"source": [
"You can install `nixtla` with `pip`:\n",
"Install `nixtla` with `pip`:\n",
" \n",
"```shell\n",
"pip install nixtla\n",
Expand All @@ -90,14 +106,6 @@
"## Step 3: Import the Nixtla TimeGPT client"
]
},
{
"cell_type": "markdown",
"id": "f9322614-a82b-44e5-a3b6-5330b8ad7ba6",
"metadata": {},
"source": [
"In your favorite Python development environment:"
]
},
{
"cell_type": "code",
"execution_count": null,
Expand Down Expand Up @@ -352,6 +360,14 @@
":::"
]
},
{
"cell_type": "markdown",
"id": "7631f17b-0ca4-4cf1-9b89-182a7d85fda6",
"metadata": {},
"source": [
"### Produce a longer forecast"
]
},
{
"cell_type": "markdown",
"id": "5c4790e3",
Expand Down Expand Up @@ -601,6 +617,14 @@
"nixtla_client.plot(df, timegpt_fcst_df, time_col='timestamp', target_col='value')"
]
},
{
"cell_type": "markdown",
"id": "ff6d8e76-dbc1-407f-8a49-5e622735ca3d",
"metadata": {},
"source": [
"### Produce a shorter forecast"
]
},
{
"cell_type": "markdown",
"id": "12e9766e-d7a8-40f6-bfaa-4df07da6c505",
Expand Down Expand Up @@ -657,7 +681,7 @@
"id": "1164dc69-4ae2-44c5-beb5-c5c8e8e72e96",
"metadata": {},
"source": [
"## Using DateTime index to infer frequency"
"### Use DateTime index to infer frequency"
]
},
{
Expand Down
2 changes: 1 addition & 1 deletion nbs/docs/getting-started/3_setting_up_your_api_key.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"<img src=\"https://github.com/Nixtla/nixtla/blob/main/nbs/img/api_key_process.png?raw=true\" alt=\"Figure 1. API key set up process\" />"
"<img src=\"https://github.com/Nixtla/nixtla/blob/main/nbs/img/api_key_process.png?raw=true\" alt=\"Diagram of the API Key configuration process. Method 1. Unsecure. Copy API key from Nixtla dashboard. 2. Paste API Key in Python code. 3. Validate API key. Method 2. Secure. One method, temporary. Open terminal. Set environment variable. Validate API key. Another method, permanent. Create .env File. Set API Key in file. Validate API Key.\" />"
]
},
{
Expand Down
4 changes: 2 additions & 2 deletions nbs/docs/tutorials/14_hierarchical_forecasting.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -156,8 +156,8 @@
"id": "81f2b918",
"metadata": {},
"source": [
"<img src=\"https://github.com/Nixtla/nixtla/blob/main/nbs/img/australia_tourism.png?raw=true\" alt=\"Figure 1. Overview of Australia\" width=\"700\" />\n",
"<img src=\"https://github.com/Nixtla/nixtla/blob/main/nbs/img/australia_hierarchy.png?raw=true\" alt=\"Figure 2. Overview of hierarchy of Australia\" width=\"700\" />"
"<img src=\"https://github.com/Nixtla/nixtla/blob/main/nbs/img/australia_tourism.png?raw=true\" alt=\"Map of Australia color coded by state. The states are from west to east, and then north to south - Western Australia, Northern Territory, South Australia, Queensland, New South Wales, Victoria. Australian Capital Territory is a small area within New South Wales. Tasmania is an island to the southeast.\" width=\"700\" />\n",
"<img src=\"https://github.com/Nixtla/nixtla/blob/main/nbs/img/australia_hierarchy.png?raw=true\" alt=\"Australia hierarchy. Australia at the top with New South Wales and Queenslad below. Sidney, Blue Mountains, and Hunter in New South Wales. Brisbane and Cairns in Queensland.\" width=\"700\" />"
]
},
{
Expand Down
Binary file added nbs/img/dashboard.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading