ubuntu_osworld_file_cache

# OSWorld File Cache

This repository serves as a file cache for the [OSWorld](https://github.com/xlang-ai/OSWorld) project, providing reliable and fast access to evaluation files that were previously hosted on Google Drive.

## Overview

OSWorld is a scalable, real computer environment for multimodal agents, supporting task setup, execution-based evaluation, and interactive learning across various operating systems and applications. This cache repository ensures that all evaluation files are consistently accessible for research and development purposes.

## Repository Structure

The files are organized by application categories, mirroring the structure of the original OSWorld evaluation examples:

```
├── chrome/ # Chrome browser evaluation files
├── firefox/ # Firefox browser evaluation files
├── gimp/ # GIMP image editor evaluation files
├── libreoffice_calc/ # LibreOffice Calc spreadsheet files
├── libreoffice_impress/ # LibreOffice Impress presentation files
├── libreoffice_writer/ # LibreOffice Writer document files
├── multi_apps/ # Multi-application evaluation files
├── thunderbird/ # Thunderbird email client files
├── vscode/ # Visual Studio Code editor files
└── ... # Other application categories
```

Each application folder contains subfolders named after specific evaluation scenarios, with the actual files (images, documents, datasets, etc.) used in those evaluations.

## Usage

### Direct File Access

Files can be accessed directly via their URLs in the format:
```
https://huggingface.co/datasets/xlangai/ubuntu_osworld_file_cache/resolve/main/{app_name}/{scenario_id}/{filename}
```

### Integration with OSWorld

This cache is automatically integrated with OSWorld evaluation scripts. The original Google Drive URLs in the evaluation JSON files have been migrated to point to this HuggingFace cache, ensuring:

- **Reliability**: No more broken or inaccessible Google Drive links
- **Performance**: Faster download speeds and better availability
- **Consistency**: Stable file versions for reproducible research

### Programmatic Access

You can use the HuggingFace Hub library to access files programmatically:

from huggingface_hub import hf_hub_download

# Download a specific file
```
file_path = hf_hub_download(
repo_id="xlangai/ubuntu_osworld_file_cache",
filename="chrome/scenario_123/test_image.png",
repo_type="dataset"
)
```

## File Types

This cache contains various types of files used in OSWorld evaluations:

- **Images**: Screenshots, reference images, icons (PNG, JPG, GIF, etc.)
- **Documents**: Text files, PDFs, spreadsheets, presentations
- **Media**: Audio and video files for multimedia evaluations
- **Data**: CSV files, JSON configurations, datasets
- **Archives**: ZIP files containing multiple evaluation assets

## Migration Information

This repository was created by migrating files from Google Drive to ensure better accessibility and reliability. The migration process:

1. **Preserved file integrity**: All files maintain their original content and format
2. **Maintained naming**: Original filenames are preserved where possible
3. **Updated references**: All OSWorld JSON configuration files have been updated to use the new URLs
4. **Added redundancy**: Files are now hosted on HuggingFace's robust infrastructure

## Contributing

If you encounter any issues with file accessibility or notice missing files, please:

1. Check the original OSWorld repository for the latest evaluation configurations
2. Open an issue in the [OSWorld GitHub repository](https://github.com/xlang-ai/OSWorld)
3. Provide specific details about the missing or problematic files

## License

The files in this repository are subject to the same licensing terms as the original OSWorld project. Please refer to the [OSWorld repository](https://github.com/xlang-ai/OSWorld) for detailed licensing information.

## Related Projects

- **[OSWorld](https://github.com/xlang-ai/OSWorld)**: The main OSWorld project repository
- **[OSWorld Paper](https://arxiv.org/abs/2404.07972)**: Research paper describing the OSWorld framework
- **[XLang Lab](https://github.com/xlang-ai)**: Organization behind OSWorld and related research

## Technical Details

- **Storage**: Files are stored using HuggingFace's Git LFS (Large File Storage) system
- **Access**: Public read access, no authentication required
- **Bandwidth**: Leverages HuggingFace's global CDN for fast access worldwide
- **Versioning**: Files are version-controlled using Git, ensuring reproducibility

## Support

For technical support or questions about this file cache:

- **OSWorld Issues**: [GitHub Issues](https://github.com/xlang-ai/OSWorld/issues)
- **HuggingFace Support**: [HuggingFace Community](https://huggingface.co/discussions)
- **Research Inquiries**: Contact the XLang Lab team

---

*This cache repository is maintained as part of the OSWorld project to support reproducible research in multimodal AI agents and computer automation.*

# OSWorld 文件缓存

本仓库作为OSWorld项目的文件缓存库，为此前托管于Google Drive的评测文件提供可靠且快速的访问途径。

## 概述
OSWorld是一款可扩展的真实计算机环境多模态AI智能体（AI Agent）测试平台，支持跨多种操作系统与应用的任务搭建、基于执行的评测以及交互式学习。本缓存仓库可确保所有评测文件在研发与研究场景中均可稳定访问。

## 仓库结构
文件按应用类别组织，与原始OSWorld评测示例的目录结构保持一致：

├── chrome/ # Chrome浏览器评测文件目录
├── firefox/ # Firefox浏览器评测文件目录
├── gimp/ # GIMP图像编辑器评测文件目录
├── libreoffice_calc/ # LibreOffice Calc电子表格评测文件目录
├── libreoffice_impress/ # LibreOffice Impress演示文稿评测文件目录
├── libreoffice_writer/ # LibreOffice Writer文档评测文件目录
├── multi_apps/ # 多应用评测文件目录
├── thunderbird/ # Thunderbird邮件客户端评测文件目录
├── vscode/ # Visual Studio Code编辑器评测文件目录
└── ... # 其他应用类别目录

每个应用文件夹下包含以具体评测场景命名的子文件夹，内含该评测使用的图像、文档、数据集等各类文件。

## 使用方法
### 直接文件访问
文件可通过以下格式的URL直接访问：

https://huggingface.co/datasets/xlangai/ubuntu_osworld_file_cache/resolve/main/{app_name}/{scenario_id}/{filename}

### 与OSWorld集成
本缓存已与OSWorld评测脚本自动集成。原评测JSON文件中的Google Drive链接已迁移至该HuggingFace缓存，可确保：
- **可靠性**：不再出现损坏或无法访问的Google Drive链接
- **性能**：下载速度更快，可用性更优
- **一致性**：文件版本稳定，支持可复现的研究工作

### 编程式访问
您可使用HuggingFace Hub库以编程方式访问文件：
python
from huggingface_hub import hf_hub_download

# 下载指定文件
file_path = hf_hub_download(
repo_id="xlangai/ubuntu_osworld_file_cache",
filename="chrome/scenario_123/test_image.png",
repo_type="dataset"
)

## 文件类型
本缓存包含OSWorld评测中使用的各类文件：
- **图像**：截图、参考图像、图标（PNG、JPG、GIF等格式）
- **文档**：文本文件、PDF、电子表格、演示文稿
- **媒体**：用于多媒体评测的音频与视频文件
- **数据**：CSV文件、JSON配置文件、数据集
- **归档文件**：包含多个评测资源的ZIP压缩包

## 迁移说明
本仓库通过从Google Drive迁移文件创建，以提升可访问性与可靠性。迁移流程如下：
1. **保留文件完整性**：所有文件均保持原始内容与格式
2. **保留命名规则**：尽可能保留原始文件名
3. **更新引用链接**：所有OSWorld JSON配置文件已更新为新的URL
4. **添加冗余存储**：文件现已托管于HuggingFace的健壮基础设施中

## 贡献与反馈
如果您遇到文件访问问题或发现文件缺失，请执行以下操作：
1. 查看原始OSWorld仓库以获取最新的评测配置
2. 在OSWorld GitHub仓库中提交Issue
3. 提供缺失或存在问题的文件的具体信息

## 许可协议
本仓库中的文件遵循与原始OSWorld项目相同的许可条款。详细许可信息请参阅OSWorld仓库。

## 相关项目
- **OSWorld**：OSWorld主项目仓库
- **OSWorld论文**：描述OSWorld框架的研究论文（https://arxiv.org/abs/2404.07972）
- **XLang Lab**：OSWorld及相关研究背后的开源组织

## 技术细节
- **存储方式**：文件通过HuggingFace的Git LFS（大文件存储）系统存储
- **访问权限**：公开可读，无需身份验证
- **带宽保障**：依托HuggingFace的全球CDN实现全球快速访问
- **版本控制**：文件通过Git进行版本管理，确保可复现性

## 支持与咨询
如需技术支持或有关本文件缓存的疑问，请联系：
- **OSWorld问题反馈**：GitHub Issues
- **HuggingFace支持**：HuggingFace社区论坛
- **研究咨询**：联系XLang Lab团队

---

*本缓存仓库作为OSWorld项目的一部分，旨在支持多模态AI智能体（AI Agent）与计算机自动化领域的可复现研究。*