umar-sharif821 commited on
Commit
8f9ecaf
·
1 Parent(s): a9f5ced

docs: add Colab script link and explicit OpenEnv compliance section

Browse files
Files changed (1) hide show
  1. README.md +23 -0
README.md CHANGED
@@ -23,6 +23,29 @@ Hackathon-ready OpenEnv project for **edge CDN cache admission and eviction**. I
23
 
24
  **GitHub:** https://github.com/umar-sharif821/cdn-cache-env-improvedone
25
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
26
  ---
27
 
28
  ## Why It Matters
 
23
 
24
  **GitHub:** https://github.com/umar-sharif821/cdn-cache-env-improvedone
25
 
26
+ **Colab training script:** [colab_submission_script.py](./colab_submission_script.py)
27
+ Direct raw URL for Colab download: https://raw.githubusercontent.com/umar-sharif821/cdn-cache-env-improvedone/master/colab_submission_script.py
28
+
29
+ **OpenEnv manifest:** [openenv.yaml](./openenv.yaml)
30
+
31
+ ---
32
+
33
+ ## OpenEnv Compliance
34
+
35
+ This environment is built against the OpenEnv spec:
36
+
37
+ - `openenv.yaml` describes tasks, observation space, action space, reward range, and endpoints.
38
+ - Pydantic models in `env/models.py` define `Observation`, `Action`, `Reward`, `StepResult`, `FileEntry`, and `TaskConfig`.
39
+ - `env/cache.py` implements the standard `reset() / step() / state()` loop.
40
+ - The FastAPI server (`api/main.py`) exposes `/reset`, `/step`, `/state`, `/tasks`, and `/health`.
41
+ - The Colab RL environment uses a `gymnasium.Env` subclass that emits the canonical 5-tuple `(obs, reward, terminated, truncated, info)` with deterministic `reset(seed=...)` and registered metadata including `openenv_version`.
42
+
43
+ To install the OpenEnv core package alongside the training script (outside the HF Space, where Gradio pins FastAPI):
44
+
45
+ ```bash
46
+ pip install openenv-core
47
+ ```
48
+
49
  ---
50
 
51
  ## Why It Matters