README.md

Kronos API 服务

本项目为 Kronos 金融预测模型提供了一个独立的、容器化的 API 服务。它经过优化，可部署在 Hugging Face Spaces 或任何其他支持 Docker 的云环境中。

功能特性

• 纯 API 服务: 无前端界面，专注于性能和集成。
• 灵活的数据输入: 通过 API 直接接受标准的 K 线数据格式（数组的数组）。
• 安全: API 端点受持有者令牌（Bearer Token）认证保护。
• 容器化: 使用 Docker 轻松部署和扩展。

开始使用

1. 本地开发与测试

您可以使用 Docker Compose 在本地运行此服务。

先决条件:

• 已安装 Docker 和 Docker Compose。

步骤:

1. 进入 kronos-api-service 目录：

   cd kronos-api-service
   

2. 启动服务：

   docker-compose up --build
   

   服务将在 http://localhost:7860 上可用。用于本地测试的 API 密钥在 docker-compose.yml 文件中定义（默认为 my-secret-local-key）。

2. 部署到 Hugging Face Spaces

该服务旨在轻松部署到 Hugging Face Space。

步骤:

1. 在 Hugging Face 上创建一个新的 Docker Space。
2. 在您的 Space 设置中，进入 Secrets 并添加一个新的密钥：
   • 名称: KRONOS_API_KEY
   • 值: your_super_secret_api_key (请替换为您自己的强密钥)
3. 将 kronos-api-service 目录下的所有内容推送到您的 Space Git 仓库的根目录。您的 Space 仓库结构应如下所示：

   .
   ├── app.py
   ├── Dockerfile
   ├── requirements.txt
   ├── model/
   │   ├── __init__.py
   │   ├── kronos.py
   │   └── module.py
   └── ... (此项目中的所有其他文件)
   

4. Hugging Face Spaces 将自动从您的 Dockerfile 构建镜像并启动服务。您的 API 将在 Space 提供的 URL 上线。

API 使用方法

有关端点、请求/响应格式和示例的详细信息，请参阅详细的 API.md 文档。