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

feat: Added nixtlar to TimeGPT docs #393

Merged
merged 5 commits into from
Jun 13, 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
47 changes: 47 additions & 0 deletions nbs/docs/reference/04_nixtlar.ipynb
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
{
"cells": [
{
"cell_type": "markdown",
"metadata": {},
"source": [
"# TimeGPT in R\n",
"\n",
"TimeGPT is also available in R through the `nixtlar` package, which is available on CRAN. This package can be used in a way almost identical to its Python counterpart. It offers nearly the same functionalities, with missing features and documentation currently under development. Originally developed in Python, TimeGPT is now accessible to the R community through `nixtlar`, providing access to the first foundation model for time series forecasting and embracing our core philosophy that _the future is for everybody_."
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"<img src=\"https://github.com/Nixtla/nixtla/blob/main/nbs/img/logo_nixtlar.png?raw=true\" alt=\"Logo for nixtlar\" width=\"700\" />"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"## How to use \n",
"\n",
"To learn how to use `nixtlar`, please refer to the [documentation](https://nixtla.github.io/nixtlar/). \n",
"\n",
"To view directly on CRAN, please use this [link](https://cloud.r-project.org/web/packages/nixtlar/index.html). "
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"> 📘 API key required\n",
"> \n",
"> The `nixtlar` package requires an API key. Get yours on the [Nixtla Dashboard](http://dashboard.nixtla.io). \n",
"\n",
"## Support\n",
"\n",
"If you have questions or need support, please email [ops@nixtla.io](mailto:ops@nixtla.io)."
]
}
],
"metadata": {},
"nbformat": 4,
"nbformat_minor": 2
}
Binary file added nbs/img/logo_nixtlar.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 2 additions & 1 deletion nbs/mint.json
Original file line number Diff line number Diff line change
Expand Up @@ -141,7 +141,8 @@
"group": "API Reference",
"pages": ["docs/reference/nixtla_client.html",
"docs/reference/date_features.html",
"docs/reference/excel_addin.html"
"docs/reference/excel_addin.html",
"docs/reference/nixtlar.html"
]
}
]
Expand Down
Loading