Skip to content

Commit

Permalink
run getting-started docs (#726)
Browse files Browse the repository at this point in the history
  • Loading branch information
jmoralez authored Dec 15, 2023
1 parent bec4d1e commit 07b06d9
Show file tree
Hide file tree
Showing 12 changed files with 383 additions and 126,784 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/ci.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ jobs:
run: pip install ./

- name: Run local tests
run: nbdev_test --skip_file_re '(models|distributed|ets).*.ipynb' --pause 1.0
run: nbdev_test --skip_file_re '(models|distributed|ets).*.ipynb' --pause 1.0 --do_print --timing

run-tests:
runs-on: ${{ matrix.os }}
Expand All @@ -86,7 +86,7 @@ jobs:
run: pip install ./

- name: Run tests
run: nbdev_test --skip_file_re '(distributed).*.ipynb' --pause 1.0
run: nbdev_test --skip_file_re '(distributed).*.ipynb' --pause 1.0 --do_print --timing

- name: Run integration tests
run: |
Expand Down
Empty file removed nbs/docs/getting-started/.notest
Empty file.
23 changes: 23 additions & 0 deletions nbs/docs/getting-started/0_Installation.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,29 @@
"$ conda activate statsforecast\n",
"```"
]
},
{
"cell_type": "markdown",
"id": "58909f00-5456-4398-80d6-72f8afbdd0e1",
"metadata": {},
"source": [
"## Extras"
]
},
{
"attachments": {},
"cell_type": "markdown",
"id": "ecb9b7ac-36a3-48f9-a847-0fcba777d921",
"metadata": {},
"source": [
"The following features can also be installed by specifying the extra inside the install command, e.g. `pip install 'statsforecast[extra1,extra2]'`\n",
"\n",
"* **polars**: provide polars dataframes to StatsForecast.\n",
"* **plotly**: use `StatsForecast.plot` with the plotly backend.\n",
"* **dask**: perform distributed forecasting with dask.\n",
"* **spark**: perform distributed forecasting with spark.\n",
"* **ray**: perform distributed forecasting with ray."
]
}
],
"metadata": {
Expand Down
2,365 changes: 61 additions & 2,304 deletions nbs/docs/getting-started/1_Getting_Started_short.ipynb

Large diffs are not rendered by default.

Loading

0 comments on commit 07b06d9

Please sign in to comment.