LongK171 commited on
Commit
6577f36
Β·
1 Parent(s): ef9710d

re up reasdme

Browse files
Files changed (1) hide show
  1. README.md +9 -21
README.md CHANGED
@@ -1,27 +1,15 @@
1
- # HF_Space_API (FastAPI + Docker)
2
 
3
- This Space exposes a **REST API** for document processing (summarize, embed, search, process PDFs).
4
- It is designed to **wrap your existing project** with minimal changes.
5
 
6
- ## How to use
7
 
8
- 1. Create a new **Hugging Face Space** β†’ **Docker** template.
9
- 2. Push this folder to that Space (or upload as a ZIP and use the Space UI).
10
- 3. Set Space **Hardware** (e.g., T4 or A10G for GPU) and add **Space secrets** if needed:
11
- - `HF_TOKEN` (optional, for private models)
12
- - `API_SECRET` (optional, simple bearer auth)
13
 
14
- 4. Wire your own modules inside `app.py` (see TODO markers).
15
 
16
- ## Endpoints
17
 
18
- - `GET /health`
19
- - `POST /embed` β€” JSON: `{ "texts": ["..."] }`
20
- - `POST /summarize` β€” JSON: `{ "text": "..." }`
21
- - `POST /search` β€” JSON: `{ "query": "...", "k": 5 }` (dummy store until you wire your FAISS index)
22
- - `POST /process_pdf` β€” multipart/form-data: `[email protected]`
23
-
24
- ## Notes
25
-
26
- - Default uses `faiss-cpu`. On GPU Space you may switch to `faiss-gpu` in `requirements.txt`.
27
- - Avoid committing local cached models into git. Publish models to the Hub and **download at startup**.
 
 
1
 
2
+ ---
3
+ title: Doc Ai Api
4
 
5
+ emoji: πŸ“Š
6
 
7
+ colorFrom: yellow
 
 
 
 
8
 
9
+ colorTo: red
10
 
11
+ sdk: docker
12
 
13
+ pinned: false
14
+ ---
15
+ Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference