CodeGeeX 快速上手教程（GitHub README 中文整理）

是什么

CodeGeeX 是一个开源的多语言代码生成模型，拥有 130 亿参数，在包含 20 多种编程语言的大规模代码语料上预训练而成。截至 2022 年 6 月，模型已在 1536 块昇腾 910 AI 处理器上训练了超过 8500 亿个 token。

CodeGeeX 支持昇腾和 NVIDIA 两种平台，单张昇腾 910、NVIDIA V100 或 A100 即可完成推理。模型权重和代码均已开源，供研究使用。

能干什么

• 多语言代码生成：支持 Python、C++、Java、JavaScript、Go 等主流语言，能根据注释或函数签名自动生成可执行的代码。
• 跨语言代码翻译：一键将代码片段从一种语言翻译成另一种语言，准确率高。
• 编程助手：免费提供 VS Code 插件，支持代码补全、解释、摘要等功能，提升编码效率。
• 开源跨平台：模型权重和代码全部公开，支持昇腾和 NVIDIA 平台。

怎么装

1. 安装依赖

git clone https://github.com/zai-org/CodeGeeX.git
cd CodeGeeX
pip install -r requirements.txt

2. 获取模型权重

模型权重需申请后下载。访问申请页面：

https://models.aminer.cn/codegeex/download/request

申请通过后，将权重文件放入 models/ 目录。

3. GPU 推理

单卡推理示例（以 NVIDIA V100 为例）：

python scripts/inference.py \
    --model-path models/codegeex_13b.pt \
    --tokenizer-path models/tokenizer \
    --input "def fibonacci(n):" \
    --max-length 128

怎么用：第一个例子

代码生成

在终端运行以下命令，让 CodeGeeX 根据注释生成 Python 代码：

python scripts/inference.py \
    --model-path models/codegeex_13b.pt \
    --tokenizer-path models/tokenizer \
    --input "# 计算斐波那契数列的第 n 项" \
    --max-length 256

模型会输出类似：

def fibonacci(n):
    if n <= 1:
        return n
    return fibonacci(n-1) + fibonacci(n-2)

VS Code 插件

1. 打开 VS Code，在扩展市场搜索 "CodeGeeX" 并安装。
2. 安装后，在代码编辑区输入注释或函数签名，插件会自动弹出补全建议。
3. 按 Tab 接受建议，按 Esc 忽略。

社区资源

• 主页：https://codegeex.cn
• 在线体验：https://models.aminer.cn/codegeex/playground
• 论文：https://arxiv.org/abs/2303.17568
• 最新版 CodeGeeX4：https://github.com/THUDM/CodeGeeX4
• HumanEval-X 基准：包含 820 道人工编写的多语言编程题，支持 Python、C++、Java、JavaScript、Go 五种语言。数据集已上传至 HuggingFace：https://huggingface.co/datasets/THUDM/humaneval-x

翻译整理自 GitHub README，原文：https://github.com/zai-org/CodeGeeX