Trackio documentation

Khởi chạy Bảng điều khiển

Hugging Face's logo
Join the Hugging Face community

and get access to the augmented documentation experience

to get started

Khởi chạy Bảng điều khiển

Khởi chạy Bảng điều khiển cục bộ

Bạn có thể khởi chạy bảng điều khiển bằng cách chạy:

Shell
Python
trackio show

Tải một Dự án Cụ thể

Bạn cũng có thể cung cấp tên project tùy chọn làm đối số để tải trực tiếp một dự án cụ thể:

Shell
Python
trackio show --project "my-project"

Sử dụng Frontend tùy chỉnh

Bạn có thể thay thế bảng điều khiển có sẵn bằng thư mục frontend tĩnh của riêng mình. Thư mục chỉ cần có tệp index.html; frontend của bạn có thể gọi API Trackio hiện có dưới /api/*.

Quy trình làm việc dự kiến là:

  1. Chạy trackio show --frontend ./my-trackio-frontend.
  2. Yêu cầu LLM của bạn chỉnh sửa các tệp trong thư mục đó.
  3. Giữ trình duyệt mở trong khi Trackio tự động tải lại giao diện phía trước khi các tệp đó thay đổi.

Nếu thư mục được truyền vào --frontend không tồn tại, hoặc tồn tại nhưng trống, Trackio sẽ tự động sao chép frontend khởi đầu vào, in ra thông báo xác nhận việc này, sau đó phục vụ thư mục đó. Bản khởi đầu là một mẫu HTML/CSS/JS thuần túy hoàn chỉnh: nó gọi API của Trackio, tải các dự án và lượt chạy, lấy giá trị các chỉ số, và vẽ các biểu đồ đơn giản mà bạn có thể thay thế bằng giao diện người dùng của riêng mình.

Các điểm cuối HTTP hiện có là:

  • POST /api/get_run_mutation_status
  • POST /api/upload_db_to_space
  • POST /api/bulk_upload_media
  • POST /api/log
  • POST /api/bulk_log
  • POST /api/bulk_log_system
  • POST /api/bulk_alert
  • POST /api/get_alerts
  • POST /api/get_metric_values
  • POST /api/get_runs_for_project
  • POST /api/get_metrics_for_run
  • POST /api/get_all_projects
  • POST /api/get_project_summary
  • POST /api/get_run_summary
  • POST /api/get_system_metrics_for_run
  • POST /api/get_system_logs
  • POST /api/get_system_logs_batch
  • POST /api/get_snapshot
  • POST /api/get_logs
  • POST /api/get_logs_batch
  • POST /api/get_traces
  • POST /api/query_project
  • POST /api/get_settings
  • POST /api/get_project_files
  • POST /api/delete_run
  • POST /api/rename_run
  • POST /api/force_sync
  • POST /api/upload cho việc tải lên tệp multipart được sử dụng bởi các luồng liên quan đến phương tiện và tệp

Để đọc các tệp đã lưu được trả về bởi API, Trackio cũng cung cấp GET /file?path=....

Shell
Python
trackio show --frontend ./my-trackio-frontend

Nếu thư mục frontend được cung cấp không rỗng nhưng không hợp lệ, Trackio sẽ quay lại sử dụng mẫu khởi đầu được đóng gói sẵn.

Đặt Frontend Mặc Định Bền Vững

Nếu bạn muốn cùng một frontend tùy chỉnh được sử dụng mặc định bởi trackio show, trackio sync và các luồng triển khai, hãy lưu nó trong cấu hình bền vững của Trackio:

trackio config set frontend ./my-trackio-frontend

Đặt lại bằng cách:

trackio config unset frontend

Tùy chỉnh màu sắc biểu đồ

Bạn có thể tùy chỉnh bảng màu được sử dụng cho các đường biểu đồ bằng cách cung cấp đối số color_palette. Điều này hữu ích nếu bạn muốn phù hợp với thương hiệu của tổ chức hoặc có sở thích màu sắc cụ thể.

Shell
Python
trackio show --color-palette "#FF0000,#00FF00,#0000FF"

Các màu sẽ được luân phiên sử dụng khi hiển thị nhiều lần chạy. Bạn có thể cung cấp nhiều hoặc ít màu tùy thích.

Bật truy cập từ xa

Mặc định, dashboard được gắn với 127.0.0.1 (localhost), nghĩa là nó chỉ có thể được truy cập từ cùng một máy. Để cho phép truy cập từ xa từ các máy khác trên mạng, hãy sử dụng tùy chọn --host:

Shell
Python
trackio show --host 0.0.0.0

Điều này đặc biệt hữu ích khi chạy Trackio trên một máy chủ từ xa hoặc trong môi trường container hóa, nơi bạn cần truy cập dashboard từ một máy khác.

Khởi chạy Bảng điều khiển trong Jupyter Notebooks

Bạn cũng có thể khởi chạy bảng điều khiển trực tiếp trong Jupyter Notebook. Chỉ cần sử dụng cùng lệnh như ở trên:

import trackio

trackio.show()

Xem notebook demo.

Update on GitHub