Skip to content

quickstart.md

Latest commit

 

History

History
50 lines (37 loc) · 930 Bytes

quickstart.md

File metadata and controls

50 lines (37 loc) · 930 Bytes
Raw

Quickstart

Get a QuinkGL swarm running in under five minutes.

Install

pip install quinkgl

Create a Manifest

quinkgl manifest create \
  --name demo \
  --task-type class \
  --input-shape 3,224,224 \
  --output-shape 10 \
  --label-type integer \
  --model-framework pytorch \
  --model-arch-hash sha256:7f2c1a9b3e4d0123456789abcdef0123456789abcdef0123456789abcdef0123 \
  --aggregation FedAvg \
  --topology Random \
  --output demo.qgl

Verify

quinkgl manifest verify demo.qgl

Scaffold a Peer

quinkgl init --output-dir my-peer --template minimal --manifest demo.qgl
cd my-peer

Run (Dry Mode)

quinkgl run --manifest demo.qgl --dry-run

Next Steps