Merge branch 'main' into feature/partition_automatically

.github/workflows/build-docs.yaml

@@ -1,7 +1,7 @@
 name: "build-docs"
 on:
-  push:
-    branches: ["main"]
+  release:
+    types: [released]
   pull_request:
     branches: ["main"]
   workflow_dispatch:
@@ -45,7 +45,9 @@ jobs:
           cp nbs/mint.json _docs/mint.json
           cp docs-scripts/imgs/* _docs/
       - name: Deploy to Mintlify Docs
-        if: github.event_name == 'push'
+        if: | 
+          github.event_name == 'release' || 
+          github.event_name == 'workflow_dispatch'
         uses: peaceiris/actions-gh-pages@4f9cc6602d3f66b9c108549d475ec49e8ef4d45e # v4.0.0
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}
@@ -54,7 +56,9 @@ jobs:
           user_name: github-actions[bot]
           user_email: 41898282+github-actions[bot]@users.noreply.github.com
       - name: Trigger mintlify workflow
-        if: github.event_name == 'push'
+        if: | 
+          github.event_name == 'release' ||
+          github.event_name == 'workflow_dispatch'
         uses: actions/github-script@60a0d83039c74a4aee543508d2ffcb1c3799cdea # v7.0.1
         with:
           github-token: ${{ secrets.DOCS_WORKFLOW_TOKEN }}
@@ -68,7 +72,9 @@ jobs:
       - name: Configure redirects for gh-pages
         run: python docs-scripts/configure-redirects.py nixtla
       - name: Deploy to Github Pages
-        if: github.event_name == 'push'
+        if: | 
+          github.event_name == 'release' ||
+          github.event_name == 'workflow_dispatch'
         uses: peaceiris/actions-gh-pages@4f9cc6602d3f66b9c108549d475ec49e8ef4d45e # v4.0.0
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/deploy-readme.yaml

@@ -1,8 +1,8 @@
 name: Deploy to readme dot com
 
 on:
-  push:
-    branches: [main]
+  release:
+    types: [published]
   workflow_dispatch:
 
 defaults:

nbs/docs/getting-started/1_introduction.ipynb

@@ -52,7 +52,7 @@
     "\n",
     "Self-attention, the revolutionary concept introduced by the paper [Attention is all you need](https://arxiv.org/abs/1706.03762), is the basis of this foundation model. TimeGPT model is not based on any existing large language model(LLM). Instead, it is independently trained on a vast amount of time series data, and the large transformer model is designed to minimize the forecasting error.\n",
     "\n",
-    "<img src=\"../../img/timegpt_archi.png\">\n",
+    "<img src=\"../../img/timegpt_archi.png\" />\n",
     "\n",
     "The architecture consists of an encoder-decoder structure with multiple layers, each with residual connections and layer normalization. Finally, a linear layer maps the decoder’s output to the forecasting window dimension. The general intuition is that attention-based mechanisms are able to capture the diversity of past events and correctly extrapolate potential future distributions."
    ]

nbs/docs/getting-started/4_data_requirements.ipynb

@@ -46,7 +46,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "`TimeGPT` accepts `pandas` dataframes in [long format](https://www.theanalysisfactor.com/wide-and-long-data/#comments) with the following necessary columns: \n",
+    "`TimeGPT` accepts `pandas` and `polars` dataframes in [long format](https://www.theanalysisfactor.com/wide-and-long-data/#comments) with the following necessary columns: \n",
     "\n",
     "- `ds` (timestamp): timestamp in format `YYYY-MM-DD` or `YYYY-MM-DD HH:MM:SS`. \n",
     "- `y` (numeric): The target variable to forecast. \n",
@@ -939,5 +939,5 @@
   }
  },
  "nbformat": 4,
- "nbformat_minor": 2
+ "nbformat_minor": 4
 }

nbs/mint.json

@@ -25,6 +25,7 @@
       "pages": [
         "docs/getting-started/introduction.html",
         "docs/getting-started/quickstart.html",
+        "docs/getting-started/polars_quickstart.html",
         "docs/getting-started/setting_up_your_api_key.html",
         "docs/getting-started/data_requirements.html",
         "docs/getting-started/faq.html",