Triển khai và Nhúng Bảng điều khiển

Triển khai đến Hugging Face Spaces

Khi gọi init(), mặc định dịch vụ sẽ chạy cục bộ và lưu trữ dữ liệu dự án trên máy cục bộ.

Nhưng nếu bạn truyền space_id vào init(), như:

trackio.init(project="my-project", space_id="orgname/space_id")

hoặc

trackio.init(project="my-project", space_id="username/space_id")

nó sẽ sử dụng một Hugging Face Space hiện có hoặc tự động triển khai một Space mới khi cần. Bạn cần đã đăng nhập bằng huggingface-cli trên máy cục bộ và token của bạn phải có quyền ghi để tạo Space.

Đồng bộ hóa các dự án cục bộ với Spaces

Nếu bạn đã ghi log cục bộ và muốn tải dữ liệu lên một Space sau đó, hãy sử dụng sync:

trackio.sync(project="my-project", space_id="username/space_id")

Hoặc từ CLI:

trackio sync --project "my-project" --space-id "username/space_id"

Mặc định, sync triển khai một Gradio Space với một máy chủ trực tiếp. Bạn cũng có thể triển khai một static Space đọc từ một HF Bucket (không cần máy chủ):

trackio.sync(project="my-project", space_id="username/space_id", sdk="static")

trackio sync --project "my-project" --space-id "username/space_id" --sdk static

Static Spaces nhẹ và miễn phí — chúng phục vụ một bảng điều khiển chỉ đọc được hỗ trợ bởi các tệp Parquet trong một HF Bucket. Vì bảng điều khiển chạy hoàn toàn trong trình duyệt, các Trackio Spaces tĩnh yêu cầu dữ liệu snapshot công khai và không hỗ trợ private=True. Hãy sử dụng Space Gradio mặc định (sdk="gradio") cho các bảng điều khiển riêng tư.

Đóng băng một bản chụp Space

Nếu bạn có một Gradio Space đang hoạt động và muốn tạo một bản sao tĩnh chỉ đọc của dữ liệu dự án, hãy sử dụng freeze:

trackio.freeze(space_id="username/my-space", project="my-project")

Hoặc từ CLI:

trackio freeze --space-id "username/my-space" --project "my-project"

Điều này tạo ra một Space tĩnh mới (mặc định có tên là {space_id}_static) chứa một bản sao dữ liệu của dự án từ bucket của Space nguồn. Space gốc không bị thay đổi.

Lưu ý rằngfreeze() là một bản chụp (snapshot) một lần. Nếu các chỉ số mới được tải lên Gradio Space gốc sau đó, Space tĩnh đã đóng băng sẽ không tự động cập nhật. Gradio Space nguồn có thể sử dụng bucket riêng tư, nhưng bản chụp tĩnh đã đóng băng là dữ liệu công khai. freeze(private=True) không được hỗ trợ; hãy sử dụng Gradio Space nếu bảng điều khiển đã đóng băng phải giữ ở chế độ riêng tư.

Bạn có thể tùy chỉnh đích đến:

trackio.freeze(
    space_id="username/my-space",
    project="my-project",
    new_space_id="username/my-snapshot",
)

Lưu ý: freeze() yêu cầu nguồn phải là một Gradio Space có bucket được gắn tại /data. Nếu Space đích đã tồn tại và không phải là Trackio static Space, freeze() sẽ từ chối ghi đè lên nó.

Nhúng Bảng điều khiển Trackio

Một trong những lý do chúng tôi tạo ra trackio là để việc nhúng bảng điều khiển trực tiếp vào các trang web, bài đăng trên blog hoặc bất kỳ nơi nào bạn có thể nhúng một trang web trở nên dễ dàng.

Nếu bảng điều khiển Trackio của bạn được lưu trữ trên Spaces, bạn có thể nhúng nó vào bất kỳ đâu bằng cách sử dụng <iframe>:

<iframe src="https://username-space_id.hf.space"></iframe>

Bạn cũng có thể lọc bảng điều khiển để chỉ hiển thị các dự án hoặc chỉ số cụ thể bằng cách sử dụng các tham số truy vấn. Các tham số được hỗ trợ bao gồm:

project (chuỗi): Chỉ hiển thị một dự án cụ thể.
metrics (danh sách phân tách bằng dấu phẩy): Chỉ hiển thị các chỉ số cụ thể, ví dụ: train_loss,train_accuracy.
sidebar (chuỗi, "auto", "visible", "collapsed", hoặc "hidden"):
- "auto" mở hoặc thu gọn thanh bên dựa trên độ rộng khung nhìn và là mặc định.
- "visible" bắt đầu với thanh bên mở hoàn toàn.
- "collapsed" bắt đầu với chỉ thanh ray hẹp.
- "hidden" ẩn hoàn toàn thanh bên.
Các chế độ hiển thị rõ ràng không bị thay đổi khi khung nhìn được thay đổi kích thước.
footer (string, "false"): Khi được đặt thành "false", sẽ ẩn chân trang của Gradio. Mặc định, chân trang hiển thị.
xmin (number): Đặt giá trị tối thiểu ban đầu cho giới hạn trục x trên tất cả các biểu đồ chỉ số.
xmax (number): Đặt giá trị tối đa ban đầu cho giới hạn trục x trên tất cả các biểu đồ chỉ số.
smoothing (số): Đặt giá trị ban đầu của thanh trượt làm mượt (0-20, trong đó 0 = không làm mượt).
plots_per_row (auto hoặc số nguyên từ 1 đến 6): Đặt giá trị ban đầu của điều khiển Số biểu đồ mỗi hàng. Mặc định là auto, giúp biểu đồ vừa với chiều rộng khả dụng.
accordion (string, "hidden"): Khi được đặt thành "hidden", sẽ ẩn các tiêu đề mục dạng accordion bao quanh các nhóm chỉ số. Mặc định, các tiêu đề mục hiển thị.

Bạn có thể tùy chỉnh <iframe> của mình bằng các thuộc tính tiêu chuẩn như width, height và style. Để biết thêm chi tiết, hãy xem MDN Web Docs: <iframe>. Ví dụ:

<iframe 
    src="https://trackio-documentation.hf.space/?project=my-project&metrics=train_loss,train_accuracy&sidebar=hidden" 
    width="600" 
    height="630" 
    style="border:0;">
</iframe>

Update on GitHub