freedak/timesfm
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

update pyproject (exclude jax/pax) and update README

Browse Source
This commit is contained in:
Killer3048
2025-04-10 09:47:07 +07:00
parent 373a5293df
commit 6678ba6cee
2 changed files with 12 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+11 -5
View File
@@ -78,18 +78,24 @@ poetry install -E torch
After than you can run the timesfm under `poetry shell` or do `poetry run python3 ...`. After than you can run the timesfm under `poetry shell` or do `poetry run python3 ...`.
**Note**: **Additional Note**:
1. Running the provided benchmarks would require additional dependencies. If you plan to use the **`forecast_with_covariates`** function (which requires external regressors),
Please see the `experiments` section fro more instructions. you need to install **JAX** and **jaxlib**. Installing TimesFM with either the `[pax]` or the `[torch]` extras will include these packages by default.
However, if you installed the base version of TimesFM, you must manually install the dependencies:
```
pip install jax jaxlib
```
2. The dependency `lingvo` does not support ARM architectures, and the code is not working for machines with Apple silicon. We are aware of this issue and are working on a solution. Stay tuned. **Why is this needed?**
The `forecast_with_covariates` method relies on the `xreg_lib` module, which depends on JAX and jaxlib. If these packages are not installed,
calling `forecast_with_covariates` will raise an error. However, due to a lazy import mechanism, `xreg_lib` (and hence JAX/jaxlib) is not needed for standard `forecast` calls.
### Notes ### Notes
1. Running the provided benchmarks would require additional dependencies. Please see the `experiments` folder. 1. Running the provided benchmarks would require additional dependencies. Please see the `experiments` folder.
2. The dependency `lingvo` does not support ARM architectures, and the PAX version is not working for machines with Apple silicon. 2. The dependency `lingvo` does not support ARM architectures, and the code is not working for machines with Apple silicon. We are aware of this issue and are working on a solution. Stay tuned.
### Install from PyPI (and publish) ### Install from PyPI (and publish)
pyproject.toml
+1 -1
View File
@@ -42,7 +42,7 @@ absl-py = ">=1.4.0"
[tool.poetry.extras] [tool.poetry.extras]
pax = ["paxml", "lingvo", "jax", "jaxlib"] pax = ["paxml", "lingvo", "jax", "jaxlib"]
torch = ["torch", "jax", "jaxlib"] # jax & jaxlib are already in pax torch = ["torch"]
[tool.poetry.dependencies.paxml] [tool.poetry.dependencies.paxml]
version = ">=1.4.0" version = ">=1.4.0"