Skip to content

[ENH] Improve Documentation for pytorch-forecasting (both v1 and v2) #2277

@phoeenniixx

Description

@phoeenniixx

Is your feature request related to a problem? Please describe.
Currently the pytorch-forecasting documentation is cluttered and have no clear distinction between v1 and v2 APIs. Also, we still dont have references of new models that have been added, and the UX is also not good

Describe the solution you'd like
Improve the documentation-

for v1

for v2

  • Add some references for v2 to readme as well
  • Create a new header for v2 API
  • make the models table automated and add new models which are not present.
  • Add separate tutorials for v2 - should be easily distinguishable from v1
  • Add API references
  • Extension Templates
  • separate v2 models and datamodules from v1
  • Clearly mention that metrics are still the same as v1

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentationenhancementNew feature or request

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions