跳到内容

Hugging Face Spaces 设置

本节详细介绍如何在 Hugging Face Spaces 上配置和部署 Argilla。它涵盖了

  • 持久存储
  • 如何在 Hugging Face 组织下部署 Argilla
  • 如何配置和禁用 HF OAuth 访问
  • 如何使用私有 Space

想要轻松开始或使用 Python SDK 部署 Argilla 吗？

如果您刚发现 Argilla 并想快速入门，请转到快速入门指南。

持久存储

在 Space 创建 UI 中，持久存储设置为 Small PAID，这是一项付费服务，按小时收费。

由于维护、不活动以及每次更改 Space 设置，Spaces 都会重启。持久存储使 Argilla 能够在重启后将您的数据集和配置保存到磁盘。

临时 FREE 持久存储

不将持久存储设置为 Small 意味着 当 Space 重启时，您将丢失数据。

如果您计划将 Argilla Space 用于测试之外的用途，强烈建议将持久存储设置为 Small。

如果您只想快速测试或使用 Argilla 几个小时，并承担丢失数据集的风险，请选择 Ephemeral FREE。Ephemeral FREE 意味着您的数据集和配置将不会保存到磁盘，当 Space 重启时，您的数据集、工作区和用户将丢失。

如果您想禁用持久性存储警告，您可以设置环境变量 ARGILLA_SHOW_HUGGINGFACE_SPACE_PERSISTENT_STORAGE_WARNING=false

如果您有数据集并想启用持久存储，请阅读此内容

如果您想启用持久存储 Small PAID 并且已经创建了数据集、用户或工作区，请按照以下步骤操作

  • 首先，按照导入和导出指南，本地或远程复制您的数据集。这是最重要的步骤，因为更改 Space 的设置会导致重启，从而导致数据丢失。
  • 如果您创建了用户（未使用 Hugging Face 登录），请考虑按照管理用户指南存储用户副本。
  • 安全存储所有数据后，转到 Space 设置选项卡并选择 Small。
  • 您的 Space 将重启，现有数据将丢失。从现在开始，您在 Argilla 中创建的所有新数据都将安全保存
  • 恢复您的数据，按照上述指南操作。

如何配置和禁用 OAuth 访问

默认情况下，Argilla Spaces 配置了 Hugging Face OAuth，方式如下

  • 任何可以看到您的 Space 的 Hugging Face 用户，都可以使用“Sign in”按钮，以 annotator 身份加入，并为 argilla 工作区下的可用数据集做出贡献。此工作区在部署过程中创建。
  • 这些用户只能在 argilla 工作区中浏览和标注数据集，但不能执行任何关键操作，例如创建、删除、更新或配置数据集。默认情况下，您创建的任何其他工作区对这些用户都是不可见的。

要限制访问或更改默认行为，有两种选择

将您的 Space 设置为私有。如果您的 Space 位于组织下，则此功能特别有用。这将仅允许您组织内的成员查看和加入您的 Argilla space。它也可以用于个人、单人项目。

修改 .oauth.yml 配置文件。您可以在 Space 的 Files 选项卡下找到并修改此文件。默认文件如下所示

providers:
  - name: huggingface

# Allowed workspaces must exists
allowed_workspaces:
  - name: argilla
您可以

  • 更改 allowed 工作区列表。
  • 重命名 .oauth.yml 文件以禁用 OAuth 访问。

例如，如果您想让用户加入新的工作区 community-initiative

allowed_workspaces:
  - name: argilla
  - name: community-initiative

如何在 Hugging Face 组织下部署 Argilla

在组织内创建 Argilla Space 对于以下几种情况很有用

  • 您只想允许您的组织成员加入您的 Space。您可以通过将您的 Space 设置为私有来实现这一点。
  • 您想与其他用户一起管理 Space（例如，Space 设置等）。请注意，如果您只想管理您的 Argilla 数据集、工作区，您可以通过向您的 Argilla 服务器添加其他 Argilla owner 角色来实现这一点。
  • 更一般而言，您希望在组织/社区保护伞下提供您的 space.

步骤与快速入门指南非常相似，但有一个重要的区别

启用持久存储 SMALL

不将持久存储设置为 Small 意味着 当 Space 重启时，您将丢失数据。

对于拥有许多用户的 Argilla Space，强烈建议将持久存储设置为 Small。

如何使用私有 Space

如果出现以下情况，将您的 Space 可见性设置为私有可能会很有用

  • 您想处理您的个人、单人项目。
  • 您希望您的 Argilla 仅对您部署 Argilla Space 的组织的成员可用。

您可以在 Space 创建过程中或之后在 Settings 选项卡下设置 Space 的可见性。

要将 Python SDK 与私有 Space 一起使用，您需要在创建客户端时指定您的 HF_TOKEN，该令牌可以在这里找到

import argilla as rg

HF_TOKEN = "..."

client = rg.Argilla(
    api_url="<api_url>",
    api_key="<api_key>",
    headers={"Authorization": f"Bearer {HF_TOKEN}"}
)

Space 密钥概述

有两个可选密钥可以设置 Argilla Space owner 的 USERNAME 和 PASSWORD。请记住，默认情况下，Argilla Spaces 配置了使用 Hugging Face 登录按钮，该按钮也用于为个人 space 的创建者授予 owner 角色。

USERNAME 和 PASSWORD 仅在以下几种情况下有用

总之，在设置 Space 时

在您的个人帐户下创建 Space

如果您在您的个人帐户下创建 Space，请勿为 USERNAME 和 PASSWORD 插入任何值。启动 Space 后，您将能够使用您的 Hugging Face 用户名和 owner 角色登录。

在组织下创建 Space

如果您在组织下创建 Space，请务必在密钥 USERNAME 中插入您的 Hugging Face 用户名。这样，您将能够使用您的 Hugging Face 用户登录。