amitlals commited on
Commit
97e7e46
Β·
1 Parent(s): c985520

Add quick start guide for end-users

Browse files
Files changed (1) hide show
  1. QUICK_START.md +95 -0
QUICK_START.md ADDED
@@ -0,0 +1,95 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # πŸš€ SAP Finance Dashboard - Quick Setup Guide
2
+
3
+ ## βœ… Status: Live & Ready!
4
+
5
+ Your SAP Finance Dashboard is **fully deployed** on Hugging Face Spaces at:
6
+ ### πŸ”— https://huggingface.co/spaces/amitgpt/sap-finance-dashboard-RPT-1-OSS
7
+
8
+ ---
9
+
10
+ ## πŸ” One Final Step: Enable Model Features (5 minutes)
11
+
12
+ The dashboard is **fully functional** but needs your HF authentication to use AI prediction features.
13
+
14
+ ### Quick Setup (3 clicks):
15
+
16
+ #### Step 1️⃣: Accept Model Access
17
+ - Go to: https://huggingface.co/SAP/sap-rpt-1-oss
18
+ - Click the blue **"Agree"** button
19
+ - βœ“ Done
20
+
21
+ #### Step 2️⃣: Create Access Token
22
+ - Visit: https://huggingface.co/settings/tokens
23
+ - Click **"New token"**
24
+ - Name: `sap-rpt-oss-access`
25
+ - Type: **"Read"**
26
+ - Click **"Create token"**
27
+ - πŸ“‹ Copy the token (long string starting with `hf_`)
28
+
29
+ #### Step 3️⃣: Add to Your Space
30
+ - Go to your Space: https://huggingface.co/spaces/amitgpt/sap-finance-dashboard-RPT-1-OSS
31
+ - Click **βš™ Settings** (top right)
32
+ - Find **"Repository secrets"**
33
+ - Click **"Add secret"**
34
+ - Name: `HF_TOKEN`
35
+ - Value: Paste your token
36
+ - Click **"Add secret"**
37
+ - Wait 1-2 minutes for rebuild
38
+
39
+ #### ✨ Done!
40
+ When the rebuild finishes, refresh the Space and all features work!
41
+
42
+ ---
43
+
44
+ ## πŸ“š What Each Tab Does
45
+
46
+ | Tab | Function | Status |
47
+ |-----|----------|--------|
48
+ | **Dashboard** | Financial metrics & charts | βœ… Works |
49
+ | **Data Explorer** | Browse datasets | βœ… Works |
50
+ | **Upload** | Upload custom data | βœ… Works |
51
+ | **OData** | Connect to SAP systems | βœ… Works |
52
+ | **Predictions** | AI-powered forecasts | ⏳ Needs HF token |
53
+ | **Playground** | Train & test models | ⏳ Needs HF token |
54
+
55
+ ---
56
+
57
+ ## πŸ› οΈ How the Auth Works
58
+
59
+ 1. You set `HF_TOKEN` in HF Spaces secrets
60
+ 2. Space rebuilds with token available
61
+ 3. Your app automatically logs in to Hugging Face
62
+ 4. Model downloads from gated repository
63
+ 5. Model cached for fast access
64
+
65
+ **Your token is ONLY used to download the model. No data is uploaded.**
66
+
67
+ ---
68
+
69
+ ## ❓ Troubleshooting
70
+
71
+ | Problem | Solution |
72
+ |---------|----------|
73
+ | Still see 401 error | Wait 2+ min for rebuild, refresh browser |
74
+ | "HF_TOKEN not found" | Check secret name is exactly `HF_TOKEN` (case-sensitive) |
75
+ | Model still won't load | Verify you clicked "Agree" on model page |
76
+ | Old app still showing | Hard refresh: Ctrl+Shift+R (or Cmd+Shift+R on Mac) |
77
+
78
+ ---
79
+
80
+ ## πŸ“– Full Documentation
81
+
82
+ For detailed setup, troubleshooting, and security info:
83
+ - See: `HF_AUTHENTICATION_SETUP.md` in the repo
84
+
85
+ ---
86
+
87
+ ## πŸŽ‰ That's It!
88
+
89
+ Your SAP Finance Dashboard is ready. With one authentication token, you'll unlock full AI functionality.
90
+
91
+ **Questions?** Check the troubleshooting section or read `HF_AUTHENTICATION_SETUP.md` for detailed guidance.
92
+
93
+ ---
94
+
95
+ *Powered by Gradio β€’ HuggingFace Spaces β€’ SAP-RPT-1-OSS*