microsoft / microsoft/vasim

Clarify/document the forecasting folder

Open
#9 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation TODO
Dominant language
Python
Stars
12
Forks
11
Avg merge
7d 23h
Merged PRs (30d)
3

Description

We need to provide a lot documentation for the forecasting folder.

The forecast folder is what provides the "future looking" data for the windows to feed into the user-provided algorithm. However, users may want to make changes to the forecasting algorithms in addition to their own autoscaling algorithm.

We need tests, documentation, and examples around this feature.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by inspecting the forecasting folder and any existing tests or examples. Use the current implementation to identify how forecasting supplies future-looking data and where users can change those algorithms. Done means the forecasting folder is documented and supported by the requested tests and examples.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation, testing
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.