Felafax 项目使用教程

Felafax 项目使用教程

felafax Felafax is building AI infra for non-NVIDIA GPUs 项目地址: https://gitcode.com/gh_mirrors/fe/felafax

1. 项目的目录结构及介绍

Felafax 项目是一个用于在非NVIDIA GPU硬件（如TPU、AWS Trainium、AMD GPU和Intel GPU）上运行AI工作负载的开源框架。以下是项目的目录结构及其简单介绍：

felafax/
│
├── .vscode/             # Visual Studio Code 项目设置
├── assets/              # 存储项目相关资源
├── notebooks/           # Jupyter 笔记本文件
├── scripts/             # 脚本文件，包含项目启动和配置脚本
├── src/                 # 源代码目录
│   └── felafax/         # Felafax 模块源代码
├── tests/               # 单元测试文件
├── trainers/            # 训练器相关代码
├── ~archive/            # 存档文件
├── .gitignore           # Git 忽略文件
├── LICENSE              # 项目许可证文件
├── README.md            # 项目说明文件
├── pyproject.toml       # Python 项目配置文件
├── requirements.txt     # 项目依赖文件
└── ...

2. 项目的启动文件介绍

项目的启动主要通过Felafax CLI来完成。首先需要安装CLI并认证：

pip install pipx
pipx install felafax-cli

然后生成一个认证令牌并登录：

# 访问 preview.felafax.ai 创建账户并生成令牌
# 使用令牌登录CLI
felafax-cli auth login --token <your_token>

启动CLI后，可以使用以下命令进行模型的训练：

# 列出可用的基础模型
felafax-cli tune start --help

# 开始一个训练任务
felafax-cli tune start --model <your_selected_model> --config ./config.yml --hf-dataset-id <your_hf_dataset_name>

3. 项目的配置文件介绍

项目的配置文件主要是config.yml，它包含了一系列用于调整训练过程的参数。配置文件可以通过以下命令生成：

felafax-cli tune init-config

配置文件中可能包含以下参数：

• HuggingFace：提供HuggingFace的token和仓库ID以便上传训练好的模型。
• dataset：数据集配置，包括batch_size和max_seq_length等。
• training：训练参数，如num_steps、learning_rate和lora_rank等。
• evaluation：评估间隔eval_interval。

配置文件的一个简单示例：

HuggingFace:
  token: <your_hf_token>
  repo_id: <your_hf_repo_id>
dataset:
  batch_size: 32
  max_seq_length: 512
training:
  num_steps: null
  learning_rate: 0.001
  lora_rank: 4
evaluation:
  eval_interval: 100

通过调整这些参数，用户可以自定义训练过程以满足自己的需求。

felafax Felafax is building AI infra for non-NVIDIA GPUs 项目地址: https://gitcode.com/gh_mirrors/fe/felafax