Skip to content

docs: publish M2 current-main status #6

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Legender134 merged 1 commit into from
Sep 2, 2026
Merged

docs: publish M2 current-main status #6

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 17 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,26 @@ SpatialCF 用于生成经过验证的空间反事实数据集。当前链路：d
Schema、求解器和验证逻辑均为平台无关设计。Unity/AI2-THOR 是首个 Adapter，只负责把
平台事实和原生操作连接到这条公共生成链。

## 当前 main 状态

稳定 generation chain 保持不变。当前 public main 已包含 advanced
`spatialcf/planar_translate@2` compatibility embedding：它把 sealed v2 inputs 映射进
general contracts；compatibility backend
`spatialcf.core.planar_backend.PlanarTranslateBackend` 恰好一次调用既有
`spatialcf.core.solver.solve_minimum_cost`，且不调用 verifier。旧 v2 result/certificate
验证仍完全属于既有 verifier owner。它不是第二个 solver/verifier，也不是新的 generation
route。

当前 public main 与最新 annotated release tag 不同：`v0.1.1` 仍是最新 annotated release
tag，尚未发布 `v0.2.0`。
下方 quickstart 因此继续精确使用 `v0.1.1`。

## 仓库与发布

面向用户的权威仓库是
[`Legender134/spatialcf`](https://github.com/Legender134/spatialcf)。`v0.1.1` 是 GitHub
release，不是 PyPI 发布；请从该 release tag 克隆并在本地 checkout 中安装。
[`Legender134/spatialcf`](https://github.com/Legender134/spatialcf)。`v0.1.1` 是最新
annotated release tag，不是 PyPI 发布，也不应称为 GitHub Release；请从该 tag 克隆并在本地
checkout 中安装。

公共发布内容来自经过校验的确定性快照。完整开发历史、私有发布清单和恢复证据不会进入
用户仓库；它们由维护者在独立的私有开发与归档边界中保管。
Expand Down
20 changes: 18 additions & 2 deletions README_EN.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,28 @@ The Schema, solver, and verification logic are platform-neutral. Unity/AI2-THOR
is the first Adapter and connects platform facts and native operations to the
public generation chain.

## Current `main` status

The stable generation chain is unchanged. Current public `main` includes the
advanced `spatialcf/planar_translate@2` compatibility embedding: it maps sealed
v2 inputs into general contracts. Its compatibility backend
`spatialcf.core.planar_backend.PlanarTranslateBackend` delegates exactly once to
the existing `spatialcf.core.solver.solve_minimum_cost` and does not call the
verifier. Existing v2 result/certificate verification remains entirely owned by
the existing verifier owner. It is not a second solver or verifier, and it does
not create a new generation route.

Current public `main` is distinct from the latest annotated release tag:
`v0.1.1` remains the latest annotated release tag and `v0.2.0` has not been
released. The quick start below therefore continues to use the exact `v0.1.1`
tag.

## Repository and release

The authoritative user-facing repository is
[`Legender134/spatialcf`](https://github.com/Legender134/spatialcf). `v0.1.1`
is a GitHub release, not a PyPI publication. Clone that release tag and install
from the local checkout.
is the latest annotated release tag. It is not a PyPI publication and is not a
GitHub Release. Clone that tag and install from the local checkout.

Public releases come from a verified deterministic snapshot. Complete
development history, private release manifests, and recovery evidence stay in
Expand Down
12 changes: 12 additions & 0 deletions docs/api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,18 @@

The supported version-free API is exported from `spatialcf.generation`.

## Advanced planar-translate compatibility

Public `main` also carries the advanced
`spatialcf/planar_translate@2` compatibility embedding. It maps sealed v2
planar-translate inputs into the general contract. Its compatibility backend
`spatialcf.core.planar_backend.PlanarTranslateBackend` delegates exactly once to
existing `spatialcf.core.solver.solve_minimum_cost` and does not call the
verifier. Existing v2 result/certificate verification remains entirely owned by
the existing verifier. This is not a second solver or verifier, and it does not
add a generation entry point or change the supported `spatialcf.generation` API
above.

## Generate

```python
Expand Down
9 changes: 9 additions & 0 deletions docs/concepts.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,15 @@ visibility, and target-relation constraints. It chooses a deterministic
minimum-cost edit from that domain. Labels are derived from geometry and
independent verification, not supplied by the Adapter.

## Advanced planar compatibility boundary

`spatialcf/planar_translate@2` is an additive compatibility embedding for
sealed current Canonical v2 inputs. It maps those inputs into general
counterfactual contracts, then its thin backend delegates to the one existing v2
solver owner. Existing v2 result and certificate verification remains at the
existing verifier boundary. This is not a second solver or verifier, and it does
not add a generation path or change the supported generation API.

## Adapter

An Adapter loads and normalizes source scenes, captures observations, reports
Expand Down
Loading