Files
ktransformers/archive
Jiaqi Liao 57d14d22bc Refactor: restructure repository to focus on kt-kernel and KT-SFT modulesq recon (#1581)
* refactor: move legacy code to archive/ directory

  - Moved ktransformers, csrc, third_party, merge_tensors to archive/
  - Moved build scripts and configurations to archive/
  - Kept kt-kernel, KT-SFT, doc, and README files in root
  - Preserved complete git history for all moved files

* refactor: restructure repository to focus on kt-kernel and KT-SFT modules

* fix README

* fix README

* fix README

* fix README

* docs: add performance benchmarks to kt-kernel section

Add comprehensive performance data for kt-kernel to match KT-SFT's presentation:
- AMX kernel optimization: 21.3 TFLOPS (3.9× faster than PyTorch)
- Prefill phase: up to 20× speedup vs baseline
- Decode phase: up to 4× speedup
- NUMA optimization: up to 63% throughput improvement
- Multi-GPU (8×L20): 227.85 tokens/s total throughput with DeepSeek-R1 FP8

Source: https://lmsys.org/blog/2025-10-22-KTransformers/

This provides users with concrete performance metrics for both core modules,
making it easier to understand the capabilities of each component.

* refactor: improve kt-kernel performance data with specific hardware and models

Replace generic performance descriptions with concrete benchmarks:
- Specify exact hardware: 8×L20 GPU + Xeon Gold 6454S, Single/Dual-socket Xeon + AMX
- Include specific models: DeepSeek-R1-0528 (FP8), DeepSeek-V3 (671B)
- Show detailed metrics: total throughput, output throughput, concurrency details
- Match KT-SFT presentation style for consistency

This provides users with actionable performance data they can use to evaluate
hardware requirements and expected performance for their use cases.

* fix README

* docs: clean up performance table and improve formatting

* add pic for README

* refactor: simplify .gitmodules and backup legacy submodules

- Remove 7 legacy submodules from root .gitmodules (archive/third_party/*)
- Keep only 2 active submodules for kt-kernel (llama.cpp, pybind11)
- Backup complete .gitmodules to archive/.gitmodules
- Add documentation in archive/README.md for researchers who need legacy submodules

This reduces initial clone size by ~500MB and avoids downloading unused dependencies.

* refactor: move doc/ back to root directory

Keep documentation in root for easier access and maintenance.

* refactor: consolidate all images to doc/assets/

- Move kt-kernel/assets/heterogeneous_computing.png to doc/assets/
- Remove KT-SFT/assets/ (images already in doc/assets/)
- Update KT-SFT/README.md image references to ../doc/assets/
- Eliminates ~7.9MB image duplication
- Centralizes all documentation assets in one location

* fix pic path for README
2025-11-10 17:42:26 +08:00
..

Archive - Legacy KTransformers Code

This directory contains the original integrated KTransformers framework code that has been archived as part of the repository restructuring.

📋 What's Here

This archive preserves the complete original KTransformers implementation, including:

  • Core Framework (ktransformers/): Original integrated inference framework
  • C/C++ Extensions (csrc/): Low-level kernel implementations
  • Third-party Dependencies (third_party/): Vendored external libraries
  • Git Submodules (.gitmodules): Complete submodule configuration for legacy dependencies
  • Build System: Installation scripts, Dockerfiles, and configuration files
  • Legacy Documentation: Original README files with full quick-start guides

📚 Documentation

Original README Files

  • English README (Legacy): Complete original English documentation with:

    • Quick Start guides
    • Show cases and benchmarks
    • Injection tutorial
    • Full installation instructions
  • 中文 README (Legacy): 完整的原始中文文档,包含:

    • 快速入门指南
    • 案例展示和基准测试
    • 注入教程
    • 完整安装说明

🔄 Migration to New Structure

The KTransformers project has evolved into two focused modules:

For Inference (CPU-optimized kernels):

→ Use kt-kernel instead

For Fine-tuning (LLaMA-Factory integration):

→ Use KT-SFT instead

⚠️ Status

This code is archived for reference only. For active development and support:

🔧 Git Submodules (For Researchers)

The root .gitmodules only contains kt-kernel's dependencies to keep the repository lightweight. If you need to build the legacy code, you can use the archived submodule configuration:

# Copy the complete submodule configuration
cp archive/.gitmodules .gitmodules

# Initialize legacy submodules
git submodule update --init --recursive archive/third_party/

Note: This will download ~500MB of additional dependencies.

📦 Contents Overview

archive/
├── README.md              # This file
├── README_LEGACY.md       # Original English documentation
├── README_ZH_LEGACY.md    # Original Chinese documentation
├── .gitmodules            # Complete git submodule configuration (7 legacy submodules)
├── ktransformers/         # Original framework code
├── csrc/                  # C/C++ extensions
├── third_party/           # External dependencies (submodules not initialized by default)
├── setup.py               # Original installation script
├── pyproject.toml         # Python project configuration
├── Dockerfile*            # Container configurations
├── install*.sh            # Installation scripts
└── ...                    # Other legacy files

💡 Why Archived?

The original monolithic framework has been refactored into modular components for:

  1. Better Maintainability: Separated concerns between inference and fine-tuning
  2. Easier Integration: Cleaner APIs for external frameworks (SGLang, LLaMA-Factory)
  3. Focused Development: Dedicated modules with specific optimization goals
  4. Reduced Complexity: Smaller, more manageable codebases

Archived on 2025-11 as part of repository restructuring