Skip to content

Commit

Permalink
WIP: Added new sections to FAQs
Browse files Browse the repository at this point in the history
  • Loading branch information
@MMenchero
MMenchero committed Mar 6, 2024
1 parent 1b74000 commit a548022
Showing 1 changed file with 153 additions and 10 deletions.
163 changes: 153 additions & 10 deletions nbs/docs/misc/0_faqs.ipynb
View file
Original file line number Diff line number Diff line change
Expand Up @@ -33,16 +33,7 @@
"execution_count": null,
"id": "621dc459-7da5-4cfa-9e11-7d46c6f46fcf",
"metadata": {},
"outputs": [
{
"name": "stderr",
"output_type": "stream",
"text": [
"/home/ubuntu/miniconda/envs/nixtlats/lib/python3.11/site-packages/statsforecast/core.py:25: TqdmWarning: IProgress not found. Please update jupyter and ipywidgets. See https://ipywidgets.readthedocs.io/en/stable/user_install.html\n",
" from tqdm.autonotebook import tqdm\n"
]
}
],
"outputs": [],
"source": [
"from nixtlats import TimeGPT\n",
"timegpt = TimeGPT(token='paste your token here')"
Expand Down Expand Up @@ -169,6 +160,52 @@
"Remember, your token is like a password - keep it secret, keep it safe!"
]
},
{
"cell_type": "markdown",
"id": "d3c3b76c",
"metadata": {},
"source": [
"### How can I validate my token? \n",
"\n",
"If you want to ensure your token is valid, you can use the `validate_token` method of the `TimeGPT` class. This method will return `True` if the token is valid and `False` if it's not. "
]
},
{
"cell_type": "code",
"execution_count": null,
"id": "fdb02b41",
"metadata": {},
"outputs": [
{
"name": "stderr",
"output_type": "stream",
"text": [
"INFO:nixtlats.timegpt: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"
}
],
"source": [
"timegpt.validate_token()"
]
},
{
"cell_type": "markdown",
"id": "69d9219e",
"metadata": {},
"source": [
"You don't need to validate your token every time you use `TimeGPT`. This function is provided for convenience to ensure that your token has been set up correctly. You can check your token on your dashboard under `API Keys`."
]
},
{
"cell_type": "markdown",
"id": "abf7effe-3536-4cd2-8469-1feede45a52b",
Expand Down Expand Up @@ -506,6 +543,112 @@
"\n",
"Remember that while the SDK abstracts some of the complexities and can automatically handle different dataframes for historical and future values, the API endpoint requires a more manual approach to data preparation."
]
},
{
"cell_type": "markdown",
"id": "5fce7ae9",
"metadata": {},
"source": [
"## Finetuning \n",
"\n",
"### What is finetuning? "
]
},
{
"cell_type": "markdown",
"id": "53067e42",
"metadata": {},
"source": [
"## Pricing and Billing \n",
"\n",
"### How does pricing work? \n",
"\n",
"`TimeGPT`'s cost is based on usage. Every call you make has a certain number of input, output, and finetune tokens associated with it. Price tiers are based on the number of tokens used, which you can find on your [dashboard](https://dashboard.nixtla.io/) under `Billing`. The cost per token decreases as you move up tiers. You'll pay the corresponding price for each segment of tokens used.\n",
"\n",
"### Are there free credits or discounts? \n",
"\n",
"Upon signing up, all users recive $1000 USD in free credits. Once those credits are exhausted, you'll be asked to add a payment method to continue using `TimeGPT`. Costs are then calculated based on the number of tokens used and the price tiers. \n",
"\n",
"The pricing model was designed for production settings where pipelines have already been tested and established. However, if you need additional free credits for testing, or if you are using TimeGPT for academic purposes, please contact us at [email protected] to ask about eligibility for additional free credits or discounts. \n",
"\n",
"Free credits do not expire and can be used at any time.\n",
"\n",
"### How are tokens counted? \n",
"\n",
"One token corresponds to one row of your dataset. Please refer to [TimeGPT Quickstart](https://nixtlaverse.nixtla.io/nixtla/docs/getting-started/getting_started_short.html#usage) and our tutorials to understand the data format required for each use case. For high-frequency data we recommend trimming the input whenever possible. For example, when working with minute-level data, consider trimming to the most recent hour. \n",
"\n",
"### How does billing work? \n",
"\n",
"Billing is done on the first five days of the month. We have partened with Stripe to handle all payment processing. You can view your invoices and payment history in your [dashboard](https://dashboard.nixtla.io/).\n"
]
},
{
"cell_type": "markdown",
"id": "46c45c61",
"metadata": {},
"source": [
"## Privacy and Security \n",
"\n",
"We take your privacy and security very seriously. Below, you can find our terms and conditions: \n",
"\n",
"- For the Python SDK, please review the [license agreement](https://github.com/Nixtla/nixtla/blob/main/LICENSE). \n",
"\n",
"- For `TimeGPT`, refer to our [terms and conditions](https://docs.nixtla.io/docs/terms-and-conditions). \n",
"\n",
"Additionally, we're developing a self-hosted version for enterprise data. This version is currently in beta, so contact us at [email protected] if you're interested in learning more."
]
},
{
"cell_type": "markdown",
"id": "ed724ecd",
"metadata": {},
"source": [
"## Troubleshooting\n",
"\n",
"The following section contains some common errors and their solutions. "
]
},
{
"cell_type": "markdown",
"id": "0adf77d8",
"metadata": {},
"source": [
"### Error message: Invalid API key \n",
"\n",
"``` python\n",
"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_token` method to verify it or review it in the `API Keys` section of your [dashboard](https://dashboard.nixtla.io/)."
]
},
{
"cell_type": "markdown",
"id": "6a40bf84",
"metadata": {},
"source": [
"### Error message: Too many requests \n",
"\n",
"``` python\n",
"ApiError: status_code: 429, body: {'data': None, 'message': 'Too many requests', 'details': 'You need to add a payment method to continue using the API, do so from https://dashboard.nixtla.io', 'code': 'A21', 'requestID': 'NCJDK7KSJ6', 'support': 'If you have questions or need support, please email [email protected]’}\n",
"```\n",
"\n",
"**Solution:** This error occurs when you have exhausted your free credits and need to add a payment method to continue using `TimeGPT`. You can add a payment method in the `Billing` section of your [dashboard](https://dashboard.nixtla.io/)."
]
},
{
"cell_type": "markdown",
"id": "01d5a5e0",
"metadata": {},
"source": [
"## Additional Support\n",
"\n",
"If you have any more questions or need support, please reach out by:\n",
"\n",
"- Opening an [issue](https://github.com/Nixtla/nixtla/issues) on GitHub for technical questions or bugs.\n",
"- Sending an email to [email protected] for general inquiries or support.\n",
"- Joining our [Slack](https://join.slack.com/t/nixtlacommunity/shared_invite/zt-2ebtgjbip-QMSnvm6ED1NF5vi4xj_13Q) community to connect with other users and our team."
]
}
],
"metadata": {
Expand Down

0 comments on commit a548022

Please sign in to comment.