yug 0.1.0__tar.gz

yug-0.1.0/.gitignore

@@ -0,0 +1,63 @@
+# --- Model weights and data: these must never enter git history -------------
+# Weights live on the Hugging Face Hub; datasets and results live outside the
+# repo. A single stray checkpoint here bloats every future clone permanently.
+*.safetensors
+*.pt
+*.pth
+*.ckpt
+*.bin
+*.onnx
+*.npy
+*.npz
+*.parquet
+*.arrow
+data/
+datasets/
+checkpoints/
+results/
+results_*/
+outputs/
+wandb/
+lightning_logs/
+
+# --- Python -----------------------------------------------------------------
+__pycache__/
+*.py[cod]
+*$py.class
+*.so
+build/
+dist/
+*.egg-info/
+.eggs/
+.installed.cfg
+pip-wheel-metadata/
+
+# --- Environments -----------------------------------------------------------
+.venv/
+venv/
+env/
+ENV/
+.python-version
+.env
+notebooks/.env
+notebooks/.local_checkpoint/
+
+# --- Tooling caches ---------------------------------------------------------
+.pytest_cache/
+.mypy_cache/
+.ruff_cache/
+.coverage
+.coverage.*
+htmlcov/
+coverage.xml
+.hypothesis/
+
+# --- Notebooks --------------------------------------------------------------
+.ipynb_checkpoints/
+
+# --- Editors and OS ---------------------------------------------------------
+.idea/
+.vscode/
+*.swp
+.DS_Store
+Thumbs.db

yug-0.1.0/CITATION.cff

@@ -0,0 +1,34 @@
+# GitHub reads this file natively and renders a "Cite this repository" button.
+cff-version: 1.2.0
+title: "Yug: a foundation model for zero-shot probabilistic time-series forecasting"
+message: "If you use this software or model, please cite it as below."
+type: software
+# Note - Aaditya Jain and Debdeep Sanyal contributed equally.
+authors:
+  - given-names: "Aaditya"
+    family-names: "Jain"
+    affiliation: "Birla AI Labs"
+  - given-names: "Debdeep"
+    family-names: "Sanyal"
+    affiliation: "Birla AI Labs"
+  - given-names: "Aaryan"
+    family-names: "Nagpal"
+    affiliation: "Birla AI Labs"
+  - given-names: "Dhruv"
+    family-names: "Kumar"
+    affiliation: "Birla AI Labs"
+  - given-names: "Murari"
+    family-names: "Mandal"
+    affiliation: "Birla AI Labs"
+  - given-names: "Saurabh"
+    family-names: "Deshpande"
+    affiliation: "Birla AI Labs"
+repository-code: "https://github.com/birla-ai-labs/yug"
+license: Apache-2.0
+version: 0.1.0
+keywords:
+  - time series
+  - forecasting
+  - foundation model
+  - probabilistic forecasting
+  - transformer

yug-0.1.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or Derivative
+          Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 Birla AI Labs
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

yug-0.1.0/NOTICE

@@ -0,0 +1,15 @@
+Yug
+Copyright 2026 Birla AI Labs
+
+This product includes software developed at Birla AI Labs.
+
+Licensed under the Apache License, Version 2.0 (the "License"); you
+may not use this file except in compliance with the License. You may obtain a
+copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software distributed
+under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
+CONDITIONS OF ANY KIND, either express or implied. See the License for the
+specific language governing permissions and limitations under the License.

yug-0.1.0/PKG-INFO

