milwright commited on
Commit
7890ff4
·
verified ·
1 Parent(s): 1117ec5

Delete README.md

Browse files
Files changed (1) hide show
  1. README.md +0 -76
README.md DELETED
@@ -1,76 +0,0 @@
1
- ---
2
- title: My Custom Space
3
- emoji: 🤖
4
- colorFrom: blue
5
- colorTo: red
6
- sdk: gradio
7
- sdk_version: 5.35.0
8
- app_file: app.py
9
- pinned: false
10
- ---
11
-
12
- # My Custom Space
13
-
14
- An AI research assistant tailored for academic inquiry and scholarly dialogue
15
-
16
- ## Quick Deploy to HuggingFace Spaces
17
-
18
- ### Step 1: Create the Space
19
- 1. Go to https://huggingface.co/spaces
20
- 2. Click "Create new Space"
21
- 3. Choose a name for your Space
22
- 4. Select **Gradio** as the SDK
23
- 5. Set visibility (Public/Private)
24
- 6. Click "Create Space"
25
-
26
- ### Step 2: Upload Files
27
- 1. In your new Space, click "Files" tab
28
- 2. Upload these files from the zip:
29
- - `app.py`
30
- - `requirements.txt`
31
- 3. Wait for "Building" to complete
32
-
33
- ### Step 3: Add API Key
34
- 1. Go to Settings (gear icon)
35
- 2. Click "Variables and secrets"
36
- 3. Click "New secret"
37
- 4. Name: `OPENROUTER_API_KEY`
38
- 5. Value: Your OpenRouter API key
39
- 6. Click "Add"
40
-
41
- ### Step 4: Configure Access Control
42
- Your Space is configured with access code protection. Students will need to enter the access code to use the chatbot.
43
-
44
- 1. Go to Settings (gear icon)
45
- 2. Click "Variables and secrets"
46
- 3. Click "New secret"
47
- 4. Name: `SPACE_ACCESS_CODE`
48
- 5. Value: `TLC`
49
- 6. Click "Add"
50
-
51
- **Important**: The access code is now stored securely as an environment variable and is not visible in your app code.
52
-
53
- To disable access protection:
54
- 1. Go to Settings → Variables and secrets
55
- 2. Delete the `SPACE_ACCESS_CODE` secret
56
- 3. The Space will rebuild automatically with no access protection
57
-
58
-
59
-
60
- ### Step 5: Get Your API Key
61
- 1. Go to https://openrouter.ai/keys
62
- 2. Sign up/login if needed
63
- 3. Click "Create Key"
64
- 4. Copy the key (starts with `sk-or-`)
65
-
66
- ### Step 6: Test Your Space
67
- - Go back to "App" tab
68
- - Your Space should be running!
69
- - Try the example prompts or ask a question
70
-
71
- ## Configuration
72
-
73
- - **Model**: google/gemma-3-27b-it
74
- - **Temperature**: 0.7
75
- - **Max Tokens**: 500
76
- - **API Key Variable**: OPENROUTER_API_KEY