GabrielSalem commited on
Commit
eef260a
Β·
verified Β·
1 Parent(s): daa0e59

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +40 -4
README.md CHANGED
@@ -1,14 +1,50 @@
1
  ---
2
  title: PublicAlpha
3
- emoji: πŸ¦€
4
  colorFrom: green
5
- colorTo: purple
6
  sdk: gradio
7
  sdk_version: 6.0.1
8
  app_file: app.py
9
- pinned: false
10
  license: mit
11
  short_description: Public Alpha AI -- best stocks for today -- ;) Best stock
 
 
12
  ---
13
 
14
- Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
  ---
2
  title: PublicAlpha
3
+ emoji: πŸ“ˆ
4
  colorFrom: green
5
+ colorTo: gray
6
  sdk: gradio
7
  sdk_version: 6.0.1
8
  app_file: app.py
9
+ pinned: true
10
  license: mit
11
  short_description: Public Alpha AI -- best stocks for today -- ;) Best stock
12
+ thumbnail: >-
13
+ https://cdn-uploads.huggingface.co/production/uploads/6702e08900dc08cbf236e76e/l4rVeXUEYvLgYZfciN7kd.png
14
  ---
15
 
16
+ ## Live demo
17
+ This repo is designed for Hugging Face Spaces (Gradio). For a live demo, deploy this repo as a Gradio Space and set the required secrets (see below).
18
+
19
+ ---
20
+
21
+ ## Repo contents
22
+ - `app.py` β€” single-file Gradio app (UI + pipeline).
23
+ - `requirements.txt` β€” pinned dependencies.
24
+ - `README.md` β€” (this file).
25
+ - `assets/` β€” place your logo, cover, demo GIF, screenshots here.
26
+ - `example_prompts.txt` β€” suggested prompts.
27
+
28
+ ---
29
+
30
+ ## Quickstart (local)
31
+ ```bash
32
+ # 1. Create virtualenv
33
+ python -m venv venv
34
+ source venv/bin/activate # Windows: venv\Scripts\activate
35
+
36
+ # 2. Install deps
37
+ pip install -r requirements.txt
38
+
39
+ # 3. Set secrets (example)
40
+ export OPENAI_API_KEY="sk-xxx"
41
+ export OPENAI_BASE_URL="https://openrouter.ai/api/v1" # optional
42
+ export SCRAPER_API_URL="https://your-scraper.example/api" # optional override
43
+
44
+ # 4. Run
45
+ python app.py
46
+ # Open http://127.0.0.1:7860
47
+
48
+ ---
49
+
50
+ Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference