内容
# 福维克斯
<p align="center">
<strong>本地优先的边缘人工智能YOLO工作台。</strong>
</p>
<p align="center">
<a href="https://www.buymeacoffee.com/oaslananka">
<img src="https://img.buymeacoffee.com/button-api/?text=Buy%20me%20a%20coffee&emoji=%E2%98%95&slug=oaslananka&button_colour=FFDD00&font_colour=000000&font_family=Arial&outline_colour=000000&coffee_colour=ffffff" alt="给我买杯咖啡" />
</a>
</p>
[](https://github.com/oaslananka/fovux-kit/actions/workflows/ci.yml)
[](https://pypi.org/project/fovux-mcp/)
[](https://www.npmjs.com/package/fovux-mcp)
[](https://marketplace.visualstudio.com/items?itemName=oaslananka.fovuxstudiokit)
[](https://pypi.org/project/fovux-mcp/)
[](https://opensource.org/licenses/Apache-2.0)
## 什么是福维克斯？
福维克斯是一个本地优先的视觉工作台，适用于YOLO数据集、训练、评估、导出和边缘推理。它结合了Python后端包`fovux-mcp` 1.4.0、npm包装器`fovux-mcp` 1.4.0和VS Code伴侣`Fovux Studio` 1.3.0，以简化计算机视觉工程生命周期。
## 为什么开发者使用它
- **本地优先**：不需要托管控制平面。您的数据集和模型完全保留在本地机器或受信任的基础设施上。
- **端到端YOLO生命周期**：从原始图像到优化的ONNX/TensorRT边缘工件，福维克斯管理复杂性。
- **MCP原生自动化**：通过MCP stdio为代理客户端公开工具表面，而Fovux Studio使用单独的本地HTTP/SSE API进行仪表板和受保护的UI工作流。
- **VS Code Studio**：在编辑器中直接进行视觉工作流，以跟踪运行、视觉性能和评估数据集。
- **可复制的本地运行**：一致的配置，您可以共享、比较和审计。
- **导出和边缘推理关注点**：将模型无缝导出到生产就绪的格式。
- **默认隐私优先**：福维克斯不包含隐藏的遥测。
## 60秒快速入门
确保您已安装Python 3.12至3.14。使用`uv`全局安装后端：
```bash
uv tool install fovux-mcp
fovux doctor
```
`fovux-mcp`是Fovux Studio和MCP客户端使用的主要CLI别名。较短的`fovux`别名指向同一个Typer应用程序，用于直接终端使用。
npm用户可以使用`npm install -g fovux-mcp`安装包装器包；它通过`uvx`委托给匹配的Python包。
初始化您的福维克斯环境并启动MCP服务器：
```bash
fovux-mcp serve --http
```
安装VS Code扩展，打开命令面板（`Ctrl+Shift+P`），并输入`Fovux: Start Training...`以开始您的第一个运行。
## 安装
### 使用`uv`（推荐）
```bash
uv tool install fovux-mcp
```
### 使用npm
```bash
npm install -g fovux-mcp
```
### Fovux Studio（VS Code扩展）
在VS Code市场或Open VSX中搜索**Fovux Studio**，或通过CLI安装：
```bash
code --install-extension oaslananka.fovuxstudiokit
```
## MCP客户端配置
要将MCP桌面客户端连接到福维克斯，请在MCP客户端配置（`mcp_config.json`）中添加以下内容：
```json
{
"mcpServers": {
"fovux": {
"command": "fovux-mcp",
"args": ["serve"]
}
}
}
```
## Fovux Studio
Fovux Studio在VS Code中为您的福维克斯环境提供了一个视觉层：
- **运行仪表板**：实时监控训练指标、GPU使用情况和纪元进度。
- **数据集检查器**：分析您的YOLO注释并定位缺失的标签。
- **导出向导**：将您的模型转换为ONNX、TensorRT或TFLite，并具有最佳形状。
- **时间线和比较**：区分您的运行以了解回归或进度。
使用VS Code命令面板（`Cmd/Ctrl+Shift+P`）并输入`Fovux:`以发现可用的命令。
## 核心工具
Fovux MCP 1.4.0公开了47种本地工具，涵盖数据集检查、验证、主动学习、训练、评估、导出、量化、推理、基准测试、运行管理、策略/审计和支持包工作流程。
生成的完整工具列表位于[`fovux-mcp/README.md`](fovux-mcp/README.md)和MkDocs站点；如果注册的工具缺少文档、模式快照、策略元数据、Studio映射或MkDocs导航，则CI现在会失败。
## 架构
福维克斯将关注点分为三个核心组件：
1. **福维克斯核心**：与YOLO和本地硬件交互的底层Python引擎。
2. **福维克斯MCP服务器**：stdio MCP服务器，将福维克斯核心公开给AI代理，以及Fovux Studio本地API/自定义REST + SSE桥接器，由Fovux Studio使用。标准的Streamable HTTP MCP端点在`v1.4.0 - MCP Conformance & Agent Safety`里程碑中单独跟踪。
3. **福维克斯工作室**：用于人类交互的React/TypeScript VS Code扩展。
[在文档中了解更多关于架构的信息](docs/architecture.md)
## 安全性和隐私
福维克斯是为企业隐私而构建的。**默认情况下不会收集任何遥测数据。** 数据将完全保留在您放置的位置，除非您显式配置第三方集成（例如W&B），否则不会将分析数据发送到外部服务。
## CI/CD和发布模型
福维克斯在这个仓库中维护一个安全的GitHub Actions发布模型：
- `oaslananka/fovux-kit`：代码、问题、拉取请求、CI和发布的源头。
- `.github/workflows`：活跃的CI、安全、发布和注册表发布工作流程。
- 保护的GitHub环境控制PyPI、npm、市场和Open VSX发布。
所有发布版本均由Conventional Commits创建，由CI发布，由GitHub Actions发布，包含校验和、SBOM和出处。
## 仓库操作
仓库操作、运行时兼容性、分支保护、开发者引导和发布流程在[docs/repository-operations.md](docs/repository-operations.md)、
[docs/runtime-compatibility.md](docs/runtime-compatibility.md)、
[docs/development.md](docs/development.md)、
[docs/branch-protection.md](docs/branch-protection.md)和
[docs/release-process.md](docs/release-process.md)中有所记录。本地环境变量名称在
[`.env.example`](.env.example)中列出；发布凭证保留在受保护的GitHub Actions秘密中。
对于Linux/macOS上的全新开发检查：
```bash
scripts/bootstrap-dev.sh --install-deps --hooks
task ci
```
## 路线图
- `v1.3.1 - 稳定化和文档真相`：文档漂移、本地DX、注册表验证、发布元数据和快速失败质量门控。
- `v1.4.0 - MCP一致性和代理安全`：官方MCP传输决策、一致性测试、模式快照和代理批准安全。
- `v1.5.0 - 工作室工作流和数据集智能`：引导数据集→训练→评估→导出工作流和工作室端到端烟雾覆盖。
- `v1.6.0 - 边缘导出和部署智能`：当前导出矩阵、目标配置文件、基准可复制性和量化工作流。
- `v2.0.0 - 可扩展性、供应链和生态系统准备`：插件/API稳定性、可信发布、证明、威胁模型和市场发布证据。
## 贡献
我们欢迎贡献！请阅读我们的[贡献指南](CONTRIBUTING.md)以开始。
## 许可证
福维克斯在[Apache-2.0许可证](LICENSE)下发布。
