Skip to content

Commit 0a26277

Browse files
committed
fix:ruff
1 parent 39f41ad commit 0a26277

File tree

8 files changed

+56
-54
lines changed

8 files changed

+56
-54
lines changed

CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@ This release rolls up upstream-alignment work and correctness fixes that may cha
2626
### Changed
2727

2828
- Standardised NumPy docstrings across all public functions and classes in `export.py`, `inspect.py`, `writers.py`, and the `tools/` and `providers/` layers. No behaviour changes.
29+
2930
### Added
3031

3132
- Versioned documentation with a version selector powered by `mike` and MkDocs Material. Each release tag deploys a pinned version; pushes to `main` update a `dev` alias. The `mike`, `mkdocs-material`, and `pymdown-extensions` packages are now included in the `[dev]` optional group.

docs/api_load.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ Use `load_export(...)` to read any export produced by [`export_batch`](api_expor
2020

2121
### Mental Model
2222

23-
`load_export(...)` answers one question: *where is the export?*
23+
`load_export(...)` answers one question: _where is the export?_
2424

2525
- Pass a **file** (`.npz`, `.nc`, or `.json`) to load a **combined** export.
2626
- Pass a **directory** to load a **per-item** export.
@@ -43,17 +43,17 @@ result = load_export("exports/per_item_run/")
4343

4444
## Parameters
4545

46-
| Parameter | Meaning |
47-
| --------- | --------------------------------------------------------------------------------- |
46+
| Parameter | Meaning |
47+
| --------- | -------------------------------------------------------------------------------- |
4848
| `path` | Path to a `.npz`/`.nc`/`.json` file (combined) or a directory (per-item export). |
4949

5050
### Raises
5151

52-
| Exception | When |
53-
| ----------------- | --------------------------------------------------------------------- |
54-
| `FileNotFoundError` | Path does not exist. |
55-
| `ValueError` | Path exists but cannot be interpreted as an rs-embed export. |
56-
| `ImportError` | NetCDF export requested but `xarray` is not installed. |
52+
| Exception | When |
53+
| ------------------- | ------------------------------------------------------------ |
54+
| `FileNotFoundError` | Path does not exist. |
55+
| `ValueError` | Path exists but cannot be interpreted as an rs-embed export. |
56+
| `ImportError` | NetCDF export requested but `xarray` is not installed. |
5757

5858
---
5959

@@ -102,11 +102,11 @@ class ModelResult:
102102

103103
**Status values:**
104104

105-
| Status | Meaning |
106-
| --------- | ------------------------------------------------ |
107-
| `"ok"` | All points succeeded. |
105+
| Status | Meaning |
106+
| ----------- | -------------------------------------------------------------------- |
107+
| `"ok"` | All points succeeded. |
108108
| `"partial"` | Some points succeeded; failed points are NaN-filled in `embeddings`. |
109-
| `"failed"` | All points failed; `embeddings` is `None`. |
109+
| `"failed"` | All points failed; `embeddings` is `None`. |
110110

111111
---
112112

@@ -190,5 +190,5 @@ emb = result.embedding("remoteclip") # shape (1, dim)
190190
```
191191

192192
!!! tip "Simple rule"
193-
Pass a file path for combined exports, a directory path for per-item exports.
194-
Everything else is automatic.
193+
Pass a file path for combined exports, a directory path for per-item exports.
194+
Everything else is automatic.

docs/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ Most workflows revolve around three functions: `get_embedding(...)` for one ROI,
4646
| Get one embedding for one ROI | [Quickstart](quickstart.md) | `get_embedding(...)` |
4747
| Compute embeddings for many ROIs | [Quickstart](quickstart.md) | `get_embeddings_batch(...)` |
4848
| Build an export dataset | [Quickstart](quickstart.md) | `export_batch(...)` |
49-
| Compare model assumptions | [Models](models.md) | model tables + detail pages |
49+
| Compare model assumptions | [Models](models.md) | model tables + detail pages |
5050
| Inspect a raw provider patch | [Inspect API](api_inspect.md) | `inspect_provider_patch(...)` |
5151

5252
---

docs/models/scalemae.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -4,19 +4,19 @@
44
55
## Quick Facts
66

7-
| Field | Value |
8-
|---|---|
9-
| Model ID | `scalemae` |
10-
| Aliases | `scalemae_rgb` |
11-
| Family / Backbone | ScaleMAE via `rshf.scalemae.ScaleMAE` |
12-
| Adapter type | `on-the-fly` |
13-
| Typical backend | provider backend (`gee`) |
14-
| Primary input | S2 RGB (`B4,B3,B2`) + `input_res_m` |
15-
| Default resolution | 10m default provider fetch / source scale (`sensor.scale_m`) |
16-
| Temporal mode | range window in practice (normalized via shared helper) |
17-
| Output modes | `pooled`, `grid` |
18-
| Extra side inputs | **required effective scale** (`input_res_m` derived from `sensor.scale_m` after preprocess) |
19-
| Training alignment (adapter path) | High when `sensor.scale_m` matches the source patch resolution semantics |
7+
| Field | Value |
8+
| --------------------------------- | ------------------------------------------------------------------------------------------- |
9+
| Model ID | `scalemae` |
10+
| Aliases | `scalemae_rgb` |
11+
| Family / Backbone | ScaleMAE via `rshf.scalemae.ScaleMAE` |
12+
| Adapter type | `on-the-fly` |
13+
| Typical backend | provider backend (`gee`) |
14+
| Primary input | S2 RGB (`B4,B3,B2`) + `input_res_m` |
15+
| Default resolution | 10m default provider fetch / source scale (`sensor.scale_m`) |
16+
| Temporal mode | range window in practice (normalized via shared helper) |
17+
| Output modes | `pooled`, `grid` |
18+
| Extra side inputs | **required effective scale** (`input_res_m` derived from `sensor.scale_m` after preprocess) |
19+
| Training alignment (adapter path) | High when `sensor.scale_m` matches the source patch resolution semantics |
2020

2121
---
2222

0 commit comments

Comments
 (0)