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

redirect to mintlify docs #816

Merged
merged 2 commits into from
Nov 10, 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
22 changes: 18 additions & 4 deletions .github/workflows/build-docs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,14 @@ jobs:
build-docs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- name: Clone repo
uses: actions/checkout@v3
- name: Clone docs repo
uses: actions/checkout@v3
with:
submodules: 'recursive'
repository: Nixtla/docs
ref: scripts
path: docs-scripts
- uses: actions/setup-python@v4
with:
cache: "pip"
Expand Down Expand Up @@ -45,7 +50,16 @@ jobs:
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
- name: Configure redirects for gh-pages
run: python docs-scripts/configure-redirects.py neuralforecast
- name: Deploy to Github Pages
if: github.event_name == 'push'
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_branch: gh-pages
publish_dir: ./gh-pages
user_name: github-actions[bot]
user_email: 41898282+github-actions[bot]@users.noreply.github.com
9 changes: 0 additions & 9 deletions .github/workflows/deploy.yaml

This file was deleted.

4 changes: 0 additions & 4 deletions .gitmodules
Original file line number Diff line number Diff line change
@@ -1,4 +0,0 @@
[submodule "docs-scripts"]
path = docs-scripts
url = https://github.com/Nixtla/docs.git
branch = scripts
1 change: 0 additions & 1 deletion docs-scripts
Submodule docs-scripts deleted from d63d02
2 changes: 1 addition & 1 deletion nbs/core.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
"id": "12fa25a4",
"metadata": {},
"source": [
"# <span style=\"color:DarkOrange\"> Core </span>\n",
"# Core\n",
"> NeuralForecast contains two main components, PyTorch implementations deep learning predictive models, as well as parallelization and distributed computation utilities. The first component comprises low-level PyTorch model estimator classes like `models.NBEATS` and `models.RNN`. The second component is a high-level `core.NeuralForecast` wrapper class that operates with sets of time series data stored in pandas DataFrames."
]
},
Expand Down
1 change: 0 additions & 1 deletion nbs/mint.json
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,6 @@
"pages": [
"core.html",
"models.html",
"models.html",
{
"group": "Models' Documentation",
"pages": [
Expand Down
2 changes: 1 addition & 1 deletion nbs/models.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,7 @@
"id": "7ae65ca7",
"metadata": {},
"source": [
"# <span style=\"color:DarkOrange\"> Models </span>\n",
"# Models\n",
"\n",
"> NeuralForecast contains user-friendly implementations of neural forecasting models that allow for easy transition of computing capabilities (GPU/CPU), computation parallelization, and hyperparameter tuning.<br><br> All the NeuralForecast models are \"global\" because we train them with all the series from the input pd.DataFrame data `Y_df`, yet the optimization objective is, momentarily, \"univariate\" as it does not consider the interaction between the output predictions across time series. Like the StatsForecast library, `core.NeuralForecast` allows you to explore collections of models efficiently and contains functions for convenient wrangling of input and output pd.DataFrames predictions."
]
Expand Down
Loading