Trackio documentation

ダッシュボードの起動

Hugging Face's logo
Join the Hugging Face community

and get access to the augmented documentation experience

to get started

ダッシュボードの起動

ローカルダッシュボードの起動

以下を実行してダッシュボードを起動できます:

シェル
Python
trackio show

特定のプロジェクトの読み込み

オプションのproject名を引数として指定することで、特定のプロジェクトを直接読み込むこともできます:

シェル
Python
trackio show --project "my-project"

カスタムフロントエンドの使用

バンドルされたダッシュボードを、独自の静的フロントエンドディレクトリに置き換えることができます。ディレクトリにはindex.htmlファイルのみが必要です。フロントエンドから/api/*配下の既存のTrackio APIを呼び出すことができます。

意図されたワークフローは以下の通りです:

  1. trackio show --frontend ./my-trackio-frontendを実行します。
  2. そのディレクトリ内のファイルを編集するように、LLMに指示してください。
  3. これらのファイルが変更されると、Trackioがフロントエンドをライブリロードするため、ブラウザを開いたままにしてください。

--frontend に渡されたディレクトリが存在しない場合、または存在するが空の場合、Trackio は自動的にスターターフロントエンドをコピーし、その旨を出力してから、そのディレクトリを配信します。スターターは完全なプレーンな HTML/CSS/JS テンプレートです。Trackio API を呼び出し、プロジェクトとランを読み込み、メトリックの値を取得し、独自の UI に置き換え可能なシンプルなチャートを描画します。

現在利用可能なHTTPエンドポイントは以下の通りです:

  • 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

APIから返される保存済みファイルの読み取りには、TrackioはGET /file?path=...も提供しています。

シェル
Python
trackio show --frontend ./my-trackio-frontend

提供されたフロントエンドディレクトリが空でなく無効な場合、Trackioは同梱されているスターターテンプレートにフォールバックします。

永続的なデフォルトフロントエンドの設定

trackio show、trackio sync、およびデプロイフローで、デフォルトとして同じカスタムフロントエンドを使用するようにするには、Trackioの永続設定に保存してください。

trackio config set frontend ./my-trackio-frontend

以下でリセットします:

trackio config unset frontend

プロット色のカスタマイズ

プロットラインに使用されるカラーパレットは、color_palette引数を指定することでカスタマイズできます。組織のブランディングに合わせる場合や、特定のカラー設定がある場合に便利です。

シェル
Python
trackio show --color-palette "#FF0000,#00FF00,#0000FF"

複数のランを表示する際、色はサイクルで切り替わります。色は任意の数を指定できます。

リモートアクセスの有効化

デフォルトでは、ダッシュボードは127.0.0.1(localhost)にバインドされるため、同じマシンからのみアクセスできます。ネットワーク上の他のマシンからのリモートアクセスを許可するには、--hostオプションを使用します:

シェル
Python
trackio show --host 0.0.0.0

これは、リモートサーバー上でTrackioを実行する場合や、別のマシンからダッシュボードにアクセスする必要があるコンテナ化環境で特に役立ちます。

Jupyter Notebookでダッシュボードを起動する

Jupyter Notebook内でダッシュボードを直接起動することもできます。上記と同じコマンドを使用してください:

import trackio

trackio.show()

デモノートブックを確認してください。

Update on GitHub