bumblecore - GitLite

KO | EN

gitlite — search

#python #react #ai #go #golang #android #rust #deep-learning #macos #nodejs #cli #kubernetes #vue #pytorch

bumblecore

(★ 101)

An LLM training framework built from the ground up, featuring a custom BumbleBee architecture and end-to-end support for multiple open-source models across Pretraining → SFT → RLHF/DPO.

File Explorer

Download Latest Version (.zip)

- - bug_report.md
  - custom.md
  - feature_request.md
- CODE_OF_CONDUCT.md
- CONTRIBUTING.md
- PULL_REQUEST_TEMPLATE.md
- SECURITY.md
- - dpo_training_loss.png
  - dpo_training_rewards_accuracies.png
  - pretrain_training_loss.png
  - sft_training_loss.png
- bumblechat.png
- bumblecore.jpg
- - ds_z0_config.json
  - ds_z1_config.json
  - ds_z2_config.json
  - ds_z3_config.json
- - dpo_full.yaml
  - dpo_lora.yaml
- - bumblechat.yaml
  - chat.yaml
- - pretrain_full.yaml
- - sft_full.yaml
  - sft_lora.yaml
- alpaca_zh_demo.json
- dpo_messages_zh_demo.json
- dpo_zh_demo.json
- duolun_train.json
- glaive_toolcall_zh_demo.json
- messages_zh_demo.json
- pretrain_zh_demo.json
- CONFIG.md
- CONFIG_zh.md
- DATA_FORMAT.md
- DATA_FORMAT_zh.md
- FEATURES.md
- TUTORIAL.md
- TUTORIAL_zh.md
- bumblechat.html
- - config.json
  - generation_config.json
  - tokenizer.json
  - tokenizer_config.json
- bumblechat.sh
- chat.sh
- dpo_full.sh
- dpo_lora.sh
- pretrain.sh
- sft_full.sh
- sft_lora.sh
- - __init__.py
- api.py
- inference.py
- train.py
- conftest.py
- run_test.sh
- merge_lora.py
- run_merge_lora.sh
.gitignore
LICENSE
pyproject.toml
README.md
README_zh.md

# Installation Guide

1. Get the code

git clone https://github.com/wxhcore/bumblecore

Downloads the entire project code from GitHub to your computer.

cd bumblecore

Moves into the project folder you just downloaded.

2. Python

Easy Recommended

Prerequisites

Git Needed to download the project code from GitHub.
Python 3 On Windows, be sure to check 'Add Python to PATH' during installation.

pip install -e .

Installs the Python libraries listed in requirements.txt (or similar).

pip install -e ".[flash-attn]" --no-build-isolation

Installs the Python libraries listed in requirements.txt (or similar).

✅ If it runs without errors and prints output in the terminal, it worked.

Pulled directly from this repo's README.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

<div align="center">

