Musharraf commited on
Commit
ea2aebe
Β·
1 Parent(s): bc262f3

Update README to reflect new flat project structure

Browse files
Files changed (1) hide show
  1. README.md +15 -14
README.md CHANGED
@@ -106,7 +106,7 @@ docker run -p 7860:7860 invoice-extraction-env
106
  ### Run locally
107
  ```bash
108
  pip install -r requirements.txt
109
- uvicorn invoice_extraction_env.server.app:app --host 0.0.0.0 --port 7860
110
  ```
111
 
112
  ### Run inference
@@ -132,18 +132,19 @@ python inference.py
132
 
133
  ## Project Structure
134
  ```
135
- β”œβ”€β”€ invoice_extraction_env/
136
  β”‚ β”œβ”€β”€ __init__.py
137
- β”‚ β”œβ”€β”€ models.py # Pydantic Action/Observation types
138
- β”‚ └── server/
139
- β”‚ β”œβ”€β”€ __init__.py
140
- β”‚ β”œβ”€β”€ app.py # FastAPI application
141
- β”‚ β”œβ”€β”€ environment.py # Core environment logic
142
- β”‚ β”œβ”€β”€ documents.py # Document corpus
143
- β”‚ └── graders.py # Scoring/grading logic
144
- β”œβ”€β”€ inference.py # Baseline inference script
145
- β”œβ”€β”€ openenv.yaml # OpenEnv manifest
146
- β”œβ”€β”€ pyproject.toml # Package configuration
147
- β”œβ”€β”€ Dockerfile # Container definition
148
- └── README.md # This file
 
149
  ```
 
106
  ### Run locally
107
  ```bash
108
  pip install -r requirements.txt
109
+ uvicorn server.app:app --host 0.0.0.0 --port 7860
110
  ```
111
 
112
  ### Run inference
 
132
 
133
  ## Project Structure
134
  ```
135
+ β”œβ”€β”€ server/
136
  β”‚ β”œβ”€β”€ __init__.py
137
+ β”‚ β”œβ”€β”€ app.py # FastAPI application
138
+ β”‚ β”œβ”€β”€ environment.py # Core environment logic
139
+ β”‚ β”œβ”€β”€ documents.py # Document corpus
140
+ β”‚ β”œβ”€β”€ graders.py # Scoring/grading logic
141
+ β”‚ └── models.py # Pydantic Action/Observation types
142
+ β”œβ”€β”€ __init__.py # Package declaration
143
+ β”œβ”€β”€ inference.py # Baseline inference script
144
+ β”œβ”€β”€ openenv.yaml # OpenEnv manifest
145
+ β”œβ”€β”€ pyproject.toml # Package configuration
146
+ β”œβ”€β”€ requirements.txt # Dependencies
147
+ β”œβ”€β”€ uv.lock # Dependency lock file
148
+ β”œβ”€β”€ Dockerfile # Container definition
149
+ └── README.md # This file
150
  ```