We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
1 parent 3cc28f9 commit 00e8070Copy full SHA for 00e8070
README.md
@@ -17,13 +17,31 @@ Codebook features work by inserting vector quantization bottlenecks called _code
17
18
19
## Installation
20
-Create a virtual environment and then:
+
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
33
```
34
git clone https://github.com/taufeeque9/codebook-features
35
cd codebook-features
36
pip install -e .
37
38
39
+For development mode, we recommend using Poetry:
40
41
42
+poetry install
43
44
45
## Usage
46
47
### Training a codebook model
0 commit comments