Skip to content

Commit 271ca4d

Browse files
committed
doc: Added optional dependency section to readme
Signed-off-by: Brandon Groth <brandon.m.groth@gmail.com>
1 parent c40b4b2 commit 271ca4d

1 file changed

Lines changed: 20 additions & 0 deletions

File tree

README.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -98,6 +98,26 @@ cd fms-model-optimizer
9898
pip install -e .
9999
```
100100

101+
#### Optional Dependencies
102+
The following optional dependencies are available:
103+
- `fp8`: `llmcompressor` package for fp8 quantization
104+
- `gptq`: `GPTQModel` package for W4A16 quantization
105+
- `mx`: `microxcaling` package for MX quantization
106+
- `opt`: Shortcut for `fp8`, `gptq`, and `mx` installs
107+
- `torchvision`: `torch` package for image recognition training and inference
108+
- `visualize`: Dependencies for visualizing models and performance data
109+
- `test`: Dependencies needed for unit testing
110+
- `dev`: Dependencies needed for development
111+
112+
To install an optional dependency, modify the `pip install` commands above with a list of these names enclosed in brackets. The example below installs `llm-compressor` and `torchvision` with FMS Model Optimizer:
113+
114+
```shell
115+
pip install fms-model-optimizer[fp8,torchvision]
116+
117+
pip install -e .[fp8,torchvision]
118+
```
119+
If you have already installed FMS Model Optimizer, then only the optional packages will be installed.
120+
101121
### Try It Out!
102122

103123
To help you get up and running as quickly as possible with the FMS Model Optimizer framework, check out the following resources which demonstrate how to use the framework with different quantization techniques:

0 commit comments

Comments
 (0)