Skip to content

Commit 84fbd3a

Browse files
authored
Merge pull request #11 from GoogleCloudPlatform/feature/update-readme-pypi
Update Quick Start in README to include PyPI installation
2 parents 61eff45 + 9b68b22 commit 84fbd3a

1 file changed

Lines changed: 10 additions & 3 deletions

File tree

README.md

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,14 +23,21 @@ AMS requires a GPU for standard operation. Scan times of 10–40 seconds quoted
2323
2424
## Quick Start
2525

26+
You can install the AMS Scanner directly from PyPI, or clone the repository to install it from source:
27+
2628
```bash
27-
# Clone the repository
29+
# Install from PyPI with CLI tools
30+
pip install "ams-scanner[cli]"
31+
32+
# Or clone and install from source
2833
git clone https://github.com/GoogleCloudPlatform/activation-model-scanner.git
2934
cd activation-model-scanner
30-
31-
# Install locally
3235
pip install -e ".[cli]"
36+
```
37+
38+
### Usage Examples
3339

40+
```bash
3441
# Scan an ungated model (no authentication required)
3542
ams scan google/gemma-2-2b-it
3643

0 commit comments

Comments
 (0)