@@ -0,0 +1,224 @@
+Metadata-Version: 2.5
+Name: yug
+Version: 0.1.0
+Summary: Yug — a foundation model for zero-shot probabilistic time-series forecasting
+Project-URL: Homepage, https://github.com/birla-ai-labs/yug
+Project-URL: Repository, https://github.com/birla-ai-labs/yug
+Project-URL: Issues, https://github.com/birla-ai-labs/yug/issues
+Author: Birla AI Labs
+License-Expression: Apache-2.0
+License-File: LICENSE
+License-File: NOTICE
+Keywords: forecasting,foundation-model,probabilistic-forecasting,pytorch,time-series,transformer
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Requires-Python: >=3.10
+Requires-Dist: huggingface-hub>=0.23
+Requires-Dist: numpy>=1.24
+Requires-Dist: safetensors>=0.4
+Requires-Dist: scipy>=1.10
+Requires-Dist: torch>=2.4
+Provides-Extra: dev
+Requires-Dist: gluonts>=0.14; extra == 'dev'
+Requires-Dist: mypy>=1.10; extra == 'dev'
+Requires-Dist: pandas>=2.0; extra == 'dev'
+Requires-Dist: pytest-cov>=5.0; extra == 'dev'
+Requires-Dist: pytest>=8.0; extra == 'dev'
+Requires-Dist: ruff>=0.6; extra == 'dev'
+Provides-Extra: gluonts
+Requires-Dist: gluonts>=0.14; extra == 'gluonts'
+Requires-Dist: pandas>=2.0; extra == 'gluonts'
+Provides-Extra: pandas
+Requires-Dist: pandas>=2.0; extra == 'pandas'
+Provides-Extra: test
+Requires-Dist: pytest-cov>=5.0; extra == 'test'
+Requires-Dist: pytest>=8.0; extra == 'test'
+Provides-Extra: typecheck
+Requires-Dist: mypy>=1.10; extra == 'typecheck'
+Description-Content-Type: text/markdown
+
+# Yug
+
+Yug is a pretrained 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.
+
+- Model weights: [`birlaailabs/yug`](https://huggingface.co/birlaailabs/yug)
+- Package: `pip install yug`
+- Issues and questions: [GitHub Issues](https://github.com/birla-ai-labs/yug/issues)
+
+
+**Latest version: Yug 0.1.0**
+
+---
+
+## Update — October 2026
+
+First public release of Yug.
+
+**Key highlights:**
+
+- **Zero-shot forecasting.** One pretrained checkpoint forecasts any evenly
+  spaced numeric series, across domains and frequencies, without fitting.
+- **Probabilistic by default.** Every forecast comes back as quantile levels,
+  not a single line, so intervals are available at no extra cost.
+- **Fast direct multi-step decoding.** A patch-based decoder emits a whole block
+  of future points per forward pass; there is no per-step generation loop.
+- **Covariate support.** Optional additional channels alongside the target.
+- **Drop-in benchmarking.** A GluonTS predictor for existing evaluation
+  harnesses.
+
+---
+
+## Available models
+
+| Model | Parameters | Quantile levels | Context length |
+|---|---|---|---|
+| [`birlaailabs/yug`](https://huggingface.co/birlaailabs/yug) | 271.8M | 0.1, 0.2, 0.3, 0.4, 0.5, 0.6, 0.7, 0.8, 0.9 | 2048 |
+
+
+---
+
+## Install
+
+From PyPI:
+
+```bash
+pip install yug
+```
+
+Optional extras:
+
+```bash
+pip install 'yug[pandas]'     # used in the example below
+pip install 'yug[gluonts]'    # GluonTS predictor for benchmark harnesses
+```
+
+Check the machine can run it before downloading weights:
+
+```bash
+yug-check
+```
+
+Weights are cached locally on first use (`~/.cache/huggingface/hub` by
+default, or `HF_HOME` if set).
+
+---
+
+## Code examples
+
+### 1. Forecast one series
+
+```python
+import numpy as np
+from yug import YugPipeline
+
+pipeline = YugPipeline.from_pretrained(
+    "birlaailabs/yug", device_map="cuda"
+)
+
+# Synthetic signal: trend + 64-step season + 12-step season + noise
+CONTEXT, HORIZON, PERIOD = 2000, 256, 64
+rng = np.random.default_rng([20240902, 315595964, 0])
+t = np.arange(CONTEXT + HORIZON)
+trend = np.linspace(0.0, rng.uniform(50, 150), len(t))
+phase1, amp1 = rng.uniform(0, 6), rng.uniform(10, 30)
+phase2, amp2 = rng.uniform(0, 6), rng.uniform(2, 8)
+signal = (
+    trend                                                 # trend
+    + amp1 * np.sin(2 * np.pi * t / PERIOD + phase1)      # 64-step season
+    + amp2 * np.sin(2 * np.pi * t / 12 + phase2)          # 12-step season
+    + rng.normal(0, 1.0, len(t))                          # noise
+).astype(np.float32)
+
+context, truth = signal[:CONTEXT], signal[CONTEXT:]
+
+forecast = pipeline.predict(
+    context,
+    prediction_length=HORIZON,
+    freq="D",            # a model input, not metadata: pandas offset alias
+    seed=0,              # makes the call reproducible
+)
+
+print(forecast.median)                # (256,)     point forecast
+print(forecast.quantile(0.9))         # (256,)
+print(forecast.interval())            # {"lower": (256,), "upper": (256,)}
+print(forecast.to_dataframe().head())
+```
+
+### 2. Several series at once
+
+Lengths and frequencies may differ.
+
+```python
+forecast = pipeline.predict(
+    [series_a, series_b, series_c],
+    prediction_length=48,
+    freq=["D", "D", "H"],
+    item_ids=["a", "b", "c"],
+)
+forecast.values          # (3, n_quantiles, 48)
+```
+
+### 3. With covariates
+
+Stack channels into a 2-D array, target first, and pass it as a single series:
+
+```python
+multivariate = np.stack([target, covariate_1, covariate_2])
+forecast = pipeline.predict([multivariate], prediction_length=48)
+```
+
+
+### 4. In a GluonTS benchmark
+
+```python
+from yug.gluonts_adapter import YugPredictor
+
+predictor = YugPredictor.from_pretrained(
+    "birlaailabs/yug", freq="H", prediction_length=48
+)
+forecasts = list(predictor.predict(dataset))
+```
+
+---
+
+## Examples
+
+- [`notebooks/quickstart.ipynb`](notebooks/quickstart.ipynb) — forecast, plot
+  and score a series end to end. Self-contained; generates its own data.
+- [`notebooks/gift_eval.ipynb`](notebooks/gift_eval.ipynb) — run the GIFT-Eval benchmark to reproduce the published scores.
+
+---
+
+## Citation
+
+```bibtex
+@software{yug_2026,
+  title  = {Yug: a foundation model for zero-shot probabilistic time-series forecasting},
+  author = {Aaditya Jain* and Debdeep Sanyal* and Aaryan Nagpal and Dhruv Kumar and Murari Mandal and Saurabh Deshpande},
+  year   = {2026},
+  organization = {Birla AI Labs},
+  url    = {https://github.com/birla-ai-labs/yug},
+  license = {Apache-2.0}
+}
+```
+
+Note: Aaditya Jain and Debdeep Sanyal contributed equally.
+
+## License
+
+Code in this repository is licensed under the [Apache License 2.0](LICENSE). Model weights on Hugging Face are licensed separately under a noncommercial license, see the [model card](https://huggingface.co/birlaailabs/yug) for terms.
+
+[![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](LICENSE)
+[![Python](https://img.shields.io/badge/python-3.10%20%7C%203.11%20%7C%203.12-blue)](pyproject.toml)
+[![CI](https://github.com/birla-ai-labs/yug/actions/workflows/ci.yaml/badge.svg)](https://github.com/birla-ai-labs/yug/actions/workflows/ci.yaml)