Skip to main content

MansionWorld API package for multi-floor embodied AI tasks

Project description

mansion-api

PyPI version

mansion-api provides the core programming interface and environment wrapper for MANSION. It features MansionGym, a Gymnasium-style environment backed by AI2-THOR. This package enables agents to seamlessly interact with multi-floor buildings using a unified AI2-THOR-style action API.

Installation

Install mansion-api directly from PyPI:

pip install mansion-api

Quickstart

To get started, you will need to initialize the MansionGym environment. Ensure your building_dir contains your per-floor scene JSON files formatted as floor_1.json, floor_2.json, etc.

from mansion_gym.mansion_env import MansionGym

# Initialize the environment
env = MansionGym(
    building_dir="path/to/building", 
    initial_floor=1, 
    max_steps=1000
)

# Reset to get the initial observation
obs, info = env.reset()

Resources & Documentation

For comprehensive information regarding the multi-floor world model, the MansionWorld dataset, and detailed API signatures for skills, please refer to the official documentation:


Copyright © 2026 MANSION contributors.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mansion_api-0.1.3.tar.gz (23.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

mansion_api-0.1.3-py3-none-any.whl (30.8 kB view details)

Uploaded Python 3

File details

Details for the file mansion_api-0.1.3.tar.gz.

File metadata

  • Download URL: mansion_api-0.1.3.tar.gz
  • Upload date:
  • Size: 23.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.2

File hashes

Hashes for mansion_api-0.1.3.tar.gz
Algorithm Hash digest
SHA256 0efa6c95da460e8c5a11db0e53f52b2d401e497d6b9b68f62afc00d247565015
MD5 a978006506222e7e23b49bcd9229cfc6
BLAKE2b-256 d27d93e289cc85fa70383f7f1cb8b27885baec389212564977aacfd2c1ebb5bd

See more details on using hashes here.

File details

Details for the file mansion_api-0.1.3-py3-none-any.whl.

File metadata

  • Download URL: mansion_api-0.1.3-py3-none-any.whl
  • Upload date:
  • Size: 30.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.2

File hashes

Hashes for mansion_api-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 e3cc24814879da6b99f81681777f5c772d12cddff16fff2004f90c1866eae4e0
MD5 e501cbfab5a7212529297d9006dede4e
BLAKE2b-256 ff2f7585d4b1b4d4820cb034329a19f908d5888ee0ff22d729ae14222ddd8217

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page