Hugging Face's logo

Trackio documentation

ダッシュボードのデプロイと埋め込み

Hugging Face's logo
Join the Hugging Face community

and get access to the augmented documentation experience

to get started

ダッシュボードのデプロイと埋め込み

Hugging Face Spacesへのデプロイ

init()を呼び出すと、デフォルトではサービスがローカルで実行され、プロジェクトデータがローカルマシンに保存されます。

ただし、init()にspace_idを渡す場合は、次のようになります:

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

または

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

必要に応じて、既存の Hugging Face Space を使用するか、新しい Hugging Face Space を自動的にデプロイします。ローカルでhuggingface-cliにログインしていること、および Space を作成するための書き込み権限を持つトークンを保持している必要があります。

ローカルプロジェクトをSpacesに同期する

ローカルでログを記録しており、後からデータをSpaceにアップロードしたい場合は、syncを使用します。

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

または、CLIから:

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

デフォルトでは、syncはライブサーバー付きのGradio Spaceをデプロイします。サーバーが不要なHF Bucketから読み込む静的なSpaceをデプロイすることもできます:

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 は軽量で無料です — HF Bucket 内の Parquet ファイルをバックエンドとする読み取り専用のダッシュボードを提供します。ダッシュボードは完全にブラウザ内で実行されるため、静的な Trackio Spaces はパブリックのスナップショットデータが必要であり、private=True はサポートされていません。プライベートなダッシュボードには、デフォルトの Gradio Space（sdk="gradio"）を使用してください。

スペースのスナップショットを固定する

ライブのGradio Spaceがあり、プロジェクトのデータの読み取り専用の静的スナップショットを作成したい場合は、freezeを使用します:

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

または、CLIから:

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

これにより、ソースのSpaceのバケットからプロジェクトのデータのスナップショットを含む新しい静的Space（デフォルトでは{space_id}_staticという名前）が作成されます。元のSpaceは変更されません。

freeze()は一度限りのスナップショットであることに注意してください。元のGradio Spaceに新しいメトリクスが後からアップロードされても、凍結された静的Spaceは自動的に更新されません。 ソースのGradio Spaceはプライベートバケットを使用できますが、凍結された静的スナップショットはパブリックデータです。freeze(private=True)はサポートされていません。凍結されたダッシュボードをプライベートに保つ必要がある場合は、Gradio Spaceを使用してください。

保存先をカスタマイズできます:

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

注: freeze()を使用するには、ソースが/dataにバケットがマウントされたGradio Spaceである必要があります。宛先のSpaceが既に存在し、Trackioの静的Spaceでない場合、freeze()は上書きを拒否します。

Trackio ダッシュボードの埋め込み

trackioを作成した理由の一つは、ウェブサイトやブログ記事、あるいはウェブサイトを埋め込めるあらゆる場所にライブダッシュボードを簡単に埋め込めるようにするためです。

image

TrackioのダッシュボードがSpaces上でホストされている場合、<iframe>を使用してどこでも埋め込むことができます:

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

クエリパラメータを使用して、ダッシュボードを特定のプロジェクトやメトリクスに絞り込んで表示することもできます。サポートされているパラメータには、以下が含まれます。

  • project (文字列): 特定のプロジェクトのみを表示します。

  • metrics（カンマ区切りのリスト）: 特定のメトリクスのみを表示します。例: train_loss,train_accuracy。

  • sidebar（文字列、"auto"、"visible"、"collapsed"、または"hidden"）：

    • "auto" はビューポートの幅に基づいてサイドバーを開閉し、デフォルト値です。
    • "visible" は、サイドバーが完全に開いた状態で開始します。
    • "collapsed" は、狭いレールのみで始まります。
    • "hidden" はサイドバーを完全に非表示にします。

    明示的なモードは、ビューポートのリサイズ時に変更されません。

  • footer (string, "false"): "false" に設定すると、Gradio のフッターを非表示にします。デフォルトでは、フッターが表示されます。

  • xmin (number): すべてのメトリクスプロットにおける x 軸の初期最小値を設定します。

  • xmax (number): すべてのメトリクスプロットにおける x 軸の初期最大値を設定します。

  • smoothing (数値): スムージングスライダーの初期値を設定します (0-20、0 = スムージングなし)。

  • plots_per_row (auto または 1 から 6 までの整数): Plots per row コントロールの初期値を設定します。デフォルトは auto で、利用可能な幅にプロットを収めるようにします。

  • accordion (string, "hidden"): "hidden" に設定すると、メトリクスグループのセクションヘッダーのアコーディオンを非表示にします。デフォルトでは、セクションヘッダーが表示されます。

<iframe> は、width、height、style などの標準的な属性を使用してカスタマイズできます。詳細については、MDN Web Docs: <iframe>を参照してください。例:

<iframe 
    src="https://huggingface.co/proxy/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

←Server をセルフホストする プロジェクトの管理→