PROTHAM commited on
Commit
7e7ad80
Β·
1 Parent(s): 4423d13

Update README with testing instructions and new config

Browse files
Files changed (1) hide show
  1. README.md +16 -1
README.md CHANGED
@@ -262,7 +262,10 @@ api_debug_env/
262
  β”‚ └── registry.py ← TASK_REGISTRY dict
263
  β”œβ”€β”€ graders/
264
  β”‚ └── grader.py ← Deterministic reward logic
265
- └── server/
 
 
 
266
  β”œβ”€β”€ app.py ← FastAPI app with create_app()
267
  β”œβ”€β”€ api_debug_environment.py ← Environment logic
268
  β”œβ”€β”€ mock_api.py ← Internal mock REST API router
@@ -298,6 +301,17 @@ curl -X POST http://localhost:7860/reset \
298
 
299
  ---
300
 
 
 
 
 
 
 
 
 
 
 
 
301
  ## Environment Variables
302
 
303
  | Variable | Required | Description |
@@ -306,6 +320,7 @@ curl -X POST http://localhost:7860/reset \
306
  | `MODEL_NAME` | Yes | Model identifier e.g. `mistralai/Mistral-7B-Instruct-v0.3` |
307
  | `HF_TOKEN` | Yes | HuggingFace token with inference access |
308
  | `ENV_URL` | No | Override environment URL (default: localhost) |
 
309
 
310
  ---
311
 
 
262
  β”‚ └── registry.py ← TASK_REGISTRY dict
263
  β”œβ”€β”€ graders/
264
  β”‚ └── grader.py ← Deterministic reward logic
265
+ β”œβ”€β”€ tests/ ← New! Unit tests for environment & grader
266
+ β”‚ β”œβ”€β”€ __init__.py
267
+ β”‚ └── test_environment.py
268
+ β”œβ”€β”€ server/
269
  β”œβ”€β”€ app.py ← FastAPI app with create_app()
270
  β”œβ”€β”€ api_debug_environment.py ← Environment logic
271
  β”œβ”€β”€ mock_api.py ← Internal mock REST API router
 
301
 
302
  ---
303
 
304
+ ## πŸ§ͺ Testing
305
+
306
+ The environment includes a comprehensive test suite covering the grader, task registry, and episode lifecycle.
307
+
308
+ ```bash
309
+ # Run all tests
310
+ python -m pytest tests/ -v
311
+ ```
312
+
313
+ ---
314
+
315
  ## Environment Variables
316
 
317
  | Variable | Required | Description |
 
320
  | `MODEL_NAME` | Yes | Model identifier e.g. `mistralai/Mistral-7B-Instruct-v0.3` |
321
  | `HF_TOKEN` | Yes | HuggingFace token with inference access |
322
  | `ENV_URL` | No | Override environment URL (default: localhost) |
323
+ | `MOCK_BASE_URL` | No | Internal URL for the Mock API (default: http://localhost:7860) |
324
 
325
  ---
326