Skip to content

Commit 5ada76a

Browse files
authored
Merge branch 'main' into review
2 parents e1ff369 + 3f14685 commit 5ada76a

File tree

3 files changed

+164
-167
lines changed

3 files changed

+164
-167
lines changed

.github/workflows/build-docs.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ jobs:
7171
await github.rest.actions.createWorkflowDispatch({
7272
owner: 'nixtla',
7373
repo: 'docs',
74-
workflow_id: 'mintlify-action-preview.yml',
74+
workflow_id: 'preview.yml',
7575
ref: 'main',
7676
});
7777
@@ -84,6 +84,6 @@ jobs:
8484
await github.rest.actions.createWorkflowDispatch({
8585
owner: 'nixtla',
8686
repo: 'docs',
87-
workflow_id: 'mintlify-action.yml',
87+
workflow_id: 'production.yml',
8888
ref: 'main',
8989
});

docs/mintlify/docs.json

Lines changed: 162 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,162 @@
1+
{
2+
"$schema": "https://mintlify.com/docs.json",
3+
"theme": "mint",
4+
"name": "Nixtla",
5+
"colors": {
6+
"primary": "#0E0E0E",
7+
"light": "#FAFAFA",
8+
"dark": "#0E0E0E"
9+
},
10+
"favicon": "/favicon.svg",
11+
"navigation": {
12+
"groups": [
13+
{
14+
"group": "Getting Started",
15+
"pages": [
16+
"docs/getting-started/introduction.html",
17+
"docs/getting-started/quickstart.html",
18+
"docs/getting-started/installation.html",
19+
"docs/getting-started/datarequirements.html"
20+
]
21+
},
22+
{
23+
"group": "Capabilities",
24+
"pages": [
25+
"docs/capabilities/overview.html",
26+
"docs/capabilities/objectives.html",
27+
"docs/capabilities/exogenous_variables.html",
28+
"docs/capabilities/cross_validation.html",
29+
"docs/capabilities/hyperparameter_tuning.html",
30+
"docs/capabilities/predictInsample.html",
31+
"docs/capabilities/save_load_models.html",
32+
"docs/capabilities/time_series_scaling.html"
33+
]
34+
},
35+
{
36+
"group": "Tutorials",
37+
"pages": [
38+
{
39+
"group": "Forecasting",
40+
"pages": [
41+
"docs/tutorials/getting_started_complete.html",
42+
"docs/tutorials/cross_validation.html",
43+
"docs/tutorials/longhorizon_nhits.html",
44+
"docs/tutorials/longhorizon_transformers.html",
45+
"docs/tutorials/forecasting_tft.html",
46+
"docs/tutorials/multivariate_tsmixer.html"
47+
]
48+
},
49+
{
50+
"group": "Probabilistic Forecasting",
51+
"pages": [
52+
"docs/tutorials/uncertainty_quantification.html",
53+
"docs/tutorials/longhorizon_probabilistic.html",
54+
"docs/tutorials/conformal_prediction.html"
55+
]
56+
},
57+
{
58+
"group": "Special Topics",
59+
"pages": [
60+
"docs/tutorials/hierarchical_forecasting.html",
61+
"docs/tutorials/distributed_neuralforecast.html",
62+
"docs/tutorials/intermittent_data.html",
63+
"docs/tutorials/using_mlflow.html",
64+
"docs/tutorials/robust_forecasting.html",
65+
"docs/tutorials/interpretable_decompositions.html",
66+
"docs/tutorials/comparing_methods.html",
67+
"docs/tutorials/temporal_classification.html",
68+
"docs/tutorials/transfer_learning.html",
69+
"docs/tutorials/adding_models.html",
70+
"docs/tutorials/large_datasets.html"
71+
]
72+
}
73+
]
74+
},
75+
{
76+
"group": "Use cases",
77+
"pages": [
78+
"docs/use-cases/electricity_peak_forecasting.html",
79+
"docs/use-cases/predictive_maintenance.html"
80+
]
81+
},
82+
{
83+
"group": "API Reference",
84+
"pages": [
85+
"core.html",
86+
{
87+
"group": "Models",
88+
"pages": [
89+
"models.autoformer.html",
90+
"models.bitcn.html",
91+
"models.deepar.html",
92+
"models.deepnpts.html",
93+
"models.dilated_rnn.html",
94+
"models.dlinear.html",
95+
"models.fedformer.html",
96+
"models.gru.html",
97+
"models.hint.html",
98+
"models.informer.html",
99+
"models.itransformer.html",
100+
"models.kan.html",
101+
"models.lstm.html",
102+
"models.mlp.html",
103+
"models.mlpmultivariate.html",
104+
"models.nbeats.html",
105+
"models.nbeatsx.html",
106+
"models.nhits.html",
107+
"models.nlinear.html",
108+
"models.patchtst.html",
109+
"models.rmok.html",
110+
"models.rnn.html",
111+
"models.softs.html",
112+
"models.stemgnn.html",
113+
"models.tcn.html",
114+
"models.tft.html",
115+
"models.tide.html",
116+
"models.timellm.html",
117+
"models.timemixer.html",
118+
"models.timesnet.html",
119+
"models.timexer.html",
120+
"models.tsmixer.html",
121+
"models.tsmixerx.html",
122+
"models.vanillatransformer.html"
123+
]
124+
},
125+
"models.html",
126+
{
127+
"group": "Train/Evaluation",
128+
"pages": [
129+
"losses.pytorch.html",
130+
"losses.numpy.html"
131+
]
132+
},
133+
{
134+
"group": "Common Components",
135+
"pages": [
136+
"common.base_auto.html",
137+
"common.scalers.html",
138+
"common.modules.html"
139+
]
140+
},
141+
{
142+
"group": "Utils",
143+
"pages": [
144+
"tsdataset.html",
145+
"utils.html"
146+
]
147+
}
148+
]
149+
}
150+
]
151+
},
152+
"logo": {
153+
"light": "/light.png",
154+
"dark": "/dark.png"
155+
},
156+
"navbar": {
157+
"primary": {
158+
"type": "github",
159+
"href": "https://github.com/Nixtla/neuralforecast"
160+
}
161+
}
162+
}

docs/mintlify/mint.json

Lines changed: 0 additions & 165 deletions
This file was deleted.

0 commit comments

Comments
 (0)