symforce

环境要求

• Python 环境，可直接使用 pip 安装包
• Linux 或 macOS 系统（pip wheel 提供预编译 C++ 组件）
• 若需编译 C++ SymForce 类型（如 sym::Optimizer），需从源码构建
• 生成 C++ 代码时目标工程需要 Eigen

安装与启动步骤

1. 1安装 SymForce

   在已配置好的 Python 环境中用 pip 安装官方发布的 symforce 包，会自动带上 Linux/macOS 预编译 C++ 组件。

   pip install symforce

   复制

2. 2验证符号类型可用

   运行 README 给出的导入与实例化语句，能正常创建 Rot3 即说明 Python 符号部分可用。

   python -c "import symforce.symbolic as sf; print(sf.Rot3())"

   复制

3. 3检查符号后端

   确认符号计算后端为 symengine，并确认能导入预编译的 cc_sym 扩展；两者任一异常通常说明安装损坏。

   python -c "import symforce; print(symforce.get_symbolic_api()); from symforce import cc_sym"

   复制

4. 4生成 C++ 运行时代码

   先定义好符号残差函数 bearing_residual，再用 Codegen 配置为 CppConfig，并对 pose 参数做高斯牛顿线性化后生成函数。

   from symforce.codegen import Codegen, CppConfig
   
   codegen = Codegen.function(bearing_residual, config=CppConfig())
   codegen_linearization = codegen.with_linearization(
       which_args=["pose"]
   )
   metadata = codegen_linearization.generate_function()
   print(open(metadata.generated_files[0]).read())

   复制

关键配置

如何确认成功

执行 python -c "import symforce; print(symforce.get_symbolic_api())" 输出 symengine，且能成功 from symforce import cc_sym。

常见问题

注意事项

• pip 安装会附带 Linux 和 Mac 的预编译 C++ 组件，但不包含 C++ 头文件。
• 自动生成的 C++ 文件头部已注明“Do not modify by hand”，不要手工修改生成结果。
• README 示例中的 bearing_residual 等符号函数需自行定义后再调用 Codegen。
• README 提到的 TypeScript、CUDA、PyTorch 后端目前只是候选方向，尚未内置。