saurabhsdeshpande commited on
Commit
2dbaf30
Β·
verified Β·
1 Parent(s): e0c298b

docs: restore overwritten README

Browse files
Files changed (1) hide show
  1. README.md +31 -46
README.md CHANGED
@@ -1,5 +1,5 @@
1
  ---
2
- license: cc-by-nc-nd-4.0
3
  tags:
4
  - time series
5
  - forecasting
@@ -15,24 +15,14 @@ library_name: yug
15
 
16
  # Yug
17
 
18
- **Yug** is a 271.8M-parameter time series foundation model developed by
19
- Birla AI Labs for **zero-shot probabilistic forecasting**. A single checkpoint
20
- forecasts a previously unseen series without task-specific training or
21
- per-series tuning: given a historical context and a forecast horizon, it
22
- returns a predictive distribution summarised by quantile levels. It supports
23
- **univariate**, **multivariate**, and **covariate-informed** forecasting
24
- within a single architecture, and decodes a whole block of future points per
25
- forward pass rather than one step at a time.
26
 
27
- <!-- TODO(release): one or two sentences on the architecture family / what it's
28
- inspired by, once that's confirmed for public description (mirrors the
29
- "Inspired by the T5 encoder" line in comparable model cards). -->
30
 
31
  ## Links
32
 
