risenyard commited on
Commit
752bb5c
路
verified 路
1 Parent(s): a6169e7

Simplify the standalone encoder card

Browse files
Files changed (1) hide show
  1. README.md +50 -45
README.md CHANGED
@@ -1,5 +1,7 @@
1
  ---
2
  license: cc-by-4.0
 
 
3
  tags:
4
  - remote-sensing
5
  - insar
@@ -8,30 +10,42 @@ tags:
8
  - egms
9
  ---
10
 
11
- # EGMS Encoder 4.3 for EGMS-QA
12
 
13
- Frozen EGMS Encoder 4.3 spatio-temporal checkpoint for EGMS-QA, a natural-language
14
- question-answering system over European Ground Motion Service persistent-
15
- scatterer displacement time series.
16
 
17
- The encoder maps a variable-size 7 km tile to 65 tokens: one tile-summary token
18
- plus 64 spatial-cell tokens on an 8脳8 grid, each with dimension 256. It was
19
- trained by synchronized-block masked reconstruction and remains frozen during
20
- translator training.
21
 
22
- Code: [`risenyard/egms-qa`](https://github.com/risenyard/egms-qa/tree/main/src/egms_encoder) 路
23
- Dataset: [`risenyard/egms-qa-dataset`](https://huggingface.co/datasets/risenyard/egms-qa-dataset) 路
24
- Translators: [`risenyard/egms-qa-translator`](https://huggingface.co/risenyard/egms-qa-translator)
 
 
 
 
 
 
 
 
25
 
26
  ## Files
27
 
28
  | file | contents |
29
  |---|---|
30
- | `encoder.pt` | model state dictionary and embedded training arguments |
31
- | `normalization.json` | model-local mirror of the dataset's train-split mean, standard deviation, and residual statistics |
32
- | `args.json` | normalized public training and architecture configuration |
 
 
 
33
 
34
- ## Use with the structured dataset release
 
 
35
 
36
  ```bash
37
  git clone https://github.com/risenyard/egms-qa
@@ -40,41 +54,32 @@ pip install -e .
40
 
41
  hf download risenyard/egms-qa-encoder \
42
  --local-dir data/encoder/checkpoint
43
- hf download risenyard/egms-qa-dataset \
44
- --repo-type dataset --local-dir release/egms-qa-dataset
45
- python -m egms_qa.release install \
46
- --release-dir release/egms-qa-dataset --target-root .
47
-
48
- python -m egms_encoder.extract_tokens --output-dir outputs/tokens
49
- # -> outputs/tokens/encoder_tokens_10k.pt
50
  ```
51
 
52
- Most translator users can use the released `encoder_tokens_10k.pt` cache under
53
- `artifacts/representations/` in the dataset repository and skip encoder
54
- execution entirely.
55
 
56
- ## Data and scope
 
 
 
 
 
 
57
 
58
- The model consumes the `[8,302)` slice of each processed 304-step source tile,
59
- giving 294 input steps. Coordinates are centred per tile and divided by the
60
- 3,500 m half-width before coordinate embedding.
 
61
 
62
- The encoder supports the released 10,000-tile dataset and new tiles that
63
- already follow the EGMS-QA NPZ contract and released 304-step source axis. A
64
- user-prepared training corpus must also provide its own split manifest, data
65
- config, and train-fitted normalization. This release does not download official
66
- EGMS data, convert arbitrary EGMS ZIP/CSV products, or automatically select a
67
- time window and normalization for another reference period. Do not reuse the
68
- released `[8,302)` window blindly for a different EGMS product version.
69
 
70
- For release reproduction and standalone inference, the authoritative
71
- normalization file is `normalization.json` beside this checkpoint (SHA256
72
- `78f2ec35fbb8d2fdeb89d46fceb18257144af73b8d32bb506409a756f561b059`).
 
73
 
74
- The encoder represents observed deformation histories; it does not determine
75
- cause, forecast motion, certify structural safety, or replace expert InSAR and
76
- geotechnical assessment.
77
 
78
- The checkpoint is CC-BY-4.0. Copernicus-derived source measurements are
79
- distributed separately in `risenyard/egms-qa-dataset` under the CLMS data
80
- policy and attribution conditions documented there.
 
1
  ---
2
  license: cc-by-4.0
3
+ datasets:
4
+ - risenyard/egms-qa-dataset
5
  tags:
6
  - remote-sensing
7
  - insar
 
10
  - egms
11
  ---
12
 
13
+ # EGMS-QA Encoder
14
 
15
+ A frozen spatio-temporal encoder for persistent-scatterer displacement time
16
+ series from the European Ground Motion Service (EGMS).
 
17
 
18
+ For each 7 km tile, the encoder converts a variable number of point histories
19
+ into context-aware 256-dimensional point representations. Deterministic 8脳8
20
+ spatial pooling then produces 65 EGMS tokens: one tile-summary token and 64
21
+ cell tokens.
22
 
23
+ ## Input and output
24
+
25
+ | stage | shape |
26
+ |---|---|
27
+ | processed source tile | coordinates `[N,2]`, displacement series `[N,304]` |
28
+ | encoder input | `[N,294]`, using the fixed slice `[8,302)` |
29
+ | point representations | `[N,256]` |
30
+ | pooled EGMS tokens | `[65,256]` plus a 65-element validity mask |
31
+
32
+ The model was pretrained with synchronized-block masked reconstruction. Its
33
+ weights remain frozen when training the language-model translator.
34
 
35
  ## Files
36
 
37
  | file | contents |
38
  |---|---|
39
+ | `encoder.pt` | encoder state dictionary and embedded architecture arguments |
40
+ | `args.json` | readable architecture and training configuration |
41
+ | `normalization.json` | input mean, standard deviation, and residual scale |
42
+
43
+ Together these files contain the model-specific information needed to load the
44
+ checkpoint. EGMS measurements are not included in this model repository.
45
 
46
+ ## Use
47
+
48
+ Install the code and download the checkpoint:
49
 
50
  ```bash
51
  git clone https://github.com/risenyard/egms-qa
 
54
 
55
  hf download risenyard/egms-qa-encoder \
56
  --local-dir data/encoder/checkpoint
 
 
 
 
 
 
 
57
  ```
58
 
59
+ Extract tokens from an already prepared compatible NPZ tile collection:
 
 
60
 
61
+ ```bash
62
+ python -m egms_encoder.extract_tokens \
63
+ --checkpoint data/encoder/checkpoint/encoder.pt \
64
+ --manifest path/to/split.parquet \
65
+ --data-config path/to/data_config.json \
66
+ --output-dir outputs/tokens
67
+ ```
68
 
69
+ The manifest and data config describe the user's tiles; they are not properties
70
+ of the checkpoint. The released training data and reference manifest are
71
+ available separately in
72
+ [`risenyard/egms-qa-dataset`](https://huggingface.co/datasets/risenyard/egms-qa-dataset).
73
 
74
+ ## Scope
 
 
 
 
 
 
75
 
76
+ The encoder expects data that already follow the EGMS-QA NPZ and time-axis
77
+ contract. It does not download or convert official EGMS products. Its outputs
78
+ describe observed deformation histories; they do not establish cause, forecast
79
+ motion, or certify structural safety.
80
 
81
+ Code: [`risenyard/egms-qa`](https://github.com/risenyard/egms-qa) 路
82
+ Dataset: [`risenyard/egms-qa-dataset`](https://huggingface.co/datasets/risenyard/egms-qa-dataset) 路
83
+ Translator: [`risenyard/egms-qa-translator`](https://huggingface.co/risenyard/egms-qa-translator)
84
 
85
+ Released under CC-BY-4.0.