MLC-MiniCPM 安装与使用教程

1. 项目目录结构及介绍

MLC-MiniCPM 的目录结构如下：

.
├── android          # Android 应用程序相关代码
├── assets           # 应用资源文件
├── ci                # 持续集成配置
├── cmake             # CMake 相关文件
├── cpp               # C++ 代码库
├── docs              # 文档
├── examples          # 示例代码
├── ios               # iOS 应用程序相关代码
├── mlc_llm           # 主要模型代码
├── python            # Python 代码
├── rust              # Rust 代码
├── scripts           # 脚本
├── site              # 网站源码
├── tests             # 测试代码
├── THIRDPARTY        # 第三方库
├── clang-format      # Clang 格式化工具
├── .gitignore        # Git 忽略规则
├── .gitmodules       # 子模组配置
├── CMakeLists.txt    # CMake 构建脚本
├── CONTRIBUTORS.md   # 贡献者列表
├── LICENSE           # 许可证文件
├── README-ZH.md      # 中文阅读指南
├── README.md         # 英文阅读指南
├── build.py          # 构建脚本
├── pyproject.toml    # Python 项目配置
├── setup.py          # Python 包安装脚本
└── version.py        # 版本信息

• android: 包含 Android 平台上的应用程序代码。
• cpp, python, rust: 各种语言实现的模型处理和接口层代码。
• ci, cmake, scripts: 构建与测试相关的自动化脚本和配置。
• mlc_llm: MiniCPM 和 MiniCPM-V 的核心算法实现。
• examples: 示例代码，展示如何使用 MiniCPM。
• tests: 测试用例，验证功能正确性。
• THIRDPARTY: 依赖的第三方库。
• README*: 项目说明文档。

2. 项目启动文件介绍

对于 Android 应用，启动文件通常位于 android/app/src/main/java/com/mlc/ai/mlc_llm/MainActivity.java。该文件是应用的主要入口点，负责初始化和显示 UI，以及调用模型进行预测。用户在安装并运行 APK 文件后，此文件将被系统自动加载执行。

对于其他平台如 iOS 或 Python 环境，启动文件会有所不同。例如，在 Python 中，可能有一个 main.py 文件作为程序的起点，用于设置模型、读取输入和输出结果。

3. 项目的配置文件介绍

mlc_chat/config.json 是一个示例配置文件，用于定义模型类型、量化方式以及其他参数。在实际部署或使用模型之前，您可能需要根据目标环境调整这个配置文件。以下是配置文件的关键部分：

{
  "model_type": "minicpm",
  "model_name": "MiniCPM-HF",
  "quantization": "q4f16_1",
  "conv_template": "LM",
  "sliding_window_size": 768,
  // 其他模型特定或环境特定的配置...
}

• model_type: 模型类型，如 minicpm 或 minicpm_v。
• model_name: 模型的名称，通常对应存储模型的目录。
• quantization: 模型的量化方式，影响模型大小和性能。
• conv_template: 前向计算模板。
• sliding_window_size: 滑动窗口大小，用于处理长文本输入。

在部署到不同设备或者更改模型参数时，需要根据实际情况修改这些配置项。还可以通过命令行工具 mlc_chat gen_config 来自动生成配置文件。

请注意，实际项目中的配置文件可能会有更多细节或特定于平台的设置。确保查看项目文档以获取完整信息。