Welcome to COALA’s documentation!

Introduction

• Introduction

• Prerequisites
• Installation
  • Prepare environment
  • Install COALA
  • A from-scratch setup script
• Verification

Quick Run

• Examples
• High-level Introduction
• Simplest Run
• Run with Configurations

Tutorials

• Tutorial 1: High-level APIs
  • Standalone Training Example
• Tutorial 2: Configurations
  • Modify Config
  • A Common Practice to Modify Configuration
  • Default Configurations
• Tutorial 3: Datasets
  • Out-of-the-box Datasets
  • Customize Datasets
• Tutorial 4: Models
  • Out-of-the-box Models
  • Customized Models
• Tutorial 5: Customize Server and Client
  • Customize Server
  • Customize Client
  • Existing Works
• Tutorial 6: Distributed Training
  • Distributed Training with Pytorch Multiprocessing
  • Distributed Training with Slurm

Notes

• Changelog
  • v1.0.0 (25/07/2024)

API Reference

• coala
• coala.server
• coala.client
• coala.distributed
• coala.dataset
• coala.models

Indices and tables

• Index

• Search Page