|
|
--- |
|
|
title: My Custom Space |
|
|
emoji: 🤖 |
|
|
colorFrom: blue |
|
|
colorTo: red |
|
|
sdk: gradio |
|
|
sdk_version: 4.44.1 |
|
|
app_file: app.py |
|
|
pinned: false |
|
|
--- |
|
|
|
|
|
# My Custom Space |
|
|
|
|
|
An AI research assistant tailored for academic inquiry and scholarly dialogue |
|
|
|
|
|
## Quick Deploy to HuggingFace Spaces |
|
|
|
|
|
### Step 1: Create the Space |
|
|
1. Go to https://huggingface.co/spaces |
|
|
2. Click "Create new Space" |
|
|
3. Choose a name for your Space |
|
|
4. Select **Gradio** as the SDK |
|
|
5. Set visibility (Public/Private) |
|
|
6. Click "Create Space" |
|
|
|
|
|
### Step 2: Upload Files |
|
|
1. In your new Space, click "Files" tab |
|
|
2. Upload these files from the zip: |
|
|
- `app.py` |
|
|
- `requirements.txt` |
|
|
3. Wait for "Building" to complete |
|
|
|
|
|
### Step 3: Add API Key |
|
|
1. Go to Settings (gear icon) |
|
|
2. Click "Variables and secrets" |
|
|
3. Click "New secret" |
|
|
4. Name: `OPENROUTER_API_KEY` |
|
|
5. Value: Your OpenRouter API key |
|
|
6. Click "Add" |
|
|
|
|
|
### Step 4: Configure Access Control (Optional) |
|
|
Your Space is configured with access code protection. Students will need to enter the access code to use the chatbot. |
|
|
|
|
|
**Access Code**: `TLC` |
|
|
|
|
|
To disable access protection: |
|
|
1. Edit `app.py` in your Space |
|
|
2. Change `ACCESS_CODE = "TLC"` to `ACCESS_CODE = ""` |
|
|
3. The Space will rebuild automatically |
|
|
|
|
|
|
|
|
|
|
|
### Step 5: Get Your API Key |
|
|
1. Go to https://openrouter.ai/keys |
|
|
2. Sign up/login if needed |
|
|
3. Click "Create Key" |
|
|
4. Copy the key (starts with `sk-or-`) |
|
|
|
|
|
### Step 6: Test Your Space |
|
|
- Go back to "App" tab |
|
|
- Your Space should be running! |
|
|
- Try the example prompts or ask a question |
|
|
|
|
|
## Configuration |
|
|
|
|
|
- **Model**: google/gemma-3-27b-it |
|
|
- **Temperature**: 0.7 |
|
|
- **Max Tokens**: 500 |
|
|
- **API Key Variable**: OPENROUTER_API_KEY |
