|
350 | 350 | "\n", |
351 | 351 | "### b. Tests and documentation\n", |
352 | 352 | "\n", |
353 | | - "`nbdev` allows for testing and documenting the model during the development process. It allows users to iterate the development within the notebook, testing the code in the same environment. Refer to existing models, such as the complete MLP model [here](https://github.com/Nixtla/neuralforecast/blob/main/nbs/models.mlp.ipynb). These files already contain the tests, documentation, and usage examples that were used during the development process.\n", |
| 353 | + "`nbdev` allows for testing and documenting the model during the development process. It allows users to iterate the development within the notebook, testing the code in the same environment. Refer to the existing MLP [implementation](https://github.com/Nixtla/neuralforecast/blob/main/neuralforecast/models/mlp.py), [tests](https://github.com/Nixtla/neuralforecast/blob/main/tests/test_models/test_mlp.py), and [usage documentation](https://nixtlaverse.nixtla.io/neuralforecast/models.mlp.html) for a complete example of the model development process.\n", |
354 | 354 | "\n", |
355 | 355 | "### c. Export the new model to the library with `nbdev`\n", |
356 | 356 | "\n", |
|
369 | 369 | "Finally, add the model to the `core` class and additional files:\n", |
370 | 370 | "\n", |
371 | 371 | "1. Manually add the model in the following [init file](https://github.com/Nixtla/neuralforecast/blob/main/neuralforecast/models/__init__.py).\n", |
372 | | - "2. Add the model to the `core` class, using the `nbdev` file [here](https://github.com/Nixtla/neuralforecast/blob/main/nbs/core.ipynb):\n", |
| 372 | + "2. Add the model to the `core` class, using the source file [here](https://github.com/Nixtla/neuralforecast/blob/main/neuralforecast/core.py):\n", |
373 | 373 | " \n", |
374 | 374 | " a. Add the model to the initial model list:\n", |
375 | 375 | " ```python\n", |
|
392 | 392 | "\n", |
393 | 393 | "It's important to add the model to the necessary documentation pages so that everyone can find the documentation:\n", |
394 | 394 | "\n", |
395 | | - "1. Add the model to the [model overview table](https://github.com/Nixtla/neuralforecast/blob/main/nbs/docs/capabilities/01_overview.ipynb).\n", |
396 | | - "2. Add the model to the [sidebar](https://github.com/Nixtla/neuralforecast/blob/main/nbs/sidebar.yml) for the API reference.\n", |
397 | | - "3. Add the model to [mint.json](https://github.com/Nixtla/neuralforecast/blob/main/nbs/mint.json)." |
| 395 | + "1. Add the model to the [model overview table](https://github.com/Nixtla/neuralforecast/blob/main/nbs/docs/capabilities/overview.ipynb).\n", |
| 396 | + "2. Add the model to the [documentation navigation](https://github.com/Nixtla/neuralforecast/blob/main/docs/mintlify/docs.json) for the API reference.\n", |
| 397 | + "3. Confirm the page is present in [docs.json](https://github.com/Nixtla/neuralforecast/blob/main/docs/mintlify/docs.json)." |
398 | 398 | ] |
399 | 399 | }, |
400 | 400 | { |
|
424 | 424 | "* Implement `init` and `forward` methods and set the class attributes.\n", |
425 | 425 | "* Export model with `nbdev_export`.\n", |
426 | 426 | "* Add model to this [init file](https://github.com/Nixtla/neuralforecast/blob/main/neuralforecast/models/__init__.py).\n", |
427 | | - "* Add the model to the `core ` class [here](https://github.com/Nixtla/neuralforecast/blob/main/nbs/core.ipynb).\n", |
| 427 | + "* Add the model to the `core` class [here](https://github.com/Nixtla/neuralforecast/blob/main/neuralforecast/core.py).\n", |
428 | 428 | "* Follow the CONTRIBUTING guide to create the PR to upload the model.\n" |
429 | 429 | ] |
430 | 430 | } |
|
0 commit comments