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

Fix parsing errors & add mint.json #794

Merged
merged 8 commits into from
Oct 24, 2023
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
51 changes: 51 additions & 0 deletions .github/workflows/build-docs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
name: "build-docs"
on:
push:
branches: ["main"]
pull_request:
branches: ["main"]
workflow_dispatch:

defaults:
run:
shell: bash

jobs:
build-docs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
with:
submodules: 'recursive'
- uses: actions/setup-python@v4
with:
cache: "pip"
python-version: '3.10'
cache-dependency-path: settings.ini
- name: Build docs
run: |
set -ux
python -m pip install --upgrade pip
pip install -Uq nbdev
pip install -e ".[dev]"
mkdir nbs/_extensions
cp -r docs-scripts/mintlify/ nbs/_extensions/
python docs-scripts/update-quarto.py
nbdev_docs
- name: Apply final formats
run: bash ./docs-scripts/docs-final-formatting.bash
- name: Copy over necessary assets
run: |
cp nbs/mint.json _docs/mint.json
cp docs-scripts/imgs/* _docs/
- name: Deploy to Mintlify Docs
if: github.event_name == 'push'
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_branch: docs
publish_dir: ./_docs
# The following lines assign commit authorship to the official GH-Actions bot for deploys to `docs` branch.
# You can swap them out with your own user credentials.
user_name: github-actions[bot]
user_email: 41898282+github-actions[bot]@users.noreply.github.com
4 changes: 4 additions & 0 deletions .gitmodules
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
[submodule "docs-scripts"]
path = docs-scripts
url = [email protected]:Nixtla/docs.git
branch = scripts
1 change: 1 addition & 0 deletions docs-scripts
Submodule docs-scripts added at d63d02
234 changes: 105 additions & 129 deletions nbs/examples/Automatic_Hyperparameter_Tuning.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -54,8 +54,7 @@
"outputs": [],
"source": [
"%%capture\n",
"!pip install neuralforecast\n",
"!pip install hyperopt"
"# !pip install neuralforecast hyperopt"
]
},
{
Expand Down Expand Up @@ -879,149 +878,138 @@
" <th>params_n_freq_downsample</th>\n",
" <th>params_n_pool_kernel_size</th>\n",
" <th>params_random_seed</th>\n",
" <th>user_attrs_ALL_PARAMS</th>\n",
" <th>state</th>\n",
" </tr>\n",
" </thead>\n",
" <tbody>\n",
" <tr>\n",
" <th>0</th>\n",
" <td>0</td>\n",
" <td>7.257883e+07</td>\n",
" <td>2023-10-03 11:20:55.218656</td>\n",
" <td>2023-10-03 11:21:03.084276</td>\n",
" <td>0 days 00:00:07.865620</td>\n",
" <td>0.063594</td>\n",
" <td>[1, 1, 1]</td>\n",
" <td>2.964735e+01</td>\n",
" <td>2023-10-23 19:13:30.251719</td>\n",
" <td>2023-10-23 19:13:33.007086</td>\n",
" <td>0 days 00:00:02.755367</td>\n",
" <td>0.000074</td>\n",
" <td>[24, 12, 1]</td>\n",
" <td>[2, 2, 2]</td>\n",
" <td>6</td>\n",
" <td>{'max_steps': 100, 'input_size': 24, 'learning...</td>\n",
" <td>2</td>\n",
" <td>COMPLETE</td>\n",
" </tr>\n",
" <tr>\n",
" <th>1</th>\n",
" <td>1</td>\n",
" <td>1.942069e+01</td>\n",
" <td>2023-10-03 11:21:03.084708</td>\n",
" <td>2023-10-03 11:21:11.257456</td>\n",
" <td>0 days 00:00:08.172748</td>\n",
" <td>0.000425</td>\n",
" <td>[168, 24, 1]</td>\n",
" <td>2.790444e+03</td>\n",
" <td>2023-10-23 19:13:33.007483</td>\n",
" <td>2023-10-23 19:13:35.823089</td>\n",
" <td>0 days 00:00:02.815606</td>\n",
" <td>0.026500</td>\n",
" <td>[24, 12, 1]</td>\n",
" <td>[2, 2, 2]</td>\n",
" <td>6</td>\n",
" <td>{'max_steps': 100, 'input_size': 24, 'learning...</td>\n",
" <td>10</td>\n",
" <td>COMPLETE</td>\n",
" </tr>\n",
" <tr>\n",
" <th>2</th>\n",
" <td>2</td>\n",
" <td>9.739689e+11</td>\n",
" <td>2023-10-03 11:21:11.258083</td>\n",
" <td>2023-10-03 11:21:19.065551</td>\n",
" <td>0 days 00:00:07.807468</td>\n",
" <td>0.075866</td>\n",
" <td>2.193000e+01</td>\n",
" <td>2023-10-23 19:13:35.823607</td>\n",
" <td>2023-10-23 19:13:38.599414</td>\n",
" <td>0 days 00:00:02.775807</td>\n",
" <td>0.000337</td>\n",
" <td>[168, 24, 1]</td>\n",
" <td>[2, 2, 2]</td>\n",
" <td>1</td>\n",
" <td>{'max_steps': 100, 'input_size': 24, 'learning...</td>\n",
" <td>7</td>\n",
" <td>COMPLETE</td>\n",
" </tr>\n",
" <tr>\n",
" <th>3</th>\n",
" <td>3</td>\n",
" <td>3.989237e+04</td>\n",
" <td>2023-10-03 11:21:19.065988</td>\n",
" <td>2023-10-03 11:21:27.578646</td>\n",
" <td>0 days 00:00:08.512658</td>\n",
" <td>0.020554</td>\n",
" <td>[24, 12, 1]</td>\n",
" <td>[2, 2, 2]</td>\n",
" <td>1</td>\n",
" <td>{'max_steps': 100, 'input_size': 24, 'learning...</td>\n",
" <td>1.147799e+08</td>\n",
" <td>2023-10-23 19:13:38.600149</td>\n",
" <td>2023-10-23 19:13:41.440307</td>\n",
" <td>0 days 00:00:02.840158</td>\n",
" <td>0.059274</td>\n",
" <td>[1, 1, 1]</td>\n",
" <td>[16, 8, 1]</td>\n",
" <td>5</td>\n",
" <td>COMPLETE</td>\n",
" </tr>\n",
" <tr>\n",
" <th>4</th>\n",
" <td>4</td>\n",
" <td>1.443079e+03</td>\n",
" <td>2023-10-03 11:21:27.579112</td>\n",
" <td>2023-10-03 11:21:35.763104</td>\n",
" <td>0 days 00:00:08.183992</td>\n",
" <td>0.027780</td>\n",
" <td>[24, 12, 1]</td>\n",
" <td>2.140740e+01</td>\n",
" <td>2023-10-23 19:13:41.440833</td>\n",
" <td>2023-10-23 19:13:44.184860</td>\n",
" <td>0 days 00:00:02.744027</td>\n",
" <td>0.000840</td>\n",
" <td>[168, 24, 1]</td>\n",
" <td>[16, 8, 1]</td>\n",
" <td>7</td>\n",
" <td>{'max_steps': 100, 'input_size': 24, 'learning...</td>\n",
" <td>5</td>\n",
" <td>COMPLETE</td>\n",
" </tr>\n",
" <tr>\n",
" <th>5</th>\n",
" <td>5</td>\n",
" <td>2.354673e+01</td>\n",
" <td>2023-10-03 11:21:35.763652</td>\n",
" <td>2023-10-03 11:21:44.838978</td>\n",
" <td>0 days 00:00:09.075326</td>\n",
" <td>0.000176</td>\n",
" <td>[24, 12, 1]</td>\n",
" <td>[2, 2, 2]</td>\n",
" <td>4</td>\n",
" <td>{'max_steps': 100, 'input_size': 24, 'learning...</td>\n",
" <td>1.606544e+01</td>\n",
" <td>2023-10-23 19:13:44.185291</td>\n",
" <td>2023-10-23 19:13:46.945672</td>\n",
" <td>0 days 00:00:02.760381</td>\n",
" <td>0.005477</td>\n",
" <td>[1, 1, 1]</td>\n",
" <td>[16, 8, 1]</td>\n",
" <td>8</td>\n",
" <td>COMPLETE</td>\n",
" </tr>\n",
" <tr>\n",
" <th>6</th>\n",
" <td>6</td>\n",
" <td>5.158909e+01</td>\n",
" <td>2023-10-03 11:21:44.839487</td>\n",
" <td>2023-10-03 11:21:55.577230</td>\n",
" <td>0 days 00:00:10.737743</td>\n",
" <td>0.000018</td>\n",
" <td>[24, 12, 1]</td>\n",
" <td>[2, 2, 2]</td>\n",
" <td>9</td>\n",
" <td>{'max_steps': 100, 'input_size': 24, 'learning...</td>\n",
" <td>1.301640e+04</td>\n",
" <td>2023-10-23 19:13:46.946108</td>\n",
" <td>2023-10-23 19:13:49.805633</td>\n",
" <td>0 days 00:00:02.859525</td>\n",
" <td>0.056746</td>\n",
" <td>[1, 1, 1]</td>\n",
" <td>[16, 8, 1]</td>\n",
" <td>3</td>\n",
" <td>COMPLETE</td>\n",
" </tr>\n",
" <tr>\n",
" <th>7</th>\n",
" <td>7</td>\n",
" <td>7.657581e+01</td>\n",
" <td>2023-10-03 11:21:55.578412</td>\n",
" <td>2023-10-03 11:22:05.263415</td>\n",
" <td>0 days 00:00:09.685003</td>\n",
" <td>0.017256</td>\n",
" <td>[168, 24, 1]</td>\n",
" <td>4.972713e+01</td>\n",
" <td>2023-10-23 19:13:49.806278</td>\n",
" <td>2023-10-23 19:13:52.577180</td>\n",
" <td>0 days 00:00:02.770902</td>\n",
" <td>0.000021</td>\n",
" <td>[24, 12, 1]</td>\n",
" <td>[2, 2, 2]</td>\n",
" <td>8</td>\n",
" <td>{'max_steps': 100, 'input_size': 24, 'learning...</td>\n",
" <td>9</td>\n",
" <td>COMPLETE</td>\n",
" </tr>\n",
" <tr>\n",
" <th>8</th>\n",
" <td>8</td>\n",
" <td>1.957761e+01</td>\n",
" <td>2023-10-03 11:22:05.263939</td>\n",
" <td>2023-10-03 11:22:14.527842</td>\n",
" <td>0 days 00:00:09.263903</td>\n",
" <td>0.004017</td>\n",
" <td>[24, 12, 1]</td>\n",
" <td>2.138879e+01</td>\n",
" <td>2023-10-23 19:13:52.577678</td>\n",
" <td>2023-10-23 19:13:55.372792</td>\n",
" <td>0 days 00:00:02.795114</td>\n",
" <td>0.007136</td>\n",
" <td>[1, 1, 1]</td>\n",
" <td>[2, 2, 2]</td>\n",
" <td>7</td>\n",
" <td>{'max_steps': 100, 'input_size': 24, 'learning...</td>\n",
" <td>9</td>\n",
" <td>COMPLETE</td>\n",
" </tr>\n",
" <tr>\n",
" <th>9</th>\n",
" <td>9</td>\n",
" <td>3.355409e+01</td>\n",
" <td>2023-10-03 11:22:14.528438</td>\n",
" <td>2023-10-03 11:22:23.752345</td>\n",
" <td>0 days 00:00:09.223907</td>\n",
" <td>0.000065</td>\n",
" <td>2.094145e+01</td>\n",
" <td>2023-10-23 19:13:55.373149</td>\n",
" <td>2023-10-23 19:13:58.125058</td>\n",
" <td>0 days 00:00:02.751909</td>\n",
" <td>0.004655</td>\n",
" <td>[1, 1, 1]</td>\n",
" <td>[16, 8, 1]</td>\n",
" <td>7</td>\n",
" <td>{'max_steps': 100, 'input_size': 24, 'learning...</td>\n",
" <td>[2, 2, 2]</td>\n",
" <td>6</td>\n",
" <td>COMPLETE</td>\n",
" </tr>\n",
" </tbody>\n",
Expand All @@ -1030,52 +1018,40 @@
],
"text/plain": [
" number value datetime_start datetime_complete \\\n",
"0 0 7.257883e+07 2023-10-03 11:20:55.218656 2023-10-03 11:21:03.084276 \n",
"1 1 1.942069e+01 2023-10-03 11:21:03.084708 2023-10-03 11:21:11.257456 \n",
"2 2 9.739689e+11 2023-10-03 11:21:11.258083 2023-10-03 11:21:19.065551 \n",
"3 3 3.989237e+04 2023-10-03 11:21:19.065988 2023-10-03 11:21:27.578646 \n",
"4 4 1.443079e+03 2023-10-03 11:21:27.579112 2023-10-03 11:21:35.763104 \n",
"5 5 2.354673e+01 2023-10-03 11:21:35.763652 2023-10-03 11:21:44.838978 \n",
"6 6 5.158909e+01 2023-10-03 11:21:44.839487 2023-10-03 11:21:55.577230 \n",
"7 7 7.657581e+01 2023-10-03 11:21:55.578412 2023-10-03 11:22:05.263415 \n",
"8 8 1.957761e+01 2023-10-03 11:22:05.263939 2023-10-03 11:22:14.527842 \n",
"9 9 3.355409e+01 2023-10-03 11:22:14.528438 2023-10-03 11:22:23.752345 \n",
"0 0 2.964735e+01 2023-10-23 19:13:30.251719 2023-10-23 19:13:33.007086 \n",
"1 1 2.790444e+03 2023-10-23 19:13:33.007483 2023-10-23 19:13:35.823089 \n",
"2 2 2.193000e+01 2023-10-23 19:13:35.823607 2023-10-23 19:13:38.599414 \n",
"3 3 1.147799e+08 2023-10-23 19:13:38.600149 2023-10-23 19:13:41.440307 \n",
"4 4 2.140740e+01 2023-10-23 19:13:41.440833 2023-10-23 19:13:44.184860 \n",
"5 5 1.606544e+01 2023-10-23 19:13:44.185291 2023-10-23 19:13:46.945672 \n",
"6 6 1.301640e+04 2023-10-23 19:13:46.946108 2023-10-23 19:13:49.805633 \n",
"7 7 4.972713e+01 2023-10-23 19:13:49.806278 2023-10-23 19:13:52.577180 \n",
"8 8 2.138879e+01 2023-10-23 19:13:52.577678 2023-10-23 19:13:55.372792 \n",
"9 9 2.094145e+01 2023-10-23 19:13:55.373149 2023-10-23 19:13:58.125058 \n",
"\n",
" duration params_learning_rate params_n_freq_downsample \\\n",
"0 0 days 00:00:07.865620 0.063594 [1, 1, 1] \n",
"1 0 days 00:00:08.172748 0.000425 [168, 24, 1] \n",
"2 0 days 00:00:07.807468 0.075866 [168, 24, 1] \n",
"3 0 days 00:00:08.512658 0.020554 [24, 12, 1] \n",
"4 0 days 00:00:08.183992 0.027780 [24, 12, 1] \n",
"5 0 days 00:00:09.075326 0.000176 [24, 12, 1] \n",
"6 0 days 00:00:10.737743 0.000018 [24, 12, 1] \n",
"7 0 days 00:00:09.685003 0.017256 [168, 24, 1] \n",
"8 0 days 00:00:09.263903 0.004017 [24, 12, 1] \n",
"9 0 days 00:00:09.223907 0.000065 [1, 1, 1] \n",
"\n",
" params_n_pool_kernel_size params_random_seed \\\n",
"0 [2, 2, 2] 6 \n",
"1 [2, 2, 2] 6 \n",
"2 [2, 2, 2] 1 \n",
"3 [2, 2, 2] 1 \n",
"4 [16, 8, 1] 7 \n",
"5 [2, 2, 2] 4 \n",
"6 [2, 2, 2] 9 \n",
"7 [2, 2, 2] 8 \n",
"8 [2, 2, 2] 7 \n",
"9 [16, 8, 1] 7 \n",
"0 0 days 00:00:02.755367 0.000074 [24, 12, 1] \n",
"1 0 days 00:00:02.815606 0.026500 [24, 12, 1] \n",
"2 0 days 00:00:02.775807 0.000337 [168, 24, 1] \n",
"3 0 days 00:00:02.840158 0.059274 [1, 1, 1] \n",
"4 0 days 00:00:02.744027 0.000840 [168, 24, 1] \n",
"5 0 days 00:00:02.760381 0.005477 [1, 1, 1] \n",
"6 0 days 00:00:02.859525 0.056746 [1, 1, 1] \n",
"7 0 days 00:00:02.770902 0.000021 [24, 12, 1] \n",
"8 0 days 00:00:02.795114 0.007136 [1, 1, 1] \n",
"9 0 days 00:00:02.751909 0.004655 [1, 1, 1] \n",
"\n",
" user_attrs_ALL_PARAMS state \n",
"0 {'max_steps': 100, 'input_size': 24, 'learning... COMPLETE \n",
"1 {'max_steps': 100, 'input_size': 24, 'learning... COMPLETE \n",
"2 {'max_steps': 100, 'input_size': 24, 'learning... COMPLETE \n",
"3 {'max_steps': 100, 'input_size': 24, 'learning... COMPLETE \n",
"4 {'max_steps': 100, 'input_size': 24, 'learning... COMPLETE \n",
"5 {'max_steps': 100, 'input_size': 24, 'learning... COMPLETE \n",
"6 {'max_steps': 100, 'input_size': 24, 'learning... COMPLETE \n",
"7 {'max_steps': 100, 'input_size': 24, 'learning... COMPLETE \n",
"8 {'max_steps': 100, 'input_size': 24, 'learning... COMPLETE \n",
"9 {'max_steps': 100, 'input_size': 24, 'learning... COMPLETE "
" params_n_pool_kernel_size params_random_seed state \n",
"0 [2, 2, 2] 2 COMPLETE \n",
"1 [2, 2, 2] 10 COMPLETE \n",
"2 [2, 2, 2] 7 COMPLETE \n",
"3 [16, 8, 1] 5 COMPLETE \n",
"4 [16, 8, 1] 5 COMPLETE \n",
"5 [16, 8, 1] 8 COMPLETE \n",
"6 [16, 8, 1] 3 COMPLETE \n",
"7 [2, 2, 2] 9 COMPLETE \n",
"8 [2, 2, 2] 9 COMPLETE \n",
"9 [2, 2, 2] 6 COMPLETE "
]
},
"execution_count": null,
Expand All @@ -1085,7 +1061,7 @@
],
"source": [
"results = nf.models[0].results.trials_dataframe()\n",
"results"
"results.drop(columns='user_attrs_ALL_PARAMS')"
]
},
{
Expand Down
Loading
Loading