Skip to content

Minor bug in documentation: Feature guide/Collect predictions #1696

@ialauper

Description

@ialauper

Prerequisites

Describe the bug
I'm refering to this tutorial: https://neuralprophet.com/how-to-guides/feature-guides/collect_predictions.html

  1. In chapter "Predictions based on forecast start" where you describe the parameter .predict(raw=True) you're saying "step0 is the prediction for this datetime. step1 is the prediction for the next datetime." which is correct. But in the corresponding example below you describe the dataframe with "Note that the last row contains the last possible forecast, forecasting 1961-1-01, 1961-2-01 and 1961-3-01 with data available at 1960-12-01." and this is wrong because step0 is in fact the prediction for ds=1960-12-01.

  2. In Chapter "Predictions sorted based on forecast target" your example table contains columns called "residualx" but this is not the case for everyone who follow the step and just executes the code in this tutorial.

To Reproduce

Steps to reproduce the behavior:
Just run exaclty the the code documented in this chapter and you can reproduce it easily -> it's outputs don't reflect the documentation.

Expected behavior

  1. Step0 is the forecast for 1960-12-01, step1 is the forecast for 1961-1-01 and step2 is the forecast for 1961-2-01
  2. Just a table without the columns called "residual1", "residual2" and so on.

Describe what happens, and how often it happens.

Screenshots

If applicable, add screenshots and console printouts to help explain your problem.

Environment (please complete the following information):

  • Python environment [e.g. Python 3.8, in standalone venv with no other packages]
  • NeuralProphet version and install method [e.g. 2.7, installed from PYPI with pip install neuralprophet]

Additional context

Add any other context about the problem here.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions