Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

updating readme with minor changes to installation instructions #161

Merged
merged 1 commit into from
Oct 17, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 9 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ pyenv versions # to list the versions available (lets assume the versions are 3.
pyenv local 3.10.15
poetry env use 3.10.15
poetry lock
poetry install --only pax
poetry install -E pax
```

After than you can run the timesfm under `poetry shell` or do `poetry run python3 ...`.
Expand All @@ -66,7 +66,7 @@ After than you can run the timesfm under `poetry shell` or do `poetry run python
pyenv local 3.11.10
poetry env use 3.11.10
poetry lock
poetry install --only torch
poetry install -E torch
```

After than you can run the timesfm under `poetry shell` or do `poetry run python3 ...`.
Expand All @@ -86,7 +86,13 @@ Please see the `experiments` section fro more instructions.

### Install from PyPI (and publish)

Instructions coming soon.
On python 3.11 you can install the torch version using:

```pip install timesfm[torch]```

On python 3.10 you can install the pax version using:

```pip install timesfm[pax]```


## Usage
Expand Down
Loading