Upload README.md with huggingface_hub

README.md

@@ -1,45 +1,89 @@
 ---
-dataset_info:
-  features:
-  - name: seq
-    dtype: int64
-  - name: world_seed
-    dtype: int64
-  - name: branch
-    dtype: string
-  - name: step
-    dtype: int64
-  - name: channel
-    dtype: string
-  - name: norm_key
-    dtype: string
-  - name: occurrence
-    dtype: int64
-  - name: kind
-    dtype: string
-  - name: dep_fingerprint
-    dtype: string
-  - name: deps
-    list: string
-  - name: vtime
-    dtype: float64
-  - name: provenance
-    dtype: string
-  - name: payload_json
-    dtype: string
-  - name: env_id
-    dtype: string
-  - name: query
-    dtype: string
-  splits:
-  - name: train
-    num_bytes: 459200
-    num_examples: 1783
-  download_size: 109612
-  dataset_size: 459200
+license: apache-2.0
+task_categories:
+- reinforcement-learning
+tags:
+- groundhog
+- record-replay
+- determinism
+- variance-reduction
+- agent-rl
+- verifiers
+size_categories:
+- n<1K
 configs:
 - config_name: default
-  data_files:
-  - split: train
-    path: data/train-*
+  data_files: data/train-*
 ---
+
+# Groundhog world tapes -- `groundhog/research-publish-v1`
+
+Recorded exogenous randomness for a deliberately non-deterministic agent environment.
+Each row is one intercepted interaction with the outside world: a clock reading, an
+entropy draw, a UUID, an HTTP response, a file mtime, or an environment-variable read.
+
+**These tapes replay with no API key, no server and no network.** That is checked before
+publication: the mock world is shut down and every tape is replayed against a closed port.
+
+## Contents
+
+| | |
+|---|---|
+| worlds (distinct `world_seed`) | 8 |
+| events | 1783 |
+| branches per world | 4 |
+| corpus documents | 30 |
+| live API calls spent recording | 155 |
+| live API calls to replay | **0** |
+| groundhog version | 0.1.0 |
+| seeds | 20240202, 20240203, 20240204, 20240205, 20240206, 20240207, 20240208, 20240209 |
+
+## Schema
+
+| column | meaning |
+|---|---|
+| `world_seed` | which world instance; every derived exogenous value is keyed by it |
+| `branch` | `root` for the shared fork-point prefix, `root/bN` for a branch |
+| `step` | position in that branch's history |
+| `channel` | `time`, `random`, `uuid`, `http`, `fs`, `env`, `latency` |
+| `norm_key` | normalised request key, e.g. `GET /search?k=3&q=solar` |
+| `occurrence` | how many times this branch had already asked that key |
+| `kind` | `action_independent` (shareable across branches) or `action_dependent` |
+| `dep_fingerprint` | hash of the resource versions *this branch* mutated; `""` means shareable |
+| `deps` | resources whose state can affect the answer |
+| `provenance` | `live`, `tape`, `derived`, `synth`, `refetch`, `approx`, `mutation` |
+| `payload_json` | the recorded value |
+
+`kind` and `dep_fingerprint` are the interesting columns. An empty fingerprint means no
+action the branch took can have influenced that answer, so every sibling branch may reuse
+it verbatim -- which is where the variance reduction comes from.
+
+## Replay it offline
+
+```python
+from datasets import load_dataset
+from groundhog import WorldTape, Mode
+from envs.research_env import ResearchEnv, make_session
+
+rows = load_dataset("NagaYu/groundhog-world-tapes", split="train")
+rows = rows.filter(lambda r: r["world_seed"] == rows[0]["world_seed"])
+tape = WorldTape.from_records(rows, "<memory>", branches=[{"branch_id": "root"}])
+
+env = ResearchEnv("http://127.0.0.1:9/")          # nothing listens there, on purpose
+s = make_session(Mode.GROUNDHOG, tape.world_seed, env, tape=tape, branch_id="root/b0")
+with s.activate():
+    result = env.rollout(s, "verify", "solar")
+assert s.stats.live_calls == 0                     # no network was touched
+```
+
+## Provenance and terms of service
+
+Recorded from the bundled mock world in `envs/` -- no real third-party service was
+contacted, and no credentials or personal data are present. Recording a real service with
+the same interceptors is possible and is **the user's responsibility**: check that
+provider's terms first, and do not redistribute content you have no right to.
+
+## Citation
+
+Part of the [Groundhog](https://github.com/NagaYu/groundhog) research prototype:
+*share the world, resample the consequences.*