Skip to content

TimesFM (Time Series Foundation Model) is a pretrained time-series foundation model developed by Google Research for time-series forecasting.

Python

Merge branch 'master' of github.com:google-research/timesfm

Justin Gueseeb0f28b3f6d7
diff --cc README.md
index 72d0de8,3d065eb..e59ad5d
--- a/README.md
+++ b/README.md
@@@ -30,27 -30,8 +30,29 @@@ Please look into the README files in th
## Installation
+### Installation as a package
+
+To install the CPU version of TimesFM as a package, you can run the following command without cloning this repo:
+
+`pip install timesfm`
+
+The package is currently using https://pypi.org/project/timesfm/.
+
+### Poetry (CPU) installation
+
+To install the CPU environment using Poetry, you can run the following command:
+
+```
+pip install poetry # optional
+poetry install
+```
+
+This will install the environment in the local .venv folder (depends on the configuration) and matches the python command to the poetry environment. If this is not the case, you can use `poetry run python` to use the local environment.
+
+### Conda / GPU installation
+
+ We recommend at least 16GB RAM to load TimesFM dependencies.
+
For calling TimesFM, We have two environment files. Inside `timesfm`, for
GPU installation (assuming CUDA 12 has been setup), you can create a conda
environment `tfm_env` from the base folder through:
diff --cc pyproject.toml
index 168ddcd,91e1605..0bac628
--- a/pyproject.toml
+++ b/pyproject.toml
@@@ -1,42 -1,27 +1,57 @@@
- [tool.poetry]
- name = "timesfm"
+ # This project can be installed with `python3 -m pip install -e .` from the main directory.
+
+ [project]
+ name = "timesfm-jax"
+packages = [
+ { include = "*", from = "src" },
+]
+version = "0.0.1"
description = "Open weights time-series foundation model from Google Research."
+ version = "1.0.1"
+ dependencies = [
+ "jax==0.4.26",
+ "paxml==1.4.0",
+ "praxis==1.4.0",
+ "jaxlib==0.4.26",
+ "numpy==1.26.4",
+ "pandas==2.1.4",
+ "einshape==1.0.0",
+ "utilsforecast==0.1.10",
+ "huggingface_hub[cli]==0.23.0",
+ "scikit-learn==1.5.1",
+ ]
authors = [
- {name = "Rajat Sen", email = "[email protected]"},
- {name = "Yichen Zhou", email = "[email protected]"},
- {name = "Abhimanyu Das", email = "[email protected]"},
- {name = "Petros Mol", email = "[email protected]"},
+ "Rajat Sen <[email protected]>",
+ "Yichen Zhou <[email protected]>",
+ "Abhimanyu Das <[email protected]>",
+ "Petros Mol <[email protected]>",
+ "Justin Güse <[email protected]>",
+]
+readme = "README.md"
+keywords = ["time series", "timesfm", "forecast", "time series model"]
+homepage = "https://github.com/google-research/timesfm"
+repository = "https://github.com/google-research/timesfm"
+classifiers = [
+ "Environment :: Console",
+ "Framework :: Flake8",
+ "Operating System :: OS Independent",
+ "Topic :: Software Development :: Documentation",
+ "Topic :: Software Development :: Libraries :: Python Modules",
+ "Topic :: Software Development :: Quality Assurance",
]
+include = [
+ "LICENSE",
+]
+
+[tool.poetry.dependencies]
+python = ">=3.10,<3.11"
+einshape = ">=1.0.0"
+numpy = ">=1.26.4"
+pandas = ">=2.1.4"
+paxml = "1.4.0"
+jax = "0.4.26"
+jaxlib = "0.4.26"
+utilsforecast = "^0.1.10"
[build-system]