From c159f1bf3955217cddcba796dce8e002c5cb477e Mon Sep 17 00:00:00 2001 From: siriuz42 Date: Fri, 3 Oct 2025 16:56:53 -0700 Subject: [PATCH] setup pyproject.toml to add optional dependencies --- README.md | 21 ++++++++++++++++++--- 1 file changed, 18 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 546c5bd..29edce2 100644 --- a/README.md +++ b/README.md @@ -44,14 +44,29 @@ will be under construction over the next few weeks to ### Install -TODO(siriuz42): Package timesfm==2.0.0 and upload to PyPI . +**Step 1** (Prerequisite) -Run +Install your preferred `torch` / `jax` backend based on your OS and accelerators +(CPU, GPU, TPU or Apple Silicon). + +- [Install PyTorch](https://pytorch.org/get-started/locally/). +- [Install Jax](https://docs.jax.dev/en/latest/installation.html#installation) + for Flax. + +**Step 2** (Install `timesfm`) + +You can now install locally. ```shell git clone https://github.com/google-research/timesfm.git cd timesfm -pip install -e . +pip install -e ".[torch]" +``` + +```shell +git clone https://github.com/google-research/timesfm.git +cd timesfm +pip install -e ".[flax]" ``` ### Code Example