Skip to content

Commit a8b6a1c

Browse files
committed
some notes to README
1 parent 6ad2161 commit a8b6a1c

File tree

1 file changed

+12
-4
lines changed

1 file changed

+12
-4
lines changed

README.md

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,21 +5,29 @@ for deep learning applications.
55

66
> ⚠️ **BREAKING CHANGE (v0.3.0+)**: The output matrix dimensionality has changed from `(n_tracks, batch_size, sequence_length)` to `(batch_size, sequence_length, n_tracks)`. This change was long overdue and eliminates the need for (potentially memory expensive) transpose operations downstream. If you're upgrading from an earlier version, please update your code accordingly (probaby you need to delete one transpose in your code).
77
8+
> **NEW FEATURE (v0.3.0+)**: Full `bfloat16` support! You can now specify `dtype="bfloat16"` to get output tensors in bfloat16 format, reducing memory usage by 50%.
9+
810

911

1012

1113
## Quickstart
1214

1315
### Installation with Pixi
14-
16+
Using [pixi](https://pixi.sh/) to install bigwig-loader is highly recommended.
1517
Please take a look at the pixi.toml file. If you just want to use bigwig-loader, just
1618
copy that pixi.toml, add the other libraries you need and use the "prod" environment
1719
(you don't need to clone this repo, pixi will download bigwig-loader from the
1820
conda "dataloading" channel):
1921

20-
```shell
21-
pixi run -e prod <my_training_command>
22-
```
22+
* Install pixi, if not installed:
23+
```shell
24+
curl -fsSL https://pixi.sh/install.sh | sh
25+
```
26+
27+
* change directory to wherever you put the pixi.toml, and:
28+
```shell
29+
pixi run -e prod <my_training_command>
30+
```
2331

2432

2533
### Installation with conda/mamba

0 commit comments

Comments
 (0)