![logo](https://raw.githubusercontent.com/wxhcore/bumblecore/main/assets/bumblecore.jpg)

**小核心，大轰鸣 | Small Core, Big Buzz**

A hands-on large language model training framework built from scratch, giving you complete control over every training detail.  
From model architecture to inference, from distributed training to loss computation—everything is at your fingertips.

[![Python](https://img.shields.io/badge/Python-3.10%2B-blue)](https://www.python.org/)
[![DeepSpeed](https://img.shields.io/badge/DeepSpeed-Enabled-green)](https://github.com/microsoft/DeepSpeed)
[![License](https://img.shields.io/badge/License-Apache%202.0-yellow.svg)](https://opensource.org/licenses/Apache-2.0)

English | [中文文档](./README_zh.md)

</div>

---

## Project Overview

### Core Features

#### 1️⃣ **Fully Manual Training Loop**

BumbleCore doesn't rely on any high-level Trainer libraries—every core component is built from the ground up:

- Custom data loaders and preprocessing pipelines
- Manual distributed training environment configuration with deep DeepSpeed integration
- Fully controllable forward propagation, backward propagation, and parameter update flow
- Flexible loss function implementation with multi-task learning support
- Manually implemented inference generation mechanisms including Top-p, Top-k sampling, and KV Cache

> 💡 **Why Manual Implementation?**  
> Manual implementation allows you to deeply understand the purpose of every line of code, making debugging, optimization, and innovation easier. Whether researching new training strategies or customizing for specific scenarios, BumbleCore provides maximum flexibility.

#### 2️⃣ **Bumblebee Model Architecture: Freely Customize Your Model**

The built-in Bumblebee architecture (inspired by Qwen2.5 design) provides highly flexible configuration capabilities:

- Supports parameter scaling from small experimental models to large-scale production models
- Dynamic adjustment of Transformer layers, attention heads, hidden dimensions, and other architectural parameters
- Customizable activation functions, normalization methods, attention mechanisms, and other components
- Covers the complete training process: Pretraining, Supervised Fine-Tuning (SFT), Direct Preference Optimization (DPO)

> **Use Cases**  
> Want to quickly validate a new model design? Or train a lightweight model for a specific domain? The Bumblebee architecture lets you configure your model and start training in minutes.

#### 3️⃣ **Universal Training Framework: Supporting Mainstream Open-Source Models**

- Compatible with open-source models like Qwen, LLaMA, etc.
- Deep DeepSpeed integration supporting ZeRO optimization and mixed precision training
- Supports full training pipeline: pretraining, continual pretraining, instruction fine-tuning, reinforcement learning (RLHF/DPO)
- Built-in memory optimization techniques including gradient accumulation, gradient checkpointing, and activation recomputation
- Modular design for easy extension of new model architectures and training strategies

### Verified Supported Models

The following model series have been tested and verified by the author to be compatible with BumbleCore:

| Model Series | Verified Stages | Notes |
|--------------|-----------------|-------|
| **Qwen Series** | Pretraining, SFT, DPO | ✅ Fully Tested |
| **LLaMA Series** | Pretraining, SFT, DPO | ✅ Fully Tested |

> 💡 **Note**: Other models with similar architectures should be generally compatible. Users are welcome to test and integrate additional models. If you encounter any compatibility issues, please report them in [Issues](https://github.com/wxhcore/bumblecore/issues).

---

## Design Philosophy

BumbleCore follows three core principles:

1. **Transparency** - Every line of code is clearly visible with no black-box operations
2. **Flexibility** - Everything from data to models, training to inference, is customizable
3. **Efficiency** - Fully leverages tools like DeepSpeed to ensure training efficiency

---

## Who Should Use BumbleCore?

- Deep Learning Researchers: Need deep customization of training processes to validate new algorithms and architectures
- Algorithm Engineers: Want complete control over model training details for performance optimization
- Learners: Want to deeply understand the underlying principles of large language model training
- Enterprise Teams: Need to customize training solutions for specific business scenarios

---

## Installation

### Requirements

- Python >= 3.10
- Linux Operating System

### Installation Steps

**1. Clone the Repository**

```bash
git clone https://github.com/wxhcore/bumblecore.git
cd bumblecore
```

**2. Create Virtual Environment**

```bash
conda create -n bumblecore_env python=3.10 -y
conda activate bumblecore_env
```

**3. Install Dependencies**

Basic installation:

```bash
pip install -e .
```

Optional FlashAttention-2 installation:

```bash
pip install -e ".[flash-attn]" --no-build-isolation
```

---

## Data Preparation

BumbleCore supports different data formats for three training stages. All formats support both JSON and JSONL, with automatic recognition.

### Supported Formats

| Training Stage | Data Format | 
|---------------|-------------|
| **Pretraining** | `{"text": "..."}` |
| **SFT** | Alpaca / ShareGPT / Messages (OpenAI-style, supports tool calling) | 
| **DPO** | Alpaca / ShareGPT / Messages (with chosen/rejected, supports full tool trajectories) |

### Data Examples

SFT Alpaca format:

```json
{
  "instruction": "Explain what machine learning is",
  "input": "",
  "output": "Machine learning is a branch of artificial intelligence..."
}
```

**[View Complete Data Format Documentation →](./docs/DATA_FORMAT.md)**

---

## Configuration Guide

### Bumblebee Model Configuration

BumbleCore provides multiple model scale configurations from 0.5B to 72B:

| Field | 0.5B | 1.5B | 3B | 7B | 14B | 32B | 72B |
|------|------|------|----|----|-----|-----|-----|
| **hidden_size** | 896 | 1536 | 2048 | 3584 | 5120 | 5120 | 8192 |
| **intermediate_size** | 4864 | 8960 | 11008 | 18944 | 13824 | 27648 | 29568 |
| **num_attention_heads** | 14 | 12 | 16 | 28 | 40 | 40 | 64 |
| **num_hidden_layers** | 24 | 28 | 36 | 28 | 48 | 64 | 80 |
| **num_key_value_heads** | 2 | 2 | 2 | 4 | 8 | 8 | 8 |
| **tie_word_embeddings** | true | true | true | false | false | false | false |
| **vocab_size** | 151936 | 151936 | 151936 | 152064 | 152064 | 152064 | 152064 |

Configuration file location: `./models/bumblebee/config.json/`

### Training Parameters Configuration

**[View Complete Configuration Parameters Documentation →](./docs/CONFIG.md)**

---

## 🚀 Quick Start

BumbleCore supports flexible configuration methods. Here's an example using SFT (Supervised Fine-Tuning).

Configuration priority: Command-line arguments > YAML config file > TrainConfig defaults

### Method 1: Using YAML Configuration File

```bash
deepspeed --include localhost:0,1 src/train.py \
    --yaml_config ./configs/sft/sft_full.yaml
```

### Method 2: Pure Command Line Execution

```bash
deepspeed --include localhost:0,1 src/train.py \
    --training_stage sft \
    --finetuning_type full \
    --model_name_or_path <your model path> \
    --dataset_path <your dataset path> \
    --output_dir <your save path> \
    --num_epochs 3.0 \
    --learning_rate 5e-5 \
    --train_micro_batch_size_per_gpu 4 \
    --gradient_accumulation_steps 4 \
    --train_model_precision bf16 \
    --deepspeed_config_path ./configs/deepspeed/ds_z2_config.json
```

### Method 3: Command Line Override YAML Configuration

```bash
deepspeed --include localhost:0,1 src/train.py \
    --yaml_config ./configs/sft/sft_lora.yaml \
    --learning_rate 1e-4
```

### Using Shell Scripts

All three methods above can be written as shell scripts for easier management and reuse.

BumbleCore provides pre-configured training scripts in the `scripts/` directory.

**Usage Steps**:

1. Edit the script to modify model paths, dataset paths, and other parameters
2. Execute the script to start training

```bash
bash scripts/sft_full.sh
```

---

## Three-Stage Complete Training Experiment

Provides a complete tutorial for training a language model from scratch, covering pretraining, supervised fine-tuning, and preference optimization.

### Experiment Configuration

| Stage | Dataset | Scale | Output |
|-------|---------|-------|--------|
| **Pretraining** | [mini_pretrain_dataset](https://www.modelscope.cn/datasets/BazingaLyn/mini_pretrain_dataset) | 1B tokens | Base model |
| **Supervised Fine-tuning** | [alpaca_gpt4_zh](https://huggingface.co/datasets/llamafactory/alpaca_gpt4_zh) | 42.7K samples | Instruction model |
| **Preference Optimization** | [DPO-En-Zh-20k](https://huggingface.co/datasets/llamafactory/DPO-En-Zh-20k) | 10K samples (zh) | Aligned model |

**[View Complete Experiment Tutorial →](./docs/TUTORIAL.md)**

---

## LoRA Weight Merging

After training with LoRA, you can merge LoRA weights back into the base model to generate complete model files.

```bash
# Edit tools/run_merge_lora.sh to modify model path parameters then execute
bash tools/run_merge_lora.sh
```

---

## Model Inference

After training, BumbleCore provides flexible inference methods supporting both YAML configuration and command-line arguments.

### Command Line Interactive Chat

Configuration file: `configs/inference/chat.yaml`

```bash
bash scripts/chat.sh
```

### Web Interface (BumbleChat)

Configuration file: `configs/inference/bumblechat.yaml`

```bash
bash scripts/bumblechat.sh
```

![BumbleChat Web Interface](https://raw.githubusercontent.com/wxhcore/bumblecore/main/assets/bumblechat.png)

After the service starts, it supports OpenAI-compatible API calls:

```python
from openai import OpenAI

client = OpenAI(
    base_url="<your service API address>/v1",
    api_key="dummy" 
)

response = client.chat.completions.create(
    model="bumblebee", 
    messages=[
        {"role": "user", "content": "Hello, please introduce yourself"}
    ],
    temperature=0.7,
    max_completion_tokens=2048
)

print(response.choices[0].message.content)
```

---