Skip to content

Commit 412be9e

Browse files
docs(cogstack-cohorter): Update README.md to reflect recent changes (#69)
1 parent 23fa670 commit 412be9e

1 file changed

Lines changed: 5 additions & 21 deletions

File tree

cogstack-cohorter/README.md

Lines changed: 5 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -12,13 +12,8 @@ A lightweight cohort discovery application that combines:
1212
---
1313

1414
## Repository structure
15-
16-
- `MedCAT/`
17-
FastAPI service that provides MedCAT-based annotation endpoints.
18-
**Note:** the MedCAT model pack is **not committed** to GitHub. It is mounted at runtime.
19-
2015
- `NL2DSL/`
21-
API service that accepts natural language queries and calls **Ollama** to translate them into a JSON DSL query, optionally using MedCAT context.
16+
API service that accepts natural language queries, calls **Ollama** to translate them into a JSON DSL query, and uses MedCAT to normalize medical terms.
2217

2318
- `WebAPP/`
2419
Full application (frontend + backend) providing the UI and orchestration of the workflow.
@@ -31,16 +26,7 @@ A lightweight cohort discovery application that combines:
3126
- Docker Desktop (or Docker Engine) with Docker Compose
3227
- (Optional) GPU setup if you want Ollama GPU acceleration (depends on your host OS)
3328

34-
### 1) Put your MedCAT model pack locally (do not commit)
35-
Place your model pack zip at:
36-
37-
```
38-
MedCAT/models/medcat_model_pack.zip
39-
```
40-
41-
Make sure `MedCAT/models/` (or at least the `.zip`) is excluded by `.gitignore`.
42-
43-
### 2) Build and start all services
29+
### 1) Build and start all services
4430
From the repo root:
4531

4632
```bash
@@ -53,9 +39,9 @@ Or run in background:
5339
docker compose up --build -d
5440
```
5541

56-
### 3) Access the app
42+
### 2) Access the app
5743
- Web UI: http://localhost:3000
58-
- MedCAT API: http://localhost:3001
44+
- MedCAT API: http://localhost:5000
5945
- NL2DSL API: http://localhost:3002
6046
- Ollama: http://localhost:11434
6147

@@ -68,12 +54,11 @@ docker compose up --build -d
6854
NL2DSL uses:
6955
- `OLLAMA_URL` (default in compose: `http://ollama:11434/api/generate`)
7056
- `OLLAMA_MODEL` (default: `gpt-oss:20b`)
71-
- `MEDCAT_URL` (default: `http://cohorter-medcat:3001`)
57+
- `MEDCAT_URL` (default: `http://cohorter-medcat:5000`)
7258
- `ALLOW_ORIGINS` (default: `*`)
7359

7460
### WebAPP environment variables
7561
WebAPP uses:
76-
- `MEDCAT_URL` (default: `http://cohorter-medcat:3001`)
7762
- `NL2DSL_URL` (default: `http://cohorter-nl2dsl:3002`)
7863

7964
### WebAPP random data generation (optional)
@@ -91,7 +76,6 @@ WEBAPP_RANDOM=true docker compose up --build
9176

9277
You can work on each component independently:
9378

94-
- `MedCAT/` — FastAPI + Uvicorn (Python)
9579
- `NL2DSL/` — API service (see its folder README)
9680
- `WebAPP/` — Node app (server + client)
9781

0 commit comments

Comments
 (0)