Skip to content

Commit 00e8070

Browse files
authored
Update README.md
1 parent 3cc28f9 commit 00e8070

File tree

1 file changed

+19
-1
lines changed

1 file changed

+19
-1
lines changed

README.md

+19-1
Original file line numberDiff line numberDiff line change
@@ -17,13 +17,31 @@ Codebook features work by inserting vector quantization bottlenecks called _code
1717

1818

1919
## Installation
20-
Create a virtual environment and then:
20+
21+
### PyPI
22+
23+
Install from PyPI to directly use the library:
24+
25+
```
26+
pip install codebook-features
27+
```
28+
29+
### Source Code
30+
31+
Install from source code if you plan to modify part of the code or contribute to the library:
32+
2133
```
2234
git clone https://github.com/taufeeque9/codebook-features
2335
cd codebook-features
2436
pip install -e .
2537
```
2638

39+
For development mode, we recommend using Poetry:
40+
41+
```
42+
poetry install
43+
```
44+
2745
## Usage
2846

2947
### Training a codebook model

0 commit comments

Comments
 (0)