数据集查看器

数据集页面包含一个表格，展示了数据集的内容，每页显示100行。您可以通过表格底部的按钮在不同页面之间切换，还可以进行筛选、搜索、查看基本统计信息等操作。

该仓库是后端服务，通过 API 为 Hub 上的所有数据集提供预计算的数据，从而支持数据集查看器的功能。而前端的查看器组件并不属于此仓库，且与 Hub 的其他部分一样，并未开源。

文档：

• 数据集查看器：https://huggingface.co/docs/hub/datasets-viewer
• 数据集配置：https://huggingface.co/docs/hub/datasets-data-files-configuration
• 后端 API：https://huggingface.co/docs/dataset-viewer

您发现了 bug 🪲 或希望新增功能 🎁

如果数据集查看器在您的数据集页面上显示错误，请在该页面上 开启讨论，这是解决问题的最高效方式。请在讨论中标记 @lhoestq、@asoria 或 @albertvillanova，以便直接联系相关团队。

如果您发现较为严重的错误，认为数据集查看器存在 bug，或者希望请求新增功能，请在此处 提交新 issue。

贡献 🤝

您可以通过提出想法、解答问题、报告 bug、建议改进、完善文档以及修复 bug 等方式来帮助我们。更多详情请参阅 CONTRIBUTING.md。

如需安装此后端并开始参与代码贡献，请参阅 DEVELOPER_GUIDE.md。

社区 🤗

您可以给这个 GitHub 仓库 加星标并关注，以及时获取更新信息。

您也可以在 论坛 和 Discord 上寻求帮助或解答疑问。

此外，您还可以在 GitHub issues 中报告 bug 或对代码及文档提出改进建议。

Dataset Viewer 快速上手指南

环境准备

在开始之前，请确保您的开发环境满足以下要求：

• 操作系统：Linux (推荐 Ubuntu 20.04+) 或 macOS。Windows 用户建议使用 WSL2。
• Python：版本 3.9 或更高。
• 包管理器：推荐使用 pip 或 conda。
• 依赖项：需要安装 Hugging Face datasets 库及相关数据处理依赖。

注意：本项目主要作为 Hugging Face Hub 的后端服务运行。普通用户通常直接使用 Hub 网页版查看器；本指南面向希望本地部署后端或贡献代码的开发者。

安装步骤

1. 克隆仓库

首先从 GitHub 克隆项目源码：

git clone https://github.com/huggingface/dataset-viewer.git
cd dataset-viewer

2. 创建虚拟环境

建议创建独立的 Python 虚拟环境以避免依赖冲突：

python -m venv venv
source venv/bin/activate  # Windows 用户使用: venv\Scripts\activate

3. 安装依赖

根据官方开发者指南，安装必要的开发依赖。若需加速下载，可临时指定国内镜像源（如清华源）：

# 使用国内镜像源加速安装 (可选)
pip install -r requirements.txt -i https://pypi.tuna.tsinghua.edu.cn/simple

# 或者安装为可编辑模式以便开发
pip install -e . -i https://pypi.tuna.tsinghua.edu.cn/simple

注：具体的依赖文件列表请参考仓库根目录下的 requirements.txt 或遵循 DEVELOPER_GUIDE.md 中的详细指令。

基本使用

Dataset Viewer 的核心功能是通过 API 提供预计算的数据集内容。以下是启动本地后端服务的最简示例：

启动后端服务

在项目根目录下，使用以下命令启动 API 服务（默认端口通常为 8000 或配置文件中指定的端口）：

uvicorn app.main:app --reload --host 0.0.0.0 --port 8000

验证服务

服务启动后，您可以通过浏览器或 curl 访问本地接口来测试数据集查看功能。例如，获取某个数据集的行数据：

curl "http://localhost:8000/rows?dataset=AI-MO/NuminaMath-CoT&config=default&split=train&offset=0&length=100"

配置数据集

若要自定义数据集的文件配置，请参考 Hugging Face 官方文档进行 data_files 配置： https://huggingface.co/docs/hub/datasets-data-files-configuration

---

更多详细的开发贡献指南请参阅项目中的 DEVELOPER_GUIDE.md 文件。