33
- - πŸ’» [GitHub](https://github.com/birla-ai-labs/model-release)
34
- - πŸ““ [Quickstart notebook](https://github.com/birla-ai-labs/model-release/blob/main/notebooks/quickstart.ipynb)
35
- - πŸ› [Issues and questions](https://github.com/birla-ai-labs/model-release/issues)
36
  <!-- TODO(release): add a technical report / paper link here once public. -->
37
 
38
  ## Overview
@@ -40,15 +30,11 @@ forward pass rather than one step at a time.
40
  | Capability | Yug |
41
  |---|---|
42
  | Univariate forecasting | βœ… |
43
- | Cross-learning across items | βœ… |
44
- | Multivariate forecasting | βœ… |
45
  | Covariates | βœ… |
46
  | Probabilistic (quantile) output | βœ… |
47
- | Max context length | 8192 |
48
  | Quantile levels | 0.1, 0.2, 0.3, 0.4, 0.5, 0.6, 0.7, 0.8, 0.9 |
49
 
50
- Quantile levels are fixed at training time: this checkpoint cannot emit a
51
- level it was not trained on.
52
 
53
  ## Model architecture
54
 
@@ -95,31 +81,32 @@ pipeline = YugPipeline.from_pretrained(
95
  "birlaailabs/yug", device_map="cuda"
96
  )
97
 
98
- # Synthetic daily signal: trend + weekly/annual seasonality + noise
99
- HORIZON = 48
100
- rng = np.random.default_rng(0)
101
- t = np.arange(1000)
 
 
 
102
  signal = (
103
- 100.0 # level
104
- + 0.05 * t # trend
105
- + 12.0 * np.sin(2 * np.pi * t / 7) # weekly cycle
106
- + 25.0 * np.sin(2 * np.pi * t / 365) # annual cycle
107
- + rng.normal(0, 3.0, len(t)) # noise
108
  ).astype(np.float32)
109
 
110
- context, truth = signal[:-HORIZON], signal[-HORIZON:]
111
 
112
  forecast = pipeline.predict(
113
  context,
114
  prediction_length=HORIZON,
115
  freq="D", # a model input, not metadata: pandas offset alias
116
- num_samples=100,
117
  seed=0, # makes the call reproducible
118
  )
119
 
120
- print(forecast.median) # (48,) point forecast
121
- print(forecast.quantile(0.9)) # (48,)
122
- print(forecast.interval()) # {"lower": (48,), "upper": (48,)}
123
  print(forecast.to_dataframe().head())
124
  ```
125
 
@@ -168,23 +155,21 @@ If you find Yug useful for your research, please consider citing it:
168
 
169
  ```bibtex
170
  @software{yug_2026,
171
- title = {Yug: a foundation model for probabilistic time-series forecasting},
172
- author = {Aaditya Jain*, Debdeep Sanyal*, Aaryan Nagpal, Dhruv Kumar, Murari Mandal, Saurabh Deshpande},
173
  year = {2026},
174
- url = {https://github.com/birla-ai-labs/model-release},
 
175
  }
176
  ```
177
-
178
  *Equal contribution.
179
 
 
 
 
 
180
  ## License
181
 
182
- Model weights in this repository are licensed under
183
- [CC-BY-NC-ND 4.0](https://creativecommons.org/licenses/by-nc-nd/4.0/) β€”
184
- noncommercial use only, no redistribution of modified/fine-tuned versions,
185
- attribution required. The inference code and model architecture on
186
- [GitHub](https://github.com/birla-ai-labs/model-release) are licensed
187
- separately under
188
- [PolyForm Noncommercial 1.0.0](https://github.com/birla-ai-labs/model-release/blob/main/LICENSE).
189
 
190
- <!-- Internal checkpoint provenance: aaditya_trainings_V19, epoch 1, step 12,000, loss 0.1270 -->
 
1
  ---
2
+ license: cc-by-nc-4.0
3
  tags:
4
  - time series
5
  - forecasting
 
15
 
16
  # Yug
17
 
18
+ **Yug** is a 271.8M-parameter time series foundation model developed by Birla AI Labs for **zero-shot probabilistic forecasting**. A single checkpoint forecasts a previously unseen series without task-specific training or per-series tuning: given a historical context and a forecast horizon, it returns a predictive distribution summarised by quantile levels. It supports **univariate** and **covariate-informed** forecasting within a single architecture.
 
 
 
 
 
 
 
19
 
 
 
 
20
 
21
  ## Links
22
 
23
+ - πŸ’» [GitHub](https://github.com/birla-ai-labs/yug)
24
+ - πŸ““ [Quickstart notebook](https://github.com/birla-ai-labs/yug/blob/main/notebooks/quickstart.ipynb)
25
+ - πŸ› [Issues and questions](https://github.com/birla-ai-labs/yug/issues)
26
  <!-- TODO(release): add a technical report / paper link here once public. -->
27
 
28
  ## Overview
 
30
  | Capability | Yug |
31
  |---|---|
32
  | Univariate forecasting | βœ… |
 
 
33
  | Covariates | βœ… |
34
  | Probabilistic (quantile) output | βœ… |
35
+ | Max context length | 2048 |
36
  | Quantile levels | 0.1, 0.2, 0.3, 0.4, 0.5, 0.6, 0.7, 0.8, 0.9 |
37
 
 
 
38
 
39
  ## Model architecture
40
 
 
81
  "birlaailabs/yug", device_map="cuda"
82
  )
83
 
84
+ # Synthetic signal: trend + 64-step season + 12-step season + noise
85
+ CONTEXT, HORIZON, PERIOD = 2000, 256, 64
86
+ rng = np.random.default_rng([20240902, 315595964, 0])
87
+ t = np.arange(CONTEXT + HORIZON)
88
+ trend = np.linspace(0.0, rng.uniform(50, 150), len(t))
89
+ phase1, amp1 = rng.uniform(0, 6), rng.uniform(10, 30)
90
+ phase2, amp2 = rng.uniform(0, 6), rng.uniform(2, 8)
91
  signal = (
92
+ trend # trend
93
+ + amp1 * np.sin(2 * np.pi * t / PERIOD + phase1) # 64-step season
94
+ + amp2 * np.sin(2 * np.pi * t / 12 + phase2) # 12-step season
95
+ + rng.normal(0, 1.0, len(t)) # noise
 
96
  ).astype(np.float32)
97
 
98
+ context, truth = signal[:CONTEXT], signal[CONTEXT:]
99
 
100
  forecast = pipeline.predict(
101
  context,
102
  prediction_length=HORIZON,
103
  freq="D", # a model input, not metadata: pandas offset alias
 
104
  seed=0, # makes the call reproducible
105
  )
106
 
107
+ print(forecast.median) # (256,) point forecast
108
+ print(forecast.quantile(0.9)) # (256,)
109
+ print(forecast.interval()) # {"lower": (256,), "upper": (256,)}
110
  print(forecast.to_dataframe().head())
111
  ```
112
 
 
155
 
156
  ```bibtex
157
  @software{yug_2026,
158
+ title = {Yug: a foundation model for zero-shot probabilistic time-series forecasting},
159
+ author = {Aaditya Jain* and Debdeep Sanyal* and Aaryan Nagpal and Dhruv Kumar and Murari Mandal and Saurabh Deshpande},
160
  year = {2026},
161
+ organization = {Birla AI Labs},
162
+ url = {https://github.com/birla-ai-labs/yug}
163
  }
164
  ```
 
165
  *Equal contribution.
166
 
167
+ ## Acknowledgements
168
+
169
+ We thank Karthik Sridhar, Deepak Lenka, Akash Kokare, Manya Pandey, and Varya Srivastava, as well as the extended Birla AI Labs team for their support.
170
+
171
  ## License
172
 
173
+ Model weights : [CC-BY-NC 4.0](https://creativecommons.org/licenses/by-nc/4.0/)
 
 
 
 
 
 
174
 
175
+ Code : licensed separately β€” see [GitHub repository](https://github.com/birla-ai-labs/yug) for its license.