Machine Common Sense Documentation

Release:

0.7.4

Date:

Feb 05, 2024

• Installation and Setup
  • Virtual Environments
  • Install MCS
  • Download Unity Release
  • MCS Configuration File
  • Logging
• Example Usage
  • Using your own config data and/or unity build
  • Run multiple scenes sequentially
  • Run with console logging
  • Initialize logging
  • Run with Human Input
• Python API
  • Action
  • Controller
  • GoalCategory
  • GoalMetadata
  • Material
  • ObjectMetadata
  • ReturnStatus
  • Reward
  • SerializerMsgPack
  • StepMetadata
  • Stringifier
  • UnityExecutableProvider
  • change_config()
  • create_controller()
  • get_controller()
  • get_controller_with_timeout()
  • init_logging()
  • load_scene_json_file()
• Example Scenes
  • Interactive Scenes
  • Passive Agent Scenes
  • Passive Physics Scenes
  • Simple Scenes
• Scene File Schema
  • Scenes
  • Object List
  • Material List
  • Agent Settings
  • Agent Actions
• Adding 3D Models
  • Limitations
  • 1. Download and Open MCS in the Unity Editor
  • 2. Import Your Models into Unity and Save Them as Prefabs
  • 3. Update Your Prefabs in Unity
  • 4. Update the Object Registry File
  • 5. Manually Test and Verify Your Objects
  • 6. Build Unity
  • 7. Update the Scene Generator
  • 8. Submit a Pull Request
  • Troubleshooting
• Containerization
  • GPU Image
  • CPU Image
• Running Remotely
  • Remote Cache Addressables Script
  • Remote Runs on AWS
• Package Developer Notes
  • Package Installation
  • Linting
  • Testing
  • Sphinx Documentation
  • Python Style Guide
  • Running
  • Making GIFs
  • Testing TopDown Plots
  • More Config Options
  • Handling Pull Requests From Contributors
  • Releases
  • Depth Map Data