Skip to content

Improve documentation homepage with quick example and clearer feature overview #2176

@vinitjain2005

Description

@vinitjain2005

Description

The documentation homepage in docs/source/index.rst provides a good overview of PyTorch Forecasting, but it could be improved to make onboarding easier for new users.

Currently, the page explains the library but does not include a quick usage example or a clear feature overview. Adding these sections would help users understand the library faster and improve the overall documentation experience.

Proposed Improvements

  1. Add a Quick Example section

    • Include a minimal code snippet showing how to create a dataset and train a model.
  2. Add a Feature Highlights section

    • Clearly summarize key capabilities such as:

      • TimeSeriesDataSet abstraction
      • Built-in neural forecasting models
      • Hyperparameter tuning with Optuna
      • Visualization and interpretation tools.
  3. Minor wording improvements

    • Replace occurrences of timeseries with time series for consistency with standard terminology.
  4. Add a short model overview

    • Mention major models supported by the library (e.g., Temporal Fusion Transformer, NHiTS, NBeats).

Benefits

  • Improves onboarding for new users
  • Makes documentation more informative
  • Aligns the homepage with common documentation standards used in ML libraries

File Location

docs/source/index.rst

I would be happy to work on this improvement and submit a PR if maintainers agree with the proposal.

Please assign these task to me so that i can start conributions. @phoeenniixx

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions