-
Notifications
You must be signed in to change notification settings - Fork 190
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #42 from IBM/ajati-patch-1
Update README.md
- Loading branch information
Showing
1 changed file
with
7 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,4 @@ | ||
# tsfm | ||
# TSFM: Time Series Foundation Models | ||
Public notebooks and utilities for working with Time Series Foundation Models (TSFM) | ||
|
||
The core TSFM time series models have been made available on Hugging Face -- details can be found | ||
|
@@ -15,7 +15,7 @@ git clone [email protected]:IBM/tsfm.git | |
cd tsfm | ||
``` | ||
|
||
## Notebooks Installation | ||
## 📕 Notebooks Installation | ||
Several notebooks are provided in the `notebooks` folder. They allow you to perform pre-training and finetuning on the models. | ||
To install use `pip`: | ||
|
||
|
@@ -29,8 +29,11 @@ pip install ".[notebooks]" | |
- Transfer learning with `PatchTST` [[Try it out]](https://github.com/IBM/tsfm/blob/main/notebooks/hfdemo/patch_tst_transfer.ipynb) | ||
- Getting started with `TinyTimeMixer (TTM)` [Try it out](notebooks/hfdemo/ttm_getting_started.ipynb) | ||
|
||
## 📗 Google Colab | ||
Run the TTM tutorial in Google Colab, and quickly build a forecasting application with pre-trained TSFM models. | ||
- [TTM Colab Tutorial](https://colab.research.google.com/github/IBM/tsfm/blob/tutorial/notebooks/tutorial/ttm_tutorial.ipynb) | ||
|
||
## Demos Installation | ||
## 💻 Demos Installation | ||
The demo presented at NeurIPS 2023 is available in `tsfmhfdemos`. This demo requires you to have pre-trained and finetuned models in place (we plan to release these at later date). To install the requirements use `pip`: | ||
|
||
```bash | ||
|
@@ -48,4 +51,4 @@ Before opening a new issue, please search for similar issues. It's possible that | |
The intention of this repository is to make it easier to use and demonstrate IBM Research TSFM components that have been made available in the [Hugging Face transformers library](https://huggingface.co/docs/transformers/main/en/index). As we continute to develop these capabilities we will update the code here. | ||
|
||
|
||
IBM Public Repository Disclosure: All content in this repository including code has been provided by IBM under the associated open source software license and IBM is under no obligation to provide enhancements, updates, or support. IBM developers produced this code as an open source project (not as an IBM product), and IBM makes no assertions as to the level of quality nor security, and will not be maintaining this code going forward. | ||
IBM Public Repository Disclosure: All content in this repository including code has been provided by IBM under the associated open source software license and IBM is under no obligation to provide enhancements, updates, or support. IBM developers produced this code as an open source project (not as an IBM product), and IBM makes no assertions as to the level of quality nor security, and will not be maintaining this code going forward. |