You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs: Add HuggingFace authentication instructions - Add step-by-step guide for HuggingFace setup - Include instructions for model access and token creation - Add both CLI and environment variable uth methods
Copy file name to clipboardExpand all lines: agentic_rag/README.md
+21-2Lines changed: 21 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -21,15 +21,34 @@ The system has the following features:
21
21
pip install -r requirements.txt
22
22
```
23
23
24
-
2. (Optional) If you want to use the OpenAI-based agent instead of the default local model, create a `.env` file with your OpenAI API key:
24
+
2. Authenticate with HuggingFace:
25
+
26
+
The system uses Mistral-7B by default, which requires authentication with HuggingFace:
27
+
28
+
a. Create a HuggingFace account at https://huggingface.co/join
29
+
30
+
b. Accept the Mistral-7B model terms at https://huggingface.co/mistralai/Mistral-7B-Instruct-v0.2
31
+
32
+
c. Create an access token at https://huggingface.co/settings/tokens
33
+
34
+
d. Login using the token:
35
+
```bash
36
+
huggingface-cli login
37
+
# Or set the token as an environment variable:
38
+
export HUGGING_FACE_HUB_TOKEN=your_token_here
39
+
# On Windows:
40
+
set HUGGING_FACE_HUB_TOKEN=your_token_here
41
+
```
42
+
43
+
3. (Optional) If you want to use the OpenAI-based agent instead of the default local model, create a `.env` file with your OpenAI API key:
25
44
26
45
```bash
27
46
OPENAI_API_KEY=your-api-key-here
28
47
```
29
48
30
49
If no API key is provided, the system will automatically use the local Mistral-7B model for text generation.
31
50
32
-
3. The system will automatically download and use `Mistral-7B-Instruct-v0.2`for text generation when using the local model. No additional configuration is needed.
51
+
4. The system will automatically download and use `Mistral-7B-Instruct-v0.2`for text generation when using the local model. No additional configuration is needed.
0 commit comments