API stability in 3.x¶
PanorAi classifies public surfaces by product family, implementation domain,
stability tier, visibility, and canonical import. The machine-readable source
of truth is contracts/public-api-surfaces-v2.json
(panorai-public-api-surfaces/v2), validated by the adjacent JSON Schema.
Surface |
Stability |
Canonical import |
Contract |
Public components or entries |
|---|---|---|---|---|
legacy-composition |
Compatibility |
panorai |
panorai-3x-compatibility/v1 |
EquirectangularImage, GnomonicFace, GnomonicFaceSet, ConfigManager, PanoraiFactory, panorai.projections.GnomonicProjection, panorai.projections.ProjectionRegistry, panorai.projections.base.BaseProjectionStrategy, panorai.projections.base.BaseGridGeneration, panorai.projections.base.BaseInterpolation, panorai.projections.base.BaseCoordinateTransformer, panorai.projections.base.ProjectionError, panorai.projections.base.ConfigurationError, panorai.projections.base.RegistrationError, panorai.projections.base.ProcessingError, panorai.projections.base.GridGenerationError, panorai.projections.base.TransformationError, panorai.projections.base.InterpolationError, panorai.samplers.SamplerRegistry, panorai.samplers.Sampler, panorai.samplers.CubeSampler, panorai.samplers.IcosahedronSampler, panorai.samplers.FibonacciSampler, panorai.samplers.BlueNoiseSampler, panorai.samplers.SpiralSampler, panorai.utils.ResizerConfig, panorai.utils.ImageResizer, panorai.utils.PreprocessEquirectangularImage, panorai.utils.setup_logging |
root-convenience-exports |
Compatibility |
panorai.features |
panorai-root-convenience/v1 |
SphericalFeaturePipeline, __version__ |
core-geometry-preview |
Compatibility |
panorai.core.geometry |
geometry-v1 |
CUBE_FACE_BASES, CUBE_FACE_ORDER, ArrayLike, CubemapProjector, CubemapSpec, ERPPointProjection, GnomonicFaceGeometry, GnomonicPointProjection, GnomonicProjector, GnomonicRayProjection, GnomonicSpec, Interpolation, InvalidPolicy, NumpyArray, ProjectionResult, ShapeHW, TensorLike, camera_rays_to_world_points, cubemap_to_equirectangular, equirectangular_to_cubemap, equirectangular_to_gnomonic, erp_pixels_to_rays, gnomonic_face_geometry, gnomonic_intrinsics, gnomonic_pixel_map, gnomonic_pixels_to_rays, gnomonic_rotation, gnomonic_to_equirectangular, rays_to_gnomonic_pixels, rays_to_erp_pixels, relative_camera_pose, tangent_offsets_to_rays, world_points_to_camera_rays |
spherical-instance-pipeline-root-convenience |
Experimental |
panorai.pipeline |
panorai-spherical-instance-pipeline/v1-experimental |
CAMGuidedSphericalInstances, CAMRegionProposals, SAMMaskRefinement, SphericalCAM, SphericalInstanceFusion |
This page is rendered from that inventory during the strict Sphinx build.
Use the component catalog to choose an object by role, or the complete symbol inventory to inspect every audited export represented by these surfaces.
The tier describes the compatibility promise, not scientific usefulness. Participation in the 3.8 release does not promote an API unless the inventory explicitly records the Stable tier and its promotion evidence.
Tier |
Promise |
|---|---|
Stable |
Preserved throughout 3.x. Removal or incompatible relocation is reserved for 4.0 and requires migration guidance. |
Compatibility |
Existing 3.x imports remain available, but the canonical 4.0 destination may differ. |
Experimental |
Public and tested, but eligible to evolve between minor releases. Every surface has explicit promotion gates. |
Frozen/internal |
No import-path compatibility promise. |
Public surface matrix¶
Surface |
Family |
Tier |
Visibility |
Canonical import |
Contract |
|---|---|---|---|---|---|
public-catalog |
foundations |
stable |
primary |
panorai.catalog |
panorai-catalog/v1 |
spherical-region-analysis-ops |
visual-evidence |
stable |
primary |
panorai.ops.spherical |
panorai-spherical-region-analysis/v1 |
spherical-region-analysis-data |
visual-evidence |
stable |
advanced |
panorai.data |
panorai-spherical-region-analysis/v1 |
spherical-region-analysis-pipeline |
visual-evidence |
stable |
advanced |
panorai.pipeline |
panorai-spherical-region-analysis/v1 |
spherical-evaluation |
research-evaluation |
stable |
primary |
panorai.evaluation |
panorai-spherical-evaluation/v1 |
spherical-surface-reconstruction-evaluation |
research-evaluation |
experimental |
advanced |
panorai.evaluation |
panorai-surface-reconstruction-evaluation/v1-experimental |
canonical-geometry |
foundations |
stable |
primary |
panorai.geometry |
geometry-v1 |
registered-camera-geometry |
mapping-depth |
experimental |
advanced |
panorai.geometry |
panorai-registered-camera-geometry/v1-experimental |
supported-blenders |
foundations |
stable |
primary |
panorai.blenders |
panorai-blenders/v1 |
legacy-composition |
foundations |
compatibility |
advanced |
panorai |
panorai-3x-compatibility/v1 |
object-workflow |
foundations |
stable |
primary |
panorai |
panorai-object-workflow/v1 |
spherical-observations |
foundations |
stable |
primary |
panorai.data |
panorai-spherical-observations/v1 |
root-convenience-exports |
foundations |
compatibility |
advanced |
panorai.features |
panorai-root-convenience/v1 |
spherical-features-core |
visual-evidence |
stable |
primary |
panorai.features |
panorai-spherical-features/v1 |
spherical-features-pycolmap |
visual-evidence |
experimental |
advanced |
panorai.features |
panorai-spherical-features-pycolmap/v1 |
spherical-features-multiscale |
visual-evidence |
experimental |
advanced |
panorai.features |
panorai-spherical-features-multiscale/v1 |
spherical-features-dog-sift |
visual-evidence |
experimental |
advanced |
panorai.features |
panorai-spherical-dog-sift/v2 |
spherical-features-dog-detector |
visual-evidence |
experimental |
advanced |
panorai.features |
panorai-spherical-dog-detector/v2 |
spherical-features-coarse-dog-detector |
visual-evidence |
experimental |
advanced |
panorai.features |
panorai-spherical-coarse-dog-detector/v1 |
spherical-features-tangent-patches |
visual-evidence |
experimental |
advanced |
panorai.features |
panorai-tangent-patches/v1 |
spherical-feature-resolution-selection |
visual-evidence |
experimental |
advanced |
panorai.features |
panorai-resolution-selection/v1 |
spherical-features-tangent-descriptor-v2 |
visual-evidence |
experimental |
advanced |
panorai.features |
panorai-tangent-opencv-descriptor/v2 |
spherical-relative-pose-pipeline |
pose-geometry |
experimental |
primary |
panorai.features |
panorai-spherical-relative-pose-pipeline/v1-experimental |
spherical-image-processing |
visual-evidence |
experimental |
primary |
panorai.image_processing |
panorai-spherical-image-processing/v1 |
spherical-image-processing-slic |
visual-evidence |
stable |
primary |
panorai.image_processing |
panorai-spherical-slic/v1 |
spherical-deep-learning-depth |
mapping-depth |
experimental |
primary |
panorai.experimental.deep_learning |
panorai-spherical-metric-depth/v1-experimental |
tangent-da3-metric-depth |
mapping-depth |
experimental |
primary |
panorai.experimental.deep_learning |
panorai-depth-anything-3-metric-tangent/v1-experimental |
spherical-internimage-portability |
semantic-evidence |
experimental |
advanced |
panorai.experimental.deep_learning |
panorai-spherical-internimage/v1 |
spherical-semantic-segmentation |
semantic-evidence |
experimental |
primary |
panorai.experimental.deep_learning.segmentation |
panorai-spherical-semantic-segmentation/v1 |
spherical-relative-pose |
pose-geometry |
experimental |
primary |
panorai.estimators |
panorai-spherical-relative-pose/v1 |
semantic-object-localization |
spatial-semantic-graph |
experimental |
advanced |
panorai.object_localization |
panorai-object-localization/v1 |
spherical-reconstruction |
mapping-depth |
experimental |
primary |
panorai.reconstruction |
panorai-spherical-reconstruction/v1 |
deep-learning-support |
visual-evidence |
experimental |
advanced |
panorai.experimental.deep_learning |
panorai-deep-learning-support/v1-experimental |
spatial-semantic-graph |
spatial-semantic-graph |
experimental |
primary |
panorai.graph |
panorai-spatial-semantic-graph/v1 |
metric-spherical-landmark-ba |
mapping-depth |
experimental |
advanced |
panorai.reconstruction.metric_landmark_ba |
panorai-metric-spherical-landmark-ba/v1-experimental |
spherical-dense-stereo |
mapping-depth |
experimental |
primary |
panorai.stereo |
panorai-spherical-dense-stereo/v1-experimental |
classical-rectified-stereo |
mapping-depth |
experimental |
advanced |
panorai.stereo.classical |
panorai-classical-dense-stereo/v1-experimental |
registered-full-sphere-stereo-core |
mapping-depth |
experimental |
primary |
panorai.stereo.panoramic |
panorai-registered-full-sphere-stereo/v1-experimental |
panoramic-dense-stereo-workflow |
mapping-depth |
experimental |
primary |
panorai.stereo.panoramic |
panorai-panoramic-dense-stereo/v1-experimental |
spherical-slam |
mapping-depth |
experimental |
primary |
panorai.slam |
panorai-spherical-slam/v1 |
research-blenders |
foundations |
experimental |
advanced |
panorai.blenders |
panorai-research-blenders/v1 |
spherical-core-contracts |
foundations |
experimental |
advanced |
panorai.core |
panorai-core-operations/v1 |
spherical-core-numpy |
foundations |
experimental |
advanced |
panorai.core.numpy |
panorai-core-operations/v1 |
spherical-core-torch |
foundations |
stable |
advanced |
panorai.core.torch |
panorai-core-operations/v1 |
core-geometry-preview |
foundations |
compatibility |
advanced |
panorai.core.geometry |
geometry-v1 |
spherical-model-workflow |
foundations |
experimental |
advanced |
panorai.workflow |
panorai-spherical-model-workflow/v1 |
spherical-model-workflow-numpy |
foundations |
experimental |
advanced |
panorai.workflow.numpy |
panorai-spherical-model-workflow/v1 |
spherical-model-workflow-torch |
foundations |
experimental |
advanced |
panorai.workflow.torch |
panorai-spherical-model-workflow/v1 |
spherical-ops-core |
visual-evidence |
stable |
advanced |
panorai.ops.spherical |
panorai-spherical-ops/v1 |
spherical-ops-morphology |
visual-evidence |
stable |
advanced |
panorai.ops.spherical |
panorai-spherical-morphology/v1 |
spherical-ops-slic |
visual-evidence |
stable |
advanced |
panorai.ops.spherical |
panorai-spherical-slic/v1 |
spherical-ops-dog-detector |
visual-evidence |
experimental |
advanced |
panorai.ops.spherical |
panorai-spherical-dog-detector/v2 |
spherical-ops-algorithms-gateway |
visual-evidence |
experimental |
advanced |
panorai.ops.spherical |
panorai-spherical-algorithms/v1-experimental |
spherical-ops-torch |
foundations |
stable |
advanced |
panorai.ops.spherical.nn |
panorai-spherical-ops-torch/v1 |
spherical-algorithms-general |
visual-evidence |
stable |
advanced |
panorai.ops.spherical |
panorai-spherical-ops/v1 |
spherical-algorithms-slic |
visual-evidence |
stable |
advanced |
panorai.ops.spherical |
panorai-spherical-slic/v1 |
spherical-algorithms-dog-detector |
visual-evidence |
experimental |
advanced |
panorai.ops.spherical |
panorai-spherical-dog-detector/v2 |
pinhole-camera-geometry |
foundations |
experimental |
advanced |
panorai.calibration |
panorai-pinhole-intrinsics/v1-experimental |
rotation-pair-calibration |
pose-geometry |
experimental |
advanced |
panorai.calibration |
panorai-rotation-pair-calibration/v1-experimental |
robust-model-fitting |
pose-geometry |
experimental |
advanced |
panorai.model_fitting |
panorai-robust-model-fitting/v1-experimental |
panorama-stitching-stages |
visual-evidence |
experimental |
advanced |
panorai.stitching |
panorai-panorama-stitching/v1-experimental |
panorama-stitching-data |
visual-evidence |
experimental |
advanced |
panorai.stitching |
panorai-panorama-stitching/v1-experimental |
panorama-stitching-application |
visual-evidence |
experimental |
primary |
panorai.applications |
panorai-panorama-stitching/v1-experimental |
registered-full-sphere-stereo-application |
mapping-depth |
experimental |
primary |
panorai.applications |
panorai-registered-full-sphere-stereo/v1-experimental |
spherical-applications-dog-reviewed-profile |
visual-evidence |
experimental |
primary |
panorai.applications |
panorai-spherical-dog-features/v1 |
spherical-applications |
visual-evidence |
experimental |
primary |
panorai.applications |
panorai-application/v1-experimental |
spherical-applications-slic |
visual-evidence |
stable |
primary |
panorai.applications |
panorai-spherical-slic/v1 |
spherical-mask-rcnn-taxonomy |
semantic-evidence |
experimental |
advanced |
panorai.experimental.deep_learning.mask_rcnn |
panorai-spherical-mask-rcnn/v1-experimental |
spherical-pipeline-core |
foundations |
stable |
advanced |
panorai.pipeline |
panorai-spherical-pipeline/v1 |
spherical-pipeline-semantic-instances |
semantic-evidence |
experimental |
advanced |
panorai.pipeline |
panorai-spherical-instance-pipeline/v1-experimental |
spherical-pipeline-root-convenience |
foundations |
stable |
advanced |
panorai.pipeline |
panorai-spherical-pipeline/v1 |
spherical-instance-pipeline-root-convenience |
semantic-evidence |
experimental |
advanced |
panorai.pipeline |
panorai-spherical-instance-pipeline/v1-experimental |
spherical-surface-open3d-adapter |
mapping-depth |
experimental |
advanced |
panorai.pcd |
panorai-surface-open3d-adapter/v1-experimental |
spherical-applications-auto-experimental |
visual-evidence |
experimental |
advanced |
panorai.applications |
panorai-application/auto-experimental |
spherical-estimators-auto-experimental |
pose-geometry |
experimental |
advanced |
panorai.estimators |
panorai-estimator/auto-experimental |
spherical-ops-auto-experimental |
visual-evidence |
experimental |
advanced |
panorai.ops.spherical |
panorai-spherical-ops/auto-experimental |
spherical-pipeline-auto-experimental |
foundations |
experimental |
advanced |
panorai.pipeline |
panorai-spherical-pipeline/auto-experimental |
implementation-internals |
internal |
internal |
internal |
— |
none |
Product-family view¶
The primary navigation groups the granular contracts into product families. The IDs remain granular so a component can be tested or promoted without implicitly promoting its entire family.
Family |
Purpose |
Contracts |
|---|---|---|
Stable foundations |
Geometry, multimodal workflow, fusion, and compatibility surfaces. |
20 |
Spherical visual evidence |
Image processing, features, descriptors, and learned visual frontends. |
31 |
Pose and relational geometry |
Pairwise pose, probability, and reusable correspondence evidence. |
5 |
Mapping and depth |
Depth, stereo, reconstruction, bundle adjustment, and SLAM. |
12 |
Semantic evidence and localization |
Semantic frontends and feature-indexed region observations. |
5 |
Spatial-semantic graph |
Association, spatial posterior, entity lifecycle, persistence, and query. |
2 |
Research evaluation |
Geometry-aware metrics, frozen protocols, and reproducible evaluation records. |
2 |
Compatibility rules for 3.8¶
No Stable or Compatibility import receives a new runtime warning.
panorai.features.__all__is preserved.panorai.object_localizationremains importable and preserves its v1 result models, IDs, scores, and states. Its pipeline delegates association and pair localization topanorai.graph.panorai.graphis Experimental and import-light. Importing it does not load Torch, Open3D, PyCOLMAP, checkpoints, or a database backend.Native acceleration is not a separate public numerical contract.
The 4.0 destination map is documented in Planned 4.0 destination map.