Welcome to MMSegmenation’s documentation!

Get Started

• Prerequisites
• Installation
  • A from-scratch setup script
• Verification

Dataset Preparation

• Prepare datasets

Model Zoo

• Benchmark and Model Zoo
• Model Zoo Statistics

Quick Run

• Train a model
  • Train with a single GPU
  • Train with multiple GPUs
  • Train with multiple machines
  • Launch multiple jobs on a single machine
• Inference with pretrained models
  • Test a dataset

Tutorials

• Tutorial 1: Learn about Configs
  • Config File Structure
  • Config Name Style
  • An Example of PSPNet
  • FAQ
• Tutorial 2: Customize Datasets
  • Customize datasets by reorganizing data
  • Customize datasets by mixing dataset
• Tutorial 3: Customize Data Pipelines
  • Design of Data pipelines
  • Extend and use custom pipelines
• Tutorial 4: Customize Models
  • Customize optimizer
  • Customize optimizer constructor
  • Develop new components
• Tutorial 5: Training Tricks
  • Different Learning Rate(LR) for Backbone and Heads
  • Online Hard Example Mining (OHEM)
  • Class Balanced Loss
• Tutorial 6: Customize Runtime Settings
  • Customize optimization settings
  • Customize training schedules
  • Customize workflow
  • Customize hooks

Useful Tools and Scripts

• Get the FLOPs and params (experimental)
• Publish a model
• Convert to ONNX (experimental)
• Miscellaneous
  • Print the entire config

Notes

• Changelog
  • V0.10 (01/01/2021)
  • V0.9 (30/11/2020)
  • V0.8 (03/11/2020)
  • V0.7 (07/10/2020)
  • V0.6 (10/09/2020)
  • v0.5.1 (11/08/2020)

API Reference

• API Reference
  • mmseg.apis
  • mmseg.core
    • seg
    • evaluation
    • utils
  • mmseg.datasets
    • datasets
    • pipelines
  • mmseg.models
    • segmentors
    • backbones
    • decode_heads
    • losses

Indices and tables

• Index
• Search Page