Merge pull request #861 from uber/doc-update-v1.1.4.4

refresh doc for v1.1.4.4
uber · Mar 14, 2024 · b9ae63d · b9ae63d
2 parents 93033f1 + 9dc972c
commit b9ae63d
Show file tree

Hide file tree

Showing 24 changed files with 844 additions and 731 deletions.
diff --git a/.github/workflows/pypi-deploy.yaml b/.github/workflows/pypi-deploy.yaml
@@ -24,25 +24,11 @@ jobs:
           pip install setuptools wheel twine
           pip install build
           pip install auditwheel
-      # - name: Build package
-      #   run:
-      #     python -m build
-      # - name: Convert linux wheel to manylinux wheels
-      #   run:
-      #     auditwheel repair --plat manylinux2014_x86_64 -w dist dist/*linux_x86_64.whl
-      # - name: Remove platform specific linux wheels
-      #   run:
-      #     rm dist/*-linux_x86_64.whl
-      # - name: Publish package
-      #   uses: pypa/[email protected]
-      #   with:
-      #     user: __token__
-      #     password: ${{ secrets.PYPI_PASSWORD }}
       - name: Build and publish
         env:
           TWINE_USERNAME: __token__
           TWINE_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
         run: |
           pip install .
-          python -m build
+          python -m build . --sdist
           python -m twine upload dist/*.tar.gz
diff --git a/docs/tutorials/backtest.ipynb b/docs/tutorials/backtest.ipynb
diff --git a/docs/tutorials/build_your_own_model.ipynb b/docs/tutorials/build_your_own_model.ipynb
diff --git a/docs/tutorials/decompose_prediction.ipynb b/docs/tutorials/decompose_prediction.ipynb
diff --git a/docs/tutorials/dlt.ipynb b/docs/tutorials/dlt.ipynb
diff --git a/docs/tutorials/ets_lgt_dlt_missing_response.ipynb b/docs/tutorials/ets_lgt_dlt_missing_response.ipynb
diff --git a/docs/tutorials/exploratory_data_analysis.ipynb b/docs/tutorials/exploratory_data_analysis.ipynb
diff --git a/docs/tutorials/ktr1.ipynb b/docs/tutorials/ktr1.ipynb
diff --git a/docs/tutorials/ktr2.ipynb b/docs/tutorials/ktr2.ipynb
diff --git a/docs/tutorials/ktr3.ipynb b/docs/tutorials/ktr3.ipynb
diff --git a/docs/tutorials/ktr4.ipynb b/docs/tutorials/ktr4.ipynb
diff --git a/docs/tutorials/lgt.ipynb b/docs/tutorials/lgt.ipynb
diff --git a/docs/tutorials/model_diagnostics.ipynb b/docs/tutorials/model_diagnostics.ipynb
diff --git a/docs/tutorials/model_estimations_predictions.ipynb b/docs/tutorials/model_estimations_predictions.ipynb
diff --git a/docs/tutorials/other_utilities.ipynb b/docs/tutorials/other_utilities.ipynb
@@ -25,7 +25,10 @@
    "source": [
     "import pandas as pd\n",
     "import numpy as np\n",
-    "from orbit.utils.general import expand_grid, regenerate_base_df"
+    "from orbit.utils.general import expand_grid, regenerate_base_df\n",
+    "\n",
+    "import warnings\n",
+    "warnings.filterwarnings('ignore')"
    ]
   },
   {
@@ -56,7 +59,7 @@
       "               '2022-01-31', '2022-02-28', '2022-03-31', '2022-04-30',\n",
       "               '2022-05-31', '2022-06-30', '2022-07-31', '2022-08-31',\n",
       "               '2022-09-30', '2022-10-31', '2022-11-30', '2022-12-31'],\n",
-      "              dtype='datetime64[ns]', freq='M')\n"
+      "              dtype='datetime64[ns]', freq='ME')\n"
      ]
     }
    ],
@@ -119,43 +122,43 @@
        "      <th>0</th>\n",
        "      <td>x0</td>\n",
        "      <td>2020-01-31</td>\n",
-       "      <td>0.646241</td>\n",
+       "      <td>1.325731</td>\n",
        "    </tr>\n",
        "    <tr>\n",
        "      <th>1</th>\n",
        "      <td>x0</td>\n",
        "      <td>2020-02-29</td>\n",
-       "      <td>-0.207489</td>\n",
+       "      <td>0.725421</td>\n",
        "    </tr>\n",
        "    <tr>\n",
        "      <th>2</th>\n",
        "      <td>x0</td>\n",
        "      <td>2020-03-31</td>\n",
-       "      <td>0.141275</td>\n",
+       "      <td>-1.634074</td>\n",
        "    </tr>\n",
        "    <tr>\n",
        "      <th>3</th>\n",
        "      <td>x0</td>\n",
        "      <td>2020-04-30</td>\n",
-       "      <td>-0.492888</td>\n",
+       "      <td>-0.039233</td>\n",
        "    </tr>\n",
        "    <tr>\n",
        "      <th>4</th>\n",
        "      <td>x0</td>\n",
        "      <td>2020-05-31</td>\n",
-       "      <td>1.287505</td>\n",
+       "      <td>0.824808</td>\n",
        "    </tr>\n",
        "  </tbody>\n",
        "</table>\n",
        "</div>"
       ],
       "text/plain": [
        "  key         dt         x\n",
-       "0  x0 2020-01-31  0.646241\n",
-       "1  x0 2020-02-29 -0.207489\n",
-       "2  x0 2020-03-31  0.141275\n",
-       "3  x0 2020-04-30 -0.492888\n",
-       "4  x0 2020-05-31  1.287505"
+       "0  x0 2020-01-31  1.325731\n",
+       "1  x0 2020-02-29  0.725421\n",
+       "2  x0 2020-03-31 -1.634074\n",
+       "3  x0 2020-04-30 -0.039233\n",
+       "4  x0 2020-05-31  0.824808"
       ]
      },
      "execution_count": 3,
@@ -234,43 +237,43 @@
        "      <th>0</th>\n",
        "      <td>x0</td>\n",
        "      <td>2020-01-31</td>\n",
-       "      <td>0.646241</td>\n",
+       "      <td>1.325731</td>\n",
        "    </tr>\n",
        "    <tr>\n",
        "      <th>1</th>\n",
        "      <td>x0</td>\n",
        "      <td>2020-02-29</td>\n",
-       "      <td>-0.207489</td>\n",
+       "      <td>0.725421</td>\n",
        "    </tr>\n",
        "    <tr>\n",
        "      <th>2</th>\n",
        "      <td>x0</td>\n",
        "      <td>2020-03-31</td>\n",
-       "      <td>0.141275</td>\n",
+       "      <td>-1.634074</td>\n",
        "    </tr>\n",
        "    <tr>\n",
        "      <th>3</th>\n",
        "      <td>x0</td>\n",
        "      <td>2020-04-30</td>\n",
-       "      <td>-0.492888</td>\n",
+       "      <td>-0.039233</td>\n",
        "    </tr>\n",
        "    <tr>\n",
        "      <th>4</th>\n",
        "      <td>x0</td>\n",
        "      <td>2020-05-31</td>\n",
-       "      <td>1.287505</td>\n",
+       "      <td>0.824808</td>\n",
        "    </tr>\n",
        "  </tbody>\n",
        "</table>\n",
        "</div>"
       ],
       "text/plain": [
        "  key         dt         x\n",
-       "0  x0 2020-01-31  0.646241\n",
-       "1  x0 2020-02-29 -0.207489\n",
-       "2  x0 2020-03-31  0.141275\n",
-       "3  x0 2020-04-30 -0.492888\n",
-       "4  x0 2020-05-31  1.287505"
+       "0  x0 2020-01-31  1.325731\n",
+       "1  x0 2020-02-29  0.725421\n",
+       "2  x0 2020-03-31 -1.634074\n",
+       "3  x0 2020-04-30 -0.039233\n",
+       "4  x0 2020-05-31  0.824808"
       ]
      },
      "execution_count": 4,
@@ -505,9 +508,9 @@
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": "orbit39",
+   "display_name": "orbit-test",
    "language": "python",
-   "name": "orbit39"
+   "name": "myenv"
   },
   "language_info": {
    "codemirror_mode": {
@@ -519,7 +522,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.9.18"
+   "version": "3.11.8"
   }
  },
  "nbformat": 4,

diff --git a/docs/tutorials/pyro_basic.ipynb b/docs/tutorials/pyro_basic.ipynb
diff --git a/docs/tutorials/quick_start.ipynb b/docs/tutorials/quick_start.ipynb
diff --git a/docs/tutorials/regression_penalty.ipynb b/docs/tutorials/regression_penalty.ipynb
diff --git a/docs/tutorials/regression_prior.ipynb b/docs/tutorials/regression_prior.ipynb
diff --git a/docs/tutorials/residual_diagnostic.ipynb b/docs/tutorials/residual_diagnostic.ipynb
diff --git a/docs/tutorials/set_random_seed.ipynb b/docs/tutorials/set_random_seed.ipynb
@@ -61,7 +61,7 @@
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "1.1.4.3\n"
+      "1.1.4.4\n"
      ]
     }
    ],
@@ -220,8 +220,8 @@
      "name": "stderr",
      "output_type": "stream",
      "text": [
-      "2024-01-21 13:51:04 - orbit - INFO - Optimizing (CmdStanPy) with algorithm: LBFGS.\n",
-      "2024-01-21 13:51:04 - orbit - INFO - Optimizing (CmdStanPy) with algorithm: LBFGS.\n"
+      "2024-03-13 22:01:13 - orbit - INFO - Optimizing (CmdStanPy) with algorithm: LBFGS.\n",
+      "2024-03-13 22:01:13 - orbit - INFO - Optimizing (CmdStanPy) with algorithm: LBFGS.\n"
      ]
     }
    ],
@@ -296,8 +296,8 @@
      "name": "stderr",
      "output_type": "stream",
      "text": [
-      "2024-01-21 13:51:05 - orbit - INFO - Optimizing (CmdStanPy) with algorithm: LBFGS.\n",
-      "2024-01-21 13:51:05 - orbit - INFO - Optimizing (CmdStanPy) with algorithm: LBFGS.\n"
+      "2024-03-13 22:01:13 - orbit - INFO - Optimizing (CmdStanPy) with algorithm: LBFGS.\n",
+      "2024-03-13 22:01:13 - orbit - INFO - Optimizing (CmdStanPy) with algorithm: LBFGS.\n"
      ]
     }
    ],
@@ -351,8 +351,8 @@
      "name": "stderr",
      "output_type": "stream",
      "text": [
-      "2024-01-21 13:51:05 - orbit - INFO - Sampling (CmdStanPy) with chains: 4, cores: 8, temperature: 1.000, warmups (per chain): 225 and samples(per chain): 25.\n",
-      "2024-01-21 13:51:10 - orbit - INFO - Sampling (CmdStanPy) with chains: 4, cores: 8, temperature: 1.000, warmups (per chain): 225 and samples(per chain): 25.\n"
+      "2024-03-13 22:01:13 - orbit - INFO - Sampling (CmdStanPy) with chains: 4, cores: 8, temperature: 1.000, warmups (per chain): 225 and samples(per chain): 25.\n",
+      "2024-03-13 22:01:19 - orbit - INFO - Sampling (CmdStanPy) with chains: 4, cores: 8, temperature: 1.000, warmups (per chain): 225 and samples(per chain): 25.\n"
      ]
     }
    ],
@@ -465,9 +465,9 @@
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": "orbit39",
+   "display_name": "orbit-test",
    "language": "python",
-   "name": "orbit39"
+   "name": "myenv"
   },
   "language_info": {
    "codemirror_mode": {
@@ -479,7 +479,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.9.18"
+   "version": "3.11.8"
   },
   "toc": {
    "base_numbering": 1,

diff --git a/docs/tutorials/utilities_simulation.ipynb b/docs/tutorials/utilities_simulation.ipynb