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

This commit is contained in:
Justin Guese
2024-07-12 22:18:25 +01:00
5 changed files with 231 additions and 25 deletions
+35 -2
View File
@@ -38,7 +38,40 @@ To install the TimesFM as a package, you can run the following command without c
`pip install timesfm`
### Local installation
### Installation using conda
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:
```
conda env create --file=environment.yml
```
For a CPU setup please use,
```
conda env create --file=environment_cpu.yml
```
to create the environment instead.
Follow by
```
conda activate tfm_env
pip install -e .
```
to install the package.
**Note**:
1. Running the provided benchmarks would require additional dependencies.
Please use the environment files under `experiments` instead.
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.
### Local installation using poetry
To from the current repository/local version (like you would have previously done with `pip -e .`), you can run the command
@@ -49,7 +82,7 @@ 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.
## Notes
### Notes
1. Running the provided benchmarks would require additional dependencies.
Please use the environment files under `experiments` instead.