Welcome to XRMoCap’s documentation!

Getting started

• Installation
  • Requirements
  • A from-scratch setup script
  • Prepare environment
• Dataset preparation
  • Overview
  • Supported datasets
  • Download converted meta-data
  • Convert a dataset manually
  • Validate converted meta-data by visualization
• Getting started
  • Installation
  • Data Preparation
  • Body Model Preparation (Optional)
  • Inference
  • Evaluation
  • Training
  • More Tutorials

Benchmark

• Benchmark and Model Zoo
  • Baselines

Unit tests

• Running Tests
  • Data Preparation
  • Environment Preparation
  • Running tests through pytest

Data structures

• Keypoints
  • Overview
  • Key/Value definition
  • Attribute definition
  • Name convention
  • Create an instance
  • Auto-completion
  • Convert between numpy and torch
  • File IO
  • Keypoints convention
• Limbs
  • Overview
  • Attribute definition
  • Create an instance
• SMPLData
  • Overview
  • Key/Value definition
  • Attribute definition
  • Create an instance
  • Convert into body_model input
  • File IO

Operations

• Triangulation
  • Overview
  • Triangulate points from 2D to 3D

Model

• SMPLify
  • Overview
  • Relationships between classes
  • Build a registrant
  • Prepare the input and run
  • Develop a new loss
  • How to write a config file

Estimation

• Multi-view Single-person SMPL Estimator
  • Overview
  • Arguments
  • Run
  • Example
• Multi-view Multi-person Top-down SMPL Estimator
  • Overview
  • Arguments
  • Run
  • Example

Tools

• Learning-based model evaluation
  • Overview
  • Preparation
• Multi-view Multi-person Evaluation
  • Overview
  • Argument
  • Example
• Multi-view Multi-person SMPLify3D
  • Overview
  • Argument
  • Example
• Tool prepare_dataset
  • Overview
  • Argument: converter_config
  • Argument: overwrite
  • Argument: disable_log_file
  • Argument: paths
  • Examples
• Tool process_smc
  • Overview
  • Argument: estimator_config
  • Argument: output_dir
  • Argument: disable_log_file
  • Argument: frame_file
  • Argument: visualize
  • Example
• Learning-based model training
  • Overview
  • Preparation
  • Example
• Tool visualize_dataset
  • Overview
  • Argument: vis_config
  • Argument: overwrite
  • Argument: disable_log_file
  • Argument: paths
  • Examples

Tutorials

• Introduction
  • Framework
  • File structures
• Learn about Configs
  • Modify config through script arguments
• Add new Datasets
  • Overview
  • Online conversion
  • Offline conversion (recommend)
  • Class data_converter
• Add new module
  • Develop PytorchTriangulator class
  • Build and use

Notes

• Frequently Asked Questions
  • Installation
• Changelog
  • v0.8.0 (05/05/2023/)
  • v0.7.0 (23/12/2022/)
  • v0.6.0 (14/10/2022/)
  • v0.5.0 (01/09/2022/)

License

• LICENSE

APIs

• APIs

API Reference

• xrmocap.core
• xrmocap.data
• xrmocap.data_structure
• xrmocap.human_perception
• xrmocap.io
• xrmocap.model
• xrmocap.ops
• xrmocap.transform
• xrmocap.utils

Indices and tables

• Index

• Search Page