You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
chore: apply prettier formatting to docs and config files
Run prettier (via pre-commit) across all markdown, YAML, and CSS files.
No content changes — whitespace, line wrapping, and list indentation
only. Brings the repo into compliance with the configured prettier hook
so future pre-commit runs are clean.
Copy file name to clipboardExpand all lines: CHANGELOG.md
+4Lines changed: 4 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,11 +11,13 @@ The format is based on Keep a Changelog, and the project follows Semantic Versio
11
11
## [0.1.1] - 2026-04-01
12
12
13
13
### Added
14
+
14
15
- Automated pull request changelog enforcement with a `skip-changelog` escape hatch for docs, tests, CI, and other internal-only changes.
15
16
- Tag-driven GitHub Release publishing that uses the matching `CHANGELOG.md` section as the release notes.
16
17
- Trusted Publishing release automation for PyPI and TestPyPI, including a manual TestPyPI dry run and install smoke test.
17
18
18
19
### Changed
20
+
19
21
- The contribution and release workflow now treats `CHANGELOG.md` as the canonical source for user-visible release notes.
20
22
- The tag-triggered release flow now validates `src/rs_embed/_version.py`, publishes to PyPI, and only then creates the GitHub Release.
21
23
- The tag-triggered release flow now validates the matching `CHANGELOG.md` entry before publishing to PyPI, so a missing release-notes section fails early instead of after package upload.
@@ -27,11 +29,13 @@ The format is based on Keep a Changelog, and the project follows Semantic Versio
27
29
### Removed
28
30
29
31
### Fixed
32
+
30
33
- The TestPyPI smoke test now verifies package importability and the `rs-embed` CLI entry point, not just installability and version metadata.
31
34
32
35
## [0.1.0] - 2026-03-31
33
36
34
37
### Added
38
+
35
39
- Initial public alpha release of `rs-embed`.
36
40
- Unified ROI to embedding API centered on `get_embedding(...)`, `get_embeddings_batch(...)`, `export_batch(...)`, and `inspect_provider_patch(...)`.
37
41
- Support for precomputed embedding products including `tessera`, `gse`, and `copernicus`.
@@ -94,45 +87,41 @@ For new users, start with these primary APIs:
94
87
-`export_batch(...)`: export datasets / experiments (single or multiple ROIs)
95
88
-`inspect_provider_patch(...)`: inspect raw provider patches before inference
96
89
97
-
98
90
## Supported Models
99
91
100
92
This is a convenience index with basic model info only (for quick scanning / links). For detailed I/O behavior and preprocessing notes, see [Supported Models](https://cybergis.github.io/rs-embed/models/).
101
93
102
94
### Precomputed Embeddings
103
95
104
-
| Model ID | Resolution | Time Coverage | Publication |
|`agrifm`| S2 time series (10-band) | 10m |[RSE 2026](https://www.sciencedirect.com/science/article/pii/S0034425726000040)|[link](https://github.com/flyakon/AgriFM)|
104
+
| Model ID |Primary Input | Resolution(Default) | Publication | Link|
|`agrifm`| S2 time series (10-band) | 10m |[RSE 2026](https://www.sciencedirect.com/science/article/pii/S0034425726000040)|[link](https://github.com/flyakon/AgriFM)|
130
122
131
123
Resolution here means the default provider/source fetch resolution used by the adapter, not the final resized tensor shape seen by the model.
We welcome issues for new model integrations, extension ideas, bugs, and documentation gaps. If you have your own work, or a model or paper that you think would be valuable to include in `rs-embed`, please open an [Issue](https://github.com/cybergis/rs-embed/issues) and share the relevant links, context, and examples.
152
140
153
-
We also warmly welcome community contributions, including new model support, bug fixes, documentation improvements, and example notebooks. If you would like to contribute directly, please start with the [`extending`](https://cybergis.github.io/rs-embed/extending/) guide and the [contributing guide](https://cybergis.github.io/rs-embed/contributing/).
154
-
155
-
141
+
We also warmly welcome community contributions, including new model support, bug fixes, documentation improvements, and example notebooks. If you would like to contribute directly, please start with the [`extending`](https://cybergis.github.io/rs-embed/extending/) guide and the [contributing guide](https://cybergis.github.io/rs-embed/contributing/).
156
142
157
143
## 🎖 Acknowledgements
144
+
158
145
We would like to thank the following organizations and projects that make rs-embed possible: [Google Earth Engine](https://earthengine.google.com), [TorchGeo](https://github.com/torchgeo/torchgeo), [GeoTessera](https://github.com/ucam-eo/geotessera), [TerraTorch](https://github.com/terrastackai/terratorch), [rshf](https://github.com/mvrl/rshf), and the [Copernicus-Embed](https://huggingface.co/datasets/torchgeo/copernicus_embed).
159
146
160
147
This library also builds upon the incredible work of the Remote Sensing community!(Full list and citations available in our Documentation)
161
148
162
149
## Citation
150
+
163
151
```
164
152
@article{ye2026modelplacetimeremote,
165
-
title={Any Model, Any Place, Any Time: Get Remote Sensing Foundation Model Embeddings On Demand},
153
+
title={Any Model, Any Place, Any Time: Get Remote Sensing Foundation Model Embeddings On Demand},
166
154
author={Dingqi Ye and Daniel Kiv and Wei Hu and Jimeng Shi and Shaowen Wang},
167
155
year={2026},
168
156
eprint={2602.23678},
169
157
archivePrefix={arXiv},
170
158
primaryClass={cs.CV},
171
-
url={https://arxiv.org/abs/2602.23678},
159
+
url={https://arxiv.org/abs/2602.23678},
172
160
}
173
161
```
174
162
175
-
176
163
## License
177
-
This project is released under the [Apache-2.0](https://github.com/cybergis/rs-embed/blob/main/LICENSE)
178
164
165
+
This project is released under the [Apache-2.0](https://github.com/cybergis/rs-embed/blob/main/LICENSE)
| understand spatial/temporal/output specs |[API: Specs and Data Structures](api_specs.md)|
19
+
| get one embedding or batch embeddings |[API: Embedding](api_embedding.md)|
20
+
| build export pipelines and datasets |[API: Export](api_export.md)|
21
+
| inspect raw provider patches before inference |[API: Inspect](api_inspect.md)|
22
22
23
23
---
24
+
24
25
## Useful Extras
25
26
26
27
`export_npz(...)` is a compatibility wrapper around `export_batch(...)` for single-ROI `.npz`, `inspect_gee_patch(...)` is the older GEE-focused name for `inspect_provider_patch(...)`, and `list_models()` is the stable public helper for inspecting the model catalog.
0 commit comments