Swift DOCUMENTATION

Get Started

• SWIFT Installation
  • Wheel Package Installation
  • Source code installation
  • Older Version
  • Mirror
  • Supported Hardware
  • Operating Environment
  • Notebook environment
• Quick Start
  • Install
  • Usage Example
  • Learn More
• Web-UI

Instruction

• Command-line arguments
  • Basic Parameters
  • Atomic Parameters
  • Integration Parameters
  • Specific model parameters
  • Other environment variables
• Pretraining and Fine-tuning
  • Environment Preparation
  • Pretraining
  • Fine-tuning
  • Merge LoRA
  • Inference (Fine-tuned Model)
  • Deployment (Fine-tuned Model)
• Human Alignment
  • Dataset
  • GRPO
  • DPO
  • RM
  • PPO
  • KTO
  • CPO
  • ORPO
  • SimPO
• Inference and Deployment
  • Inference
  • Deploy
• Sampling
  • Capability Introduction
  • Environment Preparation
  • Use PRM and ORM for result filtering
  • Customize PRM or ORM
  • Video Memory Control
  • Actual example
  • Large model distillation sampling
• Evaluation
  • Capability Introduction
  • Environment Preparation
  • Evaluation
  • Custom Evaluation Set
  • Question and Answer format (QA)
• Export
  • Environment Preparation
  • Quantitative Command
• Enhanced Fine-tuning
  • Concept of Reinforcement Fine-tuning
  • When to Use Reinforcement Fine-Tuning
  • The implementation of SWIFT
  • Experimental Results
  • Future Plans
• GRPO
  • Reward function
  • Run script
• Supported Models and Datasets
  • Model
  • Dataset
• Using Tuners
  • Interface List
• Support for Agents
  • Data Preparation
  • Customize Agent Dataset
  • tools field specific format
  • Related training techniques
  • Inference
  • Deploy
• NPU Support
  • Environment Preparation
  • Fine-tuning
  • Inference
  • Deploy
• Push Model
  • Push ModelScope
  • Push to Hugging Face
• ReleaseNote 3.0
  • New Features
  • BreakChange
  • To be completed
• Common Problem Compilation
  • Train
  • Inference
  • Deploy
  • Evaluation

Customization

• Custom Model
  • Model Registration
• Custom Dataset
  • Standard dataset format
  • dataset_info.json
  • Dataset Registration
• Pluginization
  • callback callback
  • Customized loss
  • Customized loss_scale
  • Customized metric
  • Customized optimizer
  • Customized tools
  • Customized tuner
  • PRM
  • ORM

Indices and tables

• Index

• Module Index

• Search Page