arahrooh commited on
Commit
3ca9195
·
1 Parent(s): 8531ebf

Update README with HF_TOKEN setup instructions

Browse files
Files changed (1) hide show
  1. README.md +29 -0
README.md CHANGED
@@ -47,6 +47,35 @@ A Retrieval-Augmented Generation (RAG) chatbot for genetic counseling and cascad
47
  - MediPhi
48
  - Phi-4-reasoning
49
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
50
  ## Important Notes
51
 
52
  ⚠️ **This chatbot provides informational answers based on medical literature. It is not a substitute for professional medical advice, diagnosis, or treatment. Always consult with qualified healthcare providers for medical decisions.**
 
47
  - MediPhi
48
  - Phi-4-reasoning
49
 
50
+ ## Setup Instructions
51
+
52
+ ### Required: Add HF_TOKEN Secret
53
+
54
+ This Space uses the Hugging Face Inference API to generate answers. You **must** add your Hugging Face token as a secret:
55
+
56
+ 1. **Get your Hugging Face token:**
57
+ - Go to: https://huggingface.co/settings/tokens
58
+ - Create a new token with "Read" permissions
59
+ - Copy the token
60
+
61
+ 2. **Add token to Space:**
62
+ - Go to your Space settings: https://huggingface.co/spaces/alrahrooh/cgt-llm-chatbot-v2/settings
63
+ - Click on "Variables and secrets" tab
64
+ - Add a new secret:
65
+ - **Name:** `HF_TOKEN`
66
+ - **Value:** Your Hugging Face token
67
+ - Click "Add secret"
68
+ - Restart the Space (it will restart automatically)
69
+
70
+ 3. **Verify it's working:**
71
+ - Check the Space logs - you should see "Using Hugging Face Inference API"
72
+ - Try asking a question in the interface
73
+
74
+ **Note:** Some models (like Llama) are gated and require you to:
75
+ - Request access at the model's page on Hugging Face
76
+ - Accept the model's license
77
+ - Use a token that has access to the model
78
+
79
  ## Important Notes
80
 
81
  ⚠️ **This chatbot provides informational answers based on medical literature. It is not a substitute for professional medical advice, diagnosis, or treatment. Always consult with qualified healthcare providers for medical decisions.**