Skip to content

Commit e2bb7d3

Browse files
yossiovadiaclaude
andcommitted
docs: add HuggingFace token setup instructions to LLM Katan README
Add comprehensive setup section covering HuggingFace token requirements with three authentication methods: - Environment variable (HUGGINGFACE_HUB_TOKEN) - CLI login (huggingface-cli login) - Token file in home directory Explains why token is needed (private models, rate limits, reliable downloads) and provides direct link to HuggingFace token settings. Co-Authored-By: Claude <[email protected]>
1 parent f1dd991 commit e2bb7d3

File tree

1 file changed

+27
-0
lines changed

1 file changed

+27
-0
lines changed

e2e-tests/llm-katan/README.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,33 @@ A lightweight LLM serving package using FastAPI and HuggingFace transformers, de
2020
pip install llm-katan
2121
```
2222

23+
### Setup
24+
25+
#### HuggingFace Token (Required)
26+
27+
LLM Katan uses HuggingFace transformers to download models. You'll need a HuggingFace token for:
28+
- Private models
29+
- Avoiding rate limits
30+
- Reliable model downloads
31+
32+
**Option 1: Environment Variable**
33+
```bash
34+
export HUGGINGFACE_HUB_TOKEN="your_token_here"
35+
```
36+
37+
**Option 2: Login via CLI**
38+
```bash
39+
huggingface-cli login
40+
```
41+
42+
**Option 3: Token file in home directory**
43+
```bash
44+
# Create ~/.cache/huggingface/token file with your token
45+
echo "your_token_here" > ~/.cache/huggingface/token
46+
```
47+
48+
**Get your token:** Visit [https://huggingface.co/settings/tokens](https://huggingface.co/settings/tokens)
49+
2350
### Basic Usage
2451

2552
```bash

0 commit comments

Comments
 (0)