# FastModelAPI

**Repository Path**: heyuanqing007/FastModelAPI

## Basic Information

- **Project Name**: FastModelAPI
- **Description**: Quickly publish your model as a web service
- **Primary Language**: Python
- **License**: GPL-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2024-04-09
- **Last Updated**: 2025-08-07

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# FastModelAPI

FastModelAPI 是一个基于 FastAPI 框架开发的工具，旨在简化模型发布为 Web 服务的过程。通过提供的 API 接口，您可以轻松实现模型的数据准备、模型配置以及模型调用。本 README 将详细介绍其功能、使用方法及接口说明。

## 功能概述

### 1. **模型管理**
- **模型列表加载**：服务启动时自动从 `MODEL_LIST.json` 加载模型列表。
- **模型初始化**：通过指定模型名称，初始化对应的模型配置。
- **模型运行**：提供参数，异步执行模型运行。

### 2. **文件操作**
- **文件上传**：支持上传文件至指定（或默认）目录。
- **文件下载**：根据文件路径和可选的存储目录下载文件。
- **文件删除**：删除指定路径和目录下的文件。

### 3. **数据信息查询**
- **数据信息检索**：查询指定文件夹内数据的详细信息。

### 4. **辅助功能**
- **日志记录**：内置日志模块，记录关键操作信息。
- **跨域支持**：启用 CORS 中间件，支持所有来源的跨域请求。
- **异常处理**：对常见错误场景进行捕获并返回清晰的 HTTP 错误响应。

## 使用指南

### 1. **安装与运行**

确保已安装 FastAPI 相关依赖库。然后，直接运行主程序：
bash 
python main.py

服务启动后，模型服务将监听在 `127.0.0.1:8000` 端口（替换为自己的IP地址）。

### 2. **模型列表加载**

在服务启动时，FastModelAPI 会自动从 `MODEL_LIST.json` 文件加载模型列表。您应确保此文件存在于项目根目录，并按照规定的格式提供模型配置信息。

### 3. **模型部署**

#### **模型初始化**

通过发送 GET 请求至 `/initialize-model/{model_name}` 初始化模型配置：

bash
curl -X GET "http://127.0.0.1:8000/initialize-model/{your_model_name}"

#### **模型运行**

准备模型运行所需参数，以 JSON 格式发送 POST 请求至 `/run-model`：

bash 
curl -X POST "http://127.0.0.1:8000/run-model" -H "Content-Type: application/json" -d '{"param1": "value1", "param2": "value2"}'

### 4. **文件操作**

#### **文件上传**

使用 `multipart/form-data` 格式上传文件：

bash 
curl -X POST "http://localhost:8000/upload-file/" -F "file=@local_filepath;type=application/octet-stream" -F "custom_upload_dir=optional_directory"

#### **文件下载**

访问下载链接，可选地提供 `file_dir` 查询参数：

bash 
curl -OJ "http://127.0.0.1:8000/download-file/output.txt?file_dir=output"

#### **文件删除**

发送 GET 请求至相应 API 端点：

bash 
curl -X GET "http://127.0.0.1:8000/delete-file/output.txt?file_dir=output"

### 5. **数据信息查询**

查询指定文件夹下的数据信息：
bash 
curl -X GET "http://127.0.0.1:8000/get-data-info/folder_name"

至此，您已了解如何使用 FastModelAPI 快速部署模型服务以及进行文件操作。请根据实际需求调整配置并利用提供的接口进行模型管理和数据交互。如果您在使用过程中遇到任何问题，欢迎查阅文档或提交 issue。

---

**注意：** 本 README 示例中的 API 地址、端口及路径仅供参考，请根据实际部署情况进行调整。同时，请确保遵守相关法律法规及数据安全要求，在合法合规的前提下使用 FastModelAPI。