Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
3 changes: 2 additions & 1 deletion .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,8 @@ jobs:
- uses: actions/setup-python@v5
with:
python-version: "3.11"
- run: python -m pip install --upgrade pip build
- run: python -m pip install --upgrade pip
- run: python -m pip install ".[ai2thor]"
- run: python -m pip install ".[test]"
- run: python -m pytest -q tests/public_smoke
- run: python -m build --wheel --sdist
39 changes: 39 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
.worktrees/

# Python bytecode and caches
__pycache__/
*.py[cod]
.pytest_cache/
.hypothesis/
.mypy_cache/
.ruff_cache/
build/
dist/

# Local Python environments and secrets
.venv/
.venv-core/
.venv-gpu/
venv/
.env
.env.*
!.env.example

# Editors
.idea/
.vscode/

# Generated datasets and experiment outputs
artifacts/
outputs/
runs/
logs/
checkpoints/
models/

# Model weights and exported graphs
*.safetensors
*.ckpt
*.pt
*.pth
*.onnx
13 changes: 12 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,15 +9,26 @@ fresh verification。
Schema、求解器和验证逻辑均为平台无关设计。Unity/AI2-THOR 是首个 Adapter,只负责把
平台事实和原生操作连接到这条公共生成链。

## 仓库与发布

面向用户的权威仓库是
[`Legender134/spatialcf`](https://github.com/Legender134/spatialcf)。`v0.1.1` 是 GitHub
release,不是 PyPI 发布;请从该 release tag 克隆并在本地 checkout 中安装。

公共发布内容来自经过校验的确定性快照。完整开发历史、私有发布清单和恢复证据不会进入
用户仓库;它们由维护者在独立的私有开发与归档边界中保管。

## 快速开始

需要 Python 3.11。以下命令创建环境、安装 AI2-THOR Adapter、生成数据,并重新打开数据集
执行验证和检查:

```bash
git clone --branch v0.1.1 --depth 1 https://github.com/Legender134/spatialcf.git
cd spatialcf
python -m venv .venv
. .venv/bin/activate
python -m pip install "spatialcf[ai2thor]"
python -m pip install ".[ai2thor]"
spatialcf generate --config configs/ai2thor-example.toml --output ./dataset
spatialcf verify ./dataset
spatialcf inspect ./dataset
Expand Down
16 changes: 15 additions & 1 deletion README_EN.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,16 +11,30 @@ 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.

## 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.

Public releases come from a verified deterministic snapshot. Complete
development history, private release manifests, and recovery evidence stay in
separate private development and archive boundaries and are never copied into
the user repository.

## Quick start

Python 3.11 is required. These commands create an environment, install the
AI2-THOR Adapter, generate a dataset, and reopen it for verification and
inspection:

```bash
git clone --branch v0.1.1 --depth 1 https://github.com/Legender134/spatialcf.git
cd spatialcf
python -m venv .venv
. .venv/bin/activate
python -m pip install "spatialcf[ai2thor]"
python -m pip install ".[ai2thor]"
spatialcf generate --config configs/ai2thor-example.toml --output ./dataset
spatialcf verify ./dataset
spatialcf inspect ./dataset
Expand Down
10 changes: 8 additions & 2 deletions docs/adapters.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,16 @@ repeated native execution.

## Unity/AI2-THOR

Unity/AI2-THOR is the first supported Adapter. Install it with:
Unity/AI2-THOR is the first supported Adapter. `v0.1.1` is a GitHub release,
not a PyPI publication, so install the Adapter from a local checkout of that
release:

```bash
python -m pip install "spatialcf[ai2thor]"
git clone --branch v0.1.1 --depth 1 https://github.com/Legender134/spatialcf.git
cd spatialcf
python -m venv .venv
. .venv/bin/activate
python -m pip install ".[ai2thor]"
```

Select it in TOML with `adapter = "ai2thor"` and provide one or more exact scene
Expand Down
9 changes: 6 additions & 3 deletions docs/installation.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,15 @@
# Installation

SpatialCF supports Python 3.11. Create an isolated environment and install the
package with the AI2-THOR Adapter:
SpatialCF supports Python 3.11. `v0.1.1` is a GitHub release, not a PyPI
publication. Clone that release tag, then create an isolated environment and
install the local package with the AI2-THOR Adapter:

```bash
git clone --branch v0.1.1 --depth 1 https://github.com/Legender134/spatialcf.git
cd spatialcf
python -m venv .venv
. .venv/bin/activate
python -m pip install "spatialcf[ai2thor]"
python -m pip install ".[ai2thor]"
```

The base package contains the platform-neutral Schema, solver, generation
Expand Down
7 changes: 5 additions & 2 deletions docs/quickstart.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,14 @@
# Quick start

From the repository root, run the complete workflow:
`v0.1.1` is a GitHub release, not a PyPI publication. Clone it and run the
complete workflow from the local checkout:

```bash
git clone --branch v0.1.1 --depth 1 https://github.com/Legender134/spatialcf.git
cd spatialcf
python -m venv .venv
. .venv/bin/activate
python -m pip install "spatialcf[ai2thor]"
python -m pip install ".[ai2thor]"
spatialcf generate --config configs/ai2thor-example.toml --output ./dataset
spatialcf verify ./dataset
spatialcf inspect ./dataset
Expand Down
6 changes: 4 additions & 2 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,11 @@ build-backend = "hatchling.build"

[project]
name = "spatialcf"
version = "0.1.0"
version = "0.1.1"
description = "Minimal verified spatial counterfactual compiler"
readme = "README_EN.md"
requires-python = ">=3.11,<3.12"
license = "Apache-2.0"
dependencies = [
"numpy>=2.0,<3",
"pydantic>=2.8,<3",
Expand All @@ -19,7 +20,7 @@ dependencies = [

[project.optional-dependencies]
ai2thor = ["ai2thor>=5,<6"]
test = ["pytest>=8,<10", "pytest-xdist>=3.6,<4", "hypothesis>=6,<7"]
test = ["build>=1,<2", "pytest>=8,<10", "pytest-xdist>=3.6,<4", "hypothesis>=6,<7"]

[project.scripts]
spatialcf = "spatialcf.cli:app"
Expand All @@ -29,6 +30,7 @@ packages = ["src/spatialcf"]

[tool.hatch.build.targets.sdist]
include = [
"/.gitignore",
"/.github/workflows/ci.yml",
"/LICENSE",
"/NOTICE",
Expand Down
17 changes: 0 additions & 17 deletions src/spatialcf/data/__init__.py

This file was deleted.

101 changes: 0 additions & 101 deletions src/spatialcf/data/artifacts.py

This file was deleted.

Loading
Loading