Adi362 commited on
Commit
3a2bd87
·
verified ·
1 Parent(s): b6aa2c9

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +64 -57
README.md CHANGED
@@ -1,57 +1,64 @@
1
- # Backend
2
-
3
- FastAPI backend service for CortexFlow.
4
-
5
- Joint collaboration repository by the MA2TIC group.
6
-
7
- Private codebase. Licensing context is defined in [../LICENSE](../LICENSE).
8
-
9
- ## Design Profile
10
-
11
- - Deterministic feature extraction from transcript and pause signals
12
- - Confidence and quality notes for low-evidence samples
13
- - Non-diagnostic safety framing in generated output
14
- - Groq model usage limited to narrative/safety language, not synthetic metric creation
15
-
16
- ## API Endpoints
17
-
18
- - `GET /health`
19
- - `GET /models/recommended`
20
- - `POST /analyze`
21
-
22
- `POST /analyze` payload shape:
23
-
24
- ```json
25
- {
26
- "input_value": "optional text input",
27
- "transcript": "optional transcript input",
28
- "pause_map": [0.32, 0.45],
29
- "audio_duration": 24.8,
30
- "session_id": "optional"
31
- }
32
- ```
33
-
34
- Response format: streamed NDJSON with step and final events.
35
-
36
- ## Hugging Face Spaces (Docker)
37
-
38
- Hosting target: Docker Space.
39
-
40
- Deployment profile:
41
-
42
- - Repository root in Space contains backend files (`main.py`, `requirements.txt`, `Dockerfile`, supporting modules)
43
- - Required secret: `GROQ_API_KEY`
44
- - Container runtime binds to `${PORT}` (default fallback configured in Dockerfile)
45
- - Health probe endpoint: `GET /health`
46
-
47
- ## Local Development Reference
48
-
49
- ```bash
50
- cd backend
51
- python -m venv .venv
52
- . .venv/Scripts/Activate.ps1
53
- pip install -r requirements.txt
54
- copy .env.example .env
55
- uvicorn main:app --reload --port 8000
56
- ```
57
-
 
 
 
 
 
 
 
 
1
+ title: CortexFlow Backend
2
+ emoji: 🧠
3
+ colorFrom: blue
4
+ colorTo: indigo
5
+ sdk: docker
6
+ app_port: 7860
7
+ pinned: false
8
+ # Backend
9
+
10
+ FastAPI backend service for CortexFlow.
11
+
12
+ Joint collaboration repository by the MA2TIC group.
13
+
14
+ Private codebase. Licensing context is defined in [../LICENSE](../LICENSE).
15
+
16
+ ## Design Profile
17
+
18
+ - Deterministic feature extraction from transcript and pause signals
19
+ - Confidence and quality notes for low-evidence samples
20
+ - Non-diagnostic safety framing in generated output
21
+ - Groq model usage limited to narrative/safety language, not synthetic metric creation
22
+
23
+ ## API Endpoints
24
+
25
+ - `GET /health`
26
+ - `GET /models/recommended`
27
+ - `POST /analyze`
28
+
29
+ `POST /analyze` payload shape:
30
+
31
+ ```json
32
+ {
33
+ "input_value": "optional text input",
34
+ "transcript": "optional transcript input",
35
+ "pause_map": [0.32, 0.45],
36
+ "audio_duration": 24.8,
37
+ "session_id": "optional"
38
+ }
39
+ ```
40
+
41
+ Response format: streamed NDJSON with step and final events.
42
+
43
+ ## Hugging Face Spaces (Docker)
44
+
45
+ Hosting target: Docker Space.
46
+
47
+ Deployment profile:
48
+
49
+ - Repository root in Space contains backend files (`main.py`, `requirements.txt`, `Dockerfile`, supporting modules)
50
+ - Required secret: `GROQ_API_KEY`
51
+ - Container runtime binds to `${PORT}` (default fallback configured in Dockerfile)
52
+ - Health probe endpoint: `GET /health`
53
+
54
+ ## Local Development Reference
55
+
56
+ ```bash
57
+ cd backend
58
+ python -m venv .venv
59
+ . .venv/Scripts/Activate.ps1
60
+ pip install -r requirements.txt
61
+ copy .env.example .env
62
+ uvicorn main:app --reload --port 8000
63
+ ```
64
+