Go to file
ViperEkura 780b9e1855 fix: 修复参数传递问题 2026-03-31 01:23:29 +08:00
.github/workflows style: 使用ruff 工具优化代码风格 2026-03-30 23:32:28 +08:00
assets chore: 简化格式并更新文档 2026-03-31 00:28:58 +08:00
demo chore: 简化格式并更新文档 2026-03-31 00:28:58 +08:00
khaosz fix: 修复参数传递问题 2026-03-31 01:23:29 +08:00
tests style: 使用ruff 工具优化代码风格 2026-03-30 23:32:28 +08:00
tools style: 使用ruff 工具优化代码风格 2026-03-30 23:32:28 +08:00
.gitignore style: 使用ruff 工具优化代码风格 2026-03-30 23:32:28 +08:00
LICENSE Change license from Apache 2.0 to GPL v3.0 2026-02-22 21:20:34 +08:00
README.md docs: 更新README 2026-03-31 00:50:01 +08:00
pyproject.toml style: 使用ruff 工具优化代码风格 2026-03-30 23:32:28 +08:00

README.md

Logo

KHAOSZ

A lightweight Transformer training & inference framework

📖 Table of Contents | 目录

English
中文

English

Features

  • 🚀 High Performance: Optimized for both training and inference
  • 🔧 Flexible: Support for seq/sft/dpo training
  • 💡 Easy to Use: Simple API with comprehensive examples
  • 📦 Lightweight: Minimal dependencies

Installation

git clone https://github.com/username/khaosz.git
cd khaosz
pip install -e .

Quick Start

# Train
python tools/train.py \
  --train_type=seq \
  --data_root_path=/path/to/dataset \
  --param_path=/path/to/param_path

# Generate
python tools/generate.py --param_path=/path/to/param_path

Demo

# run download before using
python demo/download.py

# run demo
python demo/stream_chat.py
python demo/generate_batch.py
python demo/generate_ar.py

中文

特性

  • 🚀 高性能: 训练与推理双向优化
  • 🔧 灵活: 支持 seq/sft/dpo 多种训练方式
  • 💡 易用: 简洁的 API 与丰富的示例
  • 📦 轻量: 依赖少,部署简单

安装

git clone https://github.com/username/khaosz.git
cd khaosz
pip install -e .

快速开始

# 训练
python tools/train.py \
  --train_type=seq \
  --data_root_path=/path/to/dataset \
  --param_path=/path/to/param_path

# 生成
python tools/generate.py --param_path=/path/to/param_path

演示

# 使用前先下载模型
python demo/download.py

# 运行示例
python demo/stream_chat.py
python demo/generate_batch.py
python demo/generate_ar.py

Document | 文档

Document Description
Parameter Guide
参数说明
Training & inference parameters
训练与推理参数配置
Design Document
设计文档
Framework architecture & module design
系统架构与模块设计
Data Flow
数据流程
Data processing pipeline details
数据处理管道详解
Model Introduction
模型介绍
Model architecture & technical details
模型架构与技术细节

Download | 下载

Lincence | 许可证