Skip to content
This repository has been archived by the owner on Jan 27, 2025. It is now read-only.

Commit

Permalink
Updated README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
GuillaumeRochette committed Dec 19, 2023
1 parent fd4ad6a commit e13601e
Showing 1 changed file with 22 additions and 4 deletions.
26 changes: 22 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,11 +23,11 @@ We recommend using the Docker image for compatibility.
4. Run the latest image:
```bash
docker run \
--user $(id -u):$(id -g)
--user $(id -u):$(id -g) \
--gpus all \
--volume /path/to/data:/path/to/data
--interactive
--tty
--mount type=bind,source=/path/to/data,target=/path/to/data \
--interactive \
--tty \
guillaumerochette/psifx:latest
```
5. Check out and run `psifx` available commands!
Expand Down Expand Up @@ -73,3 +73,21 @@ We recommend using the Docker image for compatibility.
```

## Usage

## Development

### Variables

```bash
export VERSION="0.0.1"
export HF_TOKEN="write-your-hf-token-here"
```

### Build

```bash
docker buildx build \
--build-arg VERSION=$VERSION \
--build-arg HF_TOKEN=$HF_TOKEN \
--tag "psifx:$VERSION" .
```

0 comments on commit e13601e

Please sign in to comment.