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

[DOC] Add documentation changes for time series tasks. #438

Closed
1 task done
ravinkohli opened this issue Jun 17, 2022 · 0 comments
Closed
1 task done

[DOC] Add documentation changes for time series tasks. #438

ravinkohli opened this issue Jun 17, 2022 · 0 comments
Assignees

Comments

@ravinkohli
Copy link
Contributor

  • I'm submitting a ...
    • feature request

Issue Description

Support for time series tasks as introduced in #434, does not include the relevant changes to the documentation. I think before making a new release with time-series tasks, we should also update the documentation for the library. Particularly,

  1. in the README.md here, we should add time-series tasks, here we should update whether baselines are used for time series tasks or only for tabular tasks. We should also add a reproducible example for time-series tasks here.
  2. In the API we should add time series forecasting API as well as the time series forecasting pipeline.
  3. In the manual, we should add information about data preprocessing and the steps in the time-series pipeline. This can be done either by simply appending the text or by making separate pages for both. The same should be done in dev.

Possible Solution

This issue can be resolved either by a single PR or by 2 PRs split between adding time-series forecasting and making the necessary changes for the rest of the documentation